Supply Chain · Freight Management
Carriers
Who moves it. A carrier IS a supplier as far as payables is concerned, so a freight invoice posts against the supplier record rather than into a second ledger.
/api/scm/carriersPublished as /api/v1/carriersOverview
| 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 › Carriers 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.carriers · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/carriersList carriers
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",
"carrier_no": "CAR-000001",
"name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_type": "text",
"scac": "text",
"mc_number": "MC-000001",
"dot_number": "DOT-000001",
"iata_code": "IAT-000001",
"vat_number": "VAT-000001",
"integration_code": "INT-000001",
"currency": "USD",
"payment_terms_days": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/carriers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/carriers/{id}Read one carriers
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",
"carrier_no": "CAR-000001",
"name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_type": "text",
"scac": "text",
"mc_number": "MC-000001",
"dot_number": "DOT-000001",
"iata_code": "IAT-000001",
"vat_number": "VAT-000001",
"integration_code": "INT-000001",
"currency": "USD",
"payment_terms_days": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carriersCreate a carriers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
carrier_no | text | No | Carrier number |
name | text | Yes | Name |
supplier_id | uuid | No | Bills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled. |
carrier_type | text | No | Type |
scac | text | No | SCAC — The standard carrier alpha code. |
mc_number | text | No | MC number |
dot_number | text | No | DOT number |
iata_code | text | No | IATA code |
vat_number | text | No | VAT number |
integration_code | text | No | Integration |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) |
fuel_surcharge_pct | numeric | No | Fuel surcharge % |
accessorial_policy | text | No | Accessorial policy |
contract_id | uuid | No | Contract |
insurance_expires_on | date | No | Insurance expires |
liability_limit | numeric | No | Liability limit |
is_hazmat_certified | boolean | No | Certified for dangerous goods |
is_customs_bonded | boolean | No | Customs bonded |
tracking_url_template | text | No | Tracking URL — Put {tracking_no} where the number goes. |
contact_name | text | No | Contact |
contact_email | text | No | |
contact_phone | text | No | Telephone |
status | text | No | Status Allowed: prospect active suspended expired terminated |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"carrier_no": "CAR-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_type": "text",
"scac": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_no": "CAR-000001",
"name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_type": "text",
"scac": "text",
"mc_number": "MC-000001",
"dot_number": "DOT-000001",
"iata_code": "IAT-000001",
"vat_number": "VAT-000001",
"integration_code": "INT-000001",
"currency": "USD",
"payment_terms_days": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/carriers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","carrier_no":"CAR-000001","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_type":"text","scac":"text"}'PUT/api/scm/carriers/{id}Change a carriers
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 |
|---|---|---|---|
carrier_no | text | No | Carrier number |
name | text | Yes | Name |
supplier_id | uuid | No | Bills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled. |
carrier_type | text | No | Type |
scac | text | No | SCAC — The standard carrier alpha code. |
mc_number | text | No | MC number |
dot_number | text | No | DOT number |
iata_code | text | No | IATA code |
vat_number | text | No | VAT number |
integration_code | text | No | Integration |
currency | text | No | Currency |
payment_terms_days | integer | No | Payment terms (days) |
fuel_surcharge_pct | numeric | No | Fuel surcharge % |
accessorial_policy | text | No | Accessorial policy |
contract_id | uuid | No | Contract |
insurance_expires_on | date | No | Insurance expires |
liability_limit | numeric | No | Liability limit |
is_hazmat_certified | boolean | No | Certified for dangerous goods |
is_customs_bonded | boolean | No | Customs bonded |
tracking_url_template | text | No | Tracking URL — Put {tracking_no} where the number goes. |
contact_name | text | No | Contact |
contact_email | text | No | |
contact_phone | text | No | Telephone |
status | text | No | Status Allowed: prospect active suspended expired terminated |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"carrier_no": "CAR-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_no": "CAR-000001",
"name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_type": "text",
"scac": "text",
"mc_number": "MC-000001",
"dot_number": "DOT-000001",
"iata_code": "IAT-000001",
"vat_number": "VAT-000001",
"integration_code": "INT-000001",
"currency": "USD",
"payment_terms_days": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","carrier_no":"CAR-000001"}'DELETE/api/scm/carriers/{id}Delete a carriers
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/carriers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carriers/{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/carriers/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 carriers, 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 |
carrier_no | text | read, write | Carrier number |
name | text | read, write | Name |
supplier_id | uuid | read, write | Bills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled. |
carrier_type | text | read, write | Type |
scac | text | read, write | SCAC — The standard carrier alpha code. |
mc_number | text | read, write | MC number |
dot_number | text | read, write | DOT number |
iata_code | text | read, write | IATA code |
vat_number | text | read, write | VAT number |
integration_code | text | read, write | Integration |
currency | text | read, write | Currency |
payment_terms_days | integer | read, write | Payment terms (days) |
fuel_surcharge_pct | numeric | read, write | Fuel surcharge % |
accessorial_policy | text | read, write | Accessorial policy |
contract_id | uuid | read, write | Contract |
on_time_pct | numeric | read only | On time pct |
damage_rate_pct | numeric | read only | Damage rate pct |
invoice_accuracy_pct | numeric | read only | Invoice accuracy pct |
performance_score | numeric | read only | Performance score |
insurance_expires_on | date | read, write | Insurance expires |
liability_limit | numeric | read, write | Liability limit |
is_hazmat_certified | boolean | read, write | Certified for dangerous goods |
is_customs_bonded | boolean | read, write | Customs bonded |
tracking_url_template | text | read, write | Tracking URL — Put {tracking_no} where the number goes. |
contact_name | text | read, write | Contact |
contact_email | text | read, write | |
contact_phone | text | read, write | Telephone |
status | text | read, write | Status Allowed: prospect active suspended expired terminated |
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 › Carriers 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.