TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/scm/rate-quotesPublished as /api/v1/rate-quotes

Download specification (OpenAPI 3.1) Screen: Rate Shopping

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 › 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.
Tablescm.rate_quotes · 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

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/rate-quotesList rate shopping

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
freight_order_iduuidNoFreight order id
load_iduuidNoLoad id
origin_postaltextNoFrom postal code
destination_postaltextNoTo postal code
weight_kgnumericNoWeight (kg)
volume_lnumericNoVolume (L)
piece_countintegerNoPieces
service_leveltextNoService level
selection_reasontextNoWhy this one
statustextNoStatus
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

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
freight_order_iduuidNoFreight order id
load_iduuidNoLoad id
origin_postaltextNoFrom postal code
destination_postaltextNoTo postal code
weight_kgnumericNoWeight (kg)
volume_lnumericNoVolume (L)
piece_countintegerNoPieces
service_leveltextNoService level
selection_reasontextNoWhy this one
statustextNoStatus
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

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/rate-quotes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/rate-quotes/{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/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

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

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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
quote_notextread onlyQuote no
freight_order_iduuidread, writeFreight order id
load_iduuidread, writeLoad id
requested_attimestamp with time zoneread onlyRequested at
requested_byuuidread onlyRequested by
origin_postaltextread, writeFrom postal code
destination_postaltextread, writeTo postal code
weight_kgnumericread, writeWeight (kg)
volume_lnumericread, writeVolume (L)
piece_countintegerread, writePieces
service_leveltextread, writeService level
selected_option_iduuidread onlySelected option id
selection_reasontextread, writeWhy this one
statustextread, writeStatus
Allowed: open quoted selected expired failed cancelled
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Rate Shopping 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.