Supply Chain · Supplier Portal
Supplier Portal Users
People at your suppliers and carriers who sign in to the supplier portal: invited by email, held to their own records, with a second step where you require one. People at customers are invited from CRM.
/api/scm/portal-usersPublished as /api/v1/portal-usersDownload specification (OpenAPI 3.1) Screen: Supplier Portal Users
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Supplier Portal Users on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | core.portal_users · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/portal-usersList supplier portal users
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "supplier",
"party_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"full_name": "Example",
"phone": "+1 555 0100",
"job_title": "Example",
"status": "draft",
"password_hash": "text",
"invite_token_hash": "text",
"invite_expires_at": "2026-10-30T09:00:00Z",
"invited_at": "2026-10-30T09:00:00Z",
"invited_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/portal-users?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/portal-users/{id}Read one portal user
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "supplier",
"party_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"full_name": "Example",
"phone": "+1 555 0100",
"job_title": "Example",
"status": "draft",
"password_hash": "text",
"invite_token_hash": "text",
"invite_expires_at": "2026-10-30T09:00:00Z",
"invited_at": "2026-10-30T09:00:00Z",
"invited_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-usersCreate a portal user
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
full_name | text | Yes | Name |
phone | text | No | Phone |
job_title | text | No | Job title |
scopes | _text | No | May use — Tick what this person may see and do. Nothing ticked: everything the portal offers. Allowed: Orders Shipping notices Invoices Enquiries Payments Our details Dock bookings Cases |
mfa_required | boolean | No | Require a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway. |
notes | text | No | Notes |
Sample body
{
"full_name": "Example",
"phone": "+1 555 0100",
"job_title": "Example",
"scopes": "Orders",
"mfa_required": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "supplier",
"party_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"full_name": "Example",
"phone": "+1 555 0100",
"job_title": "Example",
"status": "draft",
"password_hash": "text",
"invite_token_hash": "text",
"invite_expires_at": "2026-10-30T09:00:00Z",
"invited_at": "2026-10-30T09:00:00Z",
"invited_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"full_name":"Example","phone":"+1 555 0100","job_title":"Example","scopes":"Orders","mfa_required":true}'PUT/api/scm/portal-users/{id}Change a portal user
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
full_name | text | Yes | Name |
phone | text | No | Phone |
job_title | text | No | Job title |
scopes | _text | No | May use — Tick what this person may see and do. Nothing ticked: everything the portal offers. Allowed: Orders Shipping notices Invoices Enquiries Payments Our details Dock bookings Cases |
mfa_required | boolean | No | Require a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway. |
notes | text | No | Notes |
Sample body
{
"full_name": "Example",
"phone": "+1 555 0100"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"kind": "supplier",
"party_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"full_name": "Example",
"phone": "+1 555 0100",
"job_title": "Example",
"status": "draft",
"password_hash": "text",
"invite_token_hash": "text",
"invite_expires_at": "2026-10-30T09:00:00Z",
"invited_at": "2026-10-30T09:00:00Z",
"invited_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"full_name":"Example","phone":"+1 555 0100"}'DELETE/api/scm/portal-users/{id}Delete a portal user
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-users/{id}/reinviteReinvite
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reinvite" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-users/{id}/disableDisable
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disable" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-users/{id}/enableEnable
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/enable" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-users/{id}/reset-mfaReset mfa
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reset-mfa" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/portal-users/{id}/activityActivity
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activity" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/portal-users/attachments/{id}Attachments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/portal-users/attachments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/portal-users/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a portal user, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
kind | text | read only | Works for a Allowed: supplier carrier |
party_id | uuid | read only | Supplier |
email | text | read only | Email — The invitation goes here. The link works for seven days. |
full_name | text | read, write | Name |
phone | text | read, write | Phone |
job_title | text | read, write | Job title |
status | text | read only | Status |
password_hash | text | read only | Password hash |
invite_token_hash | text | read only | Invite token hash |
invite_expires_at | timestamp with time zone | read only | Invite expires at |
invited_at | timestamp with time zone | read only | Invited at |
invited_by | uuid | read only | Invited by |
activated_at | timestamp with time zone | read only | Activated at |
scopes | _text | read, write | May use — Tick what this person may see and do. Nothing ticked: everything the portal offers. Allowed: Orders Shipping notices Invoices Enquiries Payments Our details Dock bookings Cases |
mfa_required | boolean | read, write | Require a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway. |
totp_secret | text | read only | Totp secret |
pending_secret | text | read only | Pending secret |
pending_at | timestamp with time zone | read only | Pending at |
mfa_enrolled_at | timestamp with time zone | read only | Mfa enrolled at |
last_step | bigint | read only | Last step |
recovery_hashes | _text | read only | Recovery hashes |
failed_attempts | integer | read only | Failed attempts |
locked_until | timestamp with time zone | read only | Locked until |
last_login_at | timestamp with time zone | read only | Last login at |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
contact_id | uuid | read only | Contact id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Supplier Portal Users for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.