TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/scm/portal-usersPublished as /api/v1/portal-users

Download specification (OpenAPI 3.1) Screen: Supplier Portal Users

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecore.portal_users · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
full_nametextYesName
phonetextNoPhone
job_titletextNoJob title
scopes_textNoMay 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_requiredbooleanNoRequire a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway.
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
full_nametextYesName
phonetextNoPhone
job_titletextNoJob title
scopes_textNoMay 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_requiredbooleanNoRequire a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway.
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
kindtextread onlyWorks for a
Allowed: supplier carrier
party_iduuidread onlySupplier
emailtextread onlyEmail — The invitation goes here. The link works for seven days.
full_nametextread, writeName
phonetextread, writePhone
job_titletextread, writeJob title
statustextread onlyStatus
password_hashtextread onlyPassword hash
invite_token_hashtextread onlyInvite token hash
invite_expires_attimestamp with time zoneread onlyInvite expires at
invited_attimestamp with time zoneread onlyInvited at
invited_byuuidread onlyInvited by
activated_attimestamp with time zoneread onlyActivated at
scopes_textread, writeMay 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_requiredbooleanread, writeRequire a second step — An authenticator code at every sign-in. Cloud deployments require it of everybody anyway.
totp_secrettextread onlyTotp secret
pending_secrettextread onlyPending secret
pending_attimestamp with time zoneread onlyPending at
mfa_enrolled_attimestamp with time zoneread onlyMfa enrolled at
last_stepbigintread onlyLast step
recovery_hashes_textread onlyRecovery hashes
failed_attemptsintegerread onlyFailed attempts
locked_untiltimestamp with time zoneread onlyLocked until
last_login_attimestamp with time zoneread onlyLast login at
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
contact_iduuidread onlyContact id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Supplier Portal Users for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.