Supply Chain · Freight Management
Rate Shopping
What came back when several carriers were asked. Kept rather than thrown away: "why did we ship this on the expensive one" is a question somebody asks three weeks later.
/api/scm/rate-quotesPublished as /api/v1/rate-quotesOverview
| 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 › Rate Shopping 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.rate_quotes · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/rate-quotesList rate shopping
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",
"quote_no": "QUO-000001",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requested_at": "2026-10-30T09:00:00Z",
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"origin_postal": "text",
"destination_postal": "text",
"weight_kg": "1250.00",
"volume_l": "1250.00",
"piece_count": 10,
"service_level": "text",
"selected_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/rate-quotes?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/rate-quotes/{id}Read one rate quote
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",
"quote_no": "QUO-000001",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requested_at": "2026-10-30T09:00:00Z",
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"origin_postal": "text",
"destination_postal": "text",
"weight_kg": "1250.00",
"volume_l": "1250.00",
"piece_count": 10,
"service_level": "text",
"selected_option_id": "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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rate-quotesCreate a rate quote
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
freight_order_id | uuid | No | Freight order id |
load_id | uuid | No | Load id |
origin_postal | text | No | From postal code |
destination_postal | text | No | To postal code |
weight_kg | numeric | No | Weight (kg) |
volume_l | numeric | No | Volume (L) |
piece_count | integer | No | Pieces |
service_level | text | No | Service level |
selection_reason | text | No | Why this one |
status | text | No | Status Allowed: open quoted selected expired failed cancelled |
Sample body
{
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"origin_postal": "text",
"destination_postal": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quote_no": "QUO-000001",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requested_at": "2026-10-30T09:00:00Z",
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"origin_postal": "text",
"destination_postal": "text",
"weight_kg": "1250.00",
"volume_l": "1250.00",
"piece_count": 10,
"service_level": "text",
"selected_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/rate-quotes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"freight_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","origin_postal":"text","destination_postal":"text"}'PUT/api/scm/rate-quotes/{id}Change a rate quote
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 |
|---|---|---|---|
freight_order_id | uuid | No | Freight order id |
load_id | uuid | No | Load id |
origin_postal | text | No | From postal code |
destination_postal | text | No | To postal code |
weight_kg | numeric | No | Weight (kg) |
volume_l | numeric | No | Volume (L) |
piece_count | integer | No | Pieces |
service_level | text | No | Service level |
selection_reason | text | No | Why this one |
status | text | No | Status Allowed: open quoted selected expired failed cancelled |
Sample body
{
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quote_no": "QUO-000001",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"requested_at": "2026-10-30T09:00:00Z",
"requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"origin_postal": "text",
"destination_postal": "text",
"weight_kg": "1250.00",
"volume_l": "1250.00",
"piece_count": 10,
"service_level": "text",
"selected_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"freight_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/rate-quotes/{id}Delete a rate quote
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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rate-quotes/{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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/scm/rate-quotes/{parentId}/optionsOptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/options" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/rate-quotes/{parentId}/optionsOptions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, 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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/options" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/rate-quotes/{parentId}/options/{lineId}Options
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/options/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/rate-quotes/{parentId}/options/{lineId}Options
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/scm/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/options/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a rate quote, 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 |
quote_no | text | read only | Quote no |
freight_order_id | uuid | read, write | Freight order id |
load_id | uuid | read, write | Load id |
requested_at | timestamp with time zone | read only | Requested at |
requested_by | uuid | read only | Requested by |
origin_postal | text | read, write | From postal code |
destination_postal | text | read, write | To postal code |
weight_kg | numeric | read, write | Weight (kg) |
volume_l | numeric | read, write | Volume (L) |
piece_count | integer | read, write | Pieces |
service_level | text | read, write | Service level |
selected_option_id | uuid | read only | Selected option id |
selection_reason | text | read, write | Why this one |
status | text | read, write | Status Allowed: open quoted selected expired failed cancelled |
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 › Rate Shopping 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.