Supply Chain · Freight Management
Carrier Services
What a carrier sells. "UPS" is not a service; "UPS 2nd Day Air" is, and it is the thing that has a transit time and a cutoff.
/api/scm/carrier-servicesPublished as /api/v1/carrier-servicesDownload specification (OpenAPI 3.1) Screen: Carrier Services
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 Services 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_services · 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/carrier-servicesList carrier services
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",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_code": "SER-000001",
"mode": "text",
"service_level": "text",
"transit_days": "1250.00",
"guaranteed": true,
"cutoff_time": "text",
"max_weight_kg": "1250.00",
"max_length_mm": "1250.00",
"max_girth_mm": "1250.00",
"allows_hazmat": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/carrier-services?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/carrier-services/{id}Read one carrier service
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",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_code": "SER-000001",
"mode": "text",
"service_level": "text",
"transit_days": "1250.00",
"guaranteed": true,
"cutoff_time": "text",
"max_weight_kg": "1250.00",
"max_length_mm": "1250.00",
"max_girth_mm": "1250.00",
"allows_hazmat": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/carrier-services/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carrier-servicesCreate a carrier service
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
carrier_id | uuid | Yes | Carrier |
code | text | Yes | Code |
name | text | Yes | Name |
service_code | text | No | Code at the carrier — What their own API calls it. |
mode | text | No | Mode |
service_level | text | No | Service level |
transit_days | numeric | No | Transit days |
guaranteed | boolean | No | Guaranteed |
cutoff_time | time without time zone | No | Cutoff |
max_weight_kg | numeric | No | Maximum weight (kg) |
max_length_mm | numeric | No | Maximum length (mm) |
max_girth_mm | numeric | No | Maximum girth (mm) |
allows_hazmat | boolean | No | Takes dangerous goods |
allows_signature | boolean | No | Signature available |
allows_saturday | boolean | No | Saturday delivery |
is_active | boolean | No | Active |
Sample body
{
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_code": "SER-000001",
"mode": "text",
"service_level": "text",
"transit_days": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_code": "SER-000001",
"mode": "text",
"service_level": "text",
"transit_days": "1250.00",
"guaranteed": true,
"cutoff_time": "text",
"max_weight_kg": "1250.00",
"max_length_mm": "1250.00",
"max_girth_mm": "1250.00",
"allows_hazmat": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/carrier-services" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","service_code":"SER-000001","mode":"text","service_level":"text","transit_days":"1250.00"}'PUT/api/scm/carrier-services/{id}Change a carrier service
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_id | uuid | Yes | Carrier |
code | text | Yes | Code |
name | text | Yes | Name |
service_code | text | No | Code at the carrier — What their own API calls it. |
mode | text | No | Mode |
service_level | text | No | Service level |
transit_days | numeric | No | Transit days |
guaranteed | boolean | No | Guaranteed |
cutoff_time | time without time zone | No | Cutoff |
max_weight_kg | numeric | No | Maximum weight (kg) |
max_length_mm | numeric | No | Maximum length (mm) |
max_girth_mm | numeric | No | Maximum girth (mm) |
allows_hazmat | boolean | No | Takes dangerous goods |
allows_signature | boolean | No | Signature available |
allows_saturday | boolean | No | Saturday delivery |
is_active | boolean | No | Active |
Sample body
{
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_code": "SER-000001",
"mode": "text",
"service_level": "text",
"transit_days": "1250.00",
"guaranteed": true,
"cutoff_time": "text",
"max_weight_kg": "1250.00",
"max_length_mm": "1250.00",
"max_girth_mm": "1250.00",
"allows_hazmat": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/carrier-services/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001"}'DELETE/api/scm/carrier-services/{id}Delete a carrier service
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-services/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/carrier-services/{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-services/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 carrier service, 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 |
carrier_id | uuid | read, write | Carrier |
code | text | read, write | Code |
name | text | read, write | Name |
service_code | text | read, write | Code at the carrier — What their own API calls it. |
mode | text | read, write | Mode |
service_level | text | read, write | Service level |
transit_days | numeric | read, write | Transit days |
guaranteed | boolean | read, write | Guaranteed |
cutoff_time | time without time zone | read, write | Cutoff |
max_weight_kg | numeric | read, write | Maximum weight (kg) |
max_length_mm | numeric | read, write | Maximum length (mm) |
max_girth_mm | numeric | read, write | Maximum girth (mm) |
allows_hazmat | boolean | read, write | Takes dangerous goods |
allows_signature | boolean | read, write | Signature available |
allows_saturday | boolean | read, write | Saturday delivery |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit 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 |
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 Services 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.