Supply Chain · Third-Party Logistics
Carrier Accounts
One set of credentials with one provider. Sealed the way every other connector in the product seals them, and never sent back to the browser.
/api/scm/carrier-accountsPublished as /api/v1/carrier-accountsDownload specification (OpenAPI 3.1) Screen: Carrier Accounts
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 › Carrier Accounts 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 | scm.carrier_accounts · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/carrier-accountsList carrier accounts
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",
"code": "COD-000001",
"name": "Example",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_number": "ACC-000001",
"meter_number": "MET-000001",
"shipper_number": "SHI-000001",
"site_id": "text",
"api_key_cipher": "text",
"api_secret_cipher": "text",
"username": "Example",
"password_cipher": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/carrier-accounts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/carrier-accounts/{id}Read one carrier account
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",
"code": "COD-000001",
"name": "Example",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_number": "ACC-000001",
"meter_number": "MET-000001",
"shipper_number": "SHI-000001",
"site_id": "text",
"api_key_cipher": "text",
"api_secret_cipher": "text",
"username": "Example",
"password_cipher": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carrier-accountsCreate a carrier account
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
provider_id | uuid | No | Provider |
carrier_id | uuid | No | Carrier |
account_number | text | No | Account number |
meter_number | text | No | Meter number — FedEx. |
shipper_number | text | No | Shipper number — UPS. |
site_id | text | No | Site id — DHL. |
username | text | No | Username |
environment | text | No | Environment — Labels bought in a sandbox are not real. Switch to production before shipping anything. Allowed: sandbox production |
ship_from_place_id | uuid | No | Ships from |
default_label_format | text | No | Label format |
default_service_id | uuid | No | Default service |
negotiated_rates | boolean | No | Use negotiated rates |
is_default | boolean | No | Default account |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_number": "ACC-000001",
"meter_number": "MET-000001"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_number": "ACC-000001",
"meter_number": "MET-000001",
"shipper_number": "SHI-000001",
"site_id": "text",
"api_key_cipher": "text",
"api_secret_cipher": "text",
"username": "Example",
"password_cipher": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/carrier-accounts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_number":"ACC-000001","meter_number":"MET-000001"}'PUT/api/scm/carrier-accounts/{id}Change a carrier account
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
provider_id | uuid | No | Provider |
carrier_id | uuid | No | Carrier |
account_number | text | No | Account number |
meter_number | text | No | Meter number — FedEx. |
shipper_number | text | No | Shipper number — UPS. |
site_id | text | No | Site id — DHL. |
username | text | No | Username |
environment | text | No | Environment — Labels bought in a sandbox are not real. Switch to production before shipping anything. Allowed: sandbox production |
ship_from_place_id | uuid | No | Ships from |
default_label_format | text | No | Label format |
default_service_id | uuid | No | Default service |
negotiated_rates | boolean | No | Use negotiated rates |
is_default | boolean | No | Default account |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_number": "ACC-000001",
"meter_number": "MET-000001",
"shipper_number": "SHI-000001",
"site_id": "text",
"api_key_cipher": "text",
"api_secret_cipher": "text",
"username": "Example",
"password_cipher": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/carrier-accounts/{id}Delete a carrier account
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/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carrier-accounts/{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/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/scm/carrier-accounts/{id}/credentialsCredentials
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 PUT "https://demo.tranxact.ai/api/scm/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credentials" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carrier-accounts/{id}/checkCheck
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/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a carrier account, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
provider_id | uuid | read, write | Provider |
carrier_id | uuid | read, write | Carrier |
account_number | text | read, write | Account number |
meter_number | text | read, write | Meter number — FedEx. |
shipper_number | text | read, write | Shipper number — UPS. |
site_id | text | read, write | Site id — DHL. |
api_key_cipher | bytea | read only | Api key cipher |
api_secret_cipher | bytea | read only | Api secret cipher |
username | text | read, write | Username |
password_cipher | bytea | read only | Password cipher |
access_token_cipher | bytea | read only | Access token cipher |
token_expires_at | timestamp with time zone | read only | Token expires at |
environment | text | read, write | Environment — Labels bought in a sandbox are not real. Switch to production before shipping anything. Allowed: sandbox production |
ship_from_place_id | uuid | read, write | Ships from |
default_label_format | text | read, write | Label format |
default_service_id | uuid | read, write | Default service |
negotiated_rates | boolean | read, write | Use negotiated rates |
webhook_secret_cipher | bytea | read only | Webhook secret cipher |
last_ok_at | timestamp with time zone | read only | Last ok at |
last_error_at | timestamp with time zone | read only | Last error at |
last_error | text | read only | Last error |
calls_today | integer | read only | Calls today |
is_default | boolean | read, write | Default account |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Carrier Accounts 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.