TRANXACT.AI Help

Supply Chain · Freight Management

Freight Orders

The instruction to a carrier: collect here, deliver there, these stops in this order. Tendered, accepted, refused, offered to the next one down.

Type REST17 operationsBase path /api/scm/freight-ordersPublished as /api/v1/freight-orders

Download specification (OpenAPI 3.1) Screen: Freight Orders

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 › Freight Orders 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.freight_orders · 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

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

GET/api/scm/freight-ordersList freight orders

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",
      "freight_order_no": "FRE-000001",
      "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "direction": "outbound",
      "mode": "text",
      "incoterm": "text",
      "payment_terms": "text",
      "bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bol_no": "BOL-000001"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/freight-orders?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/freight-orders/{id}Read one freight order

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",
  "freight_order_no": "FRE-000001",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "direction": "outbound",
  "mode": "text",
  "incoterm": "text",
  "payment_terms": "text",
  "bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bol_no": "BOL-000001"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-ordersCreate a freight order

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
load_iduuidNoLoad
carrier_iduuidNoCarrier
carrier_service_iduuidNoService
transport_lane_iduuidNoLane
tariff_iduuidNoTariff
directiontextNoDirection
Allowed: outbound inbound transfer return third_party
modetextNoMode
incotermtextNoIncoterm
payment_termstextNoWho pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party.
bill_to_account_iduuidNoBill to
bol_notextNoBill of lading
pro_notextNoCarrier number
tracking_notextNoTracking number
pickup_notextNoCollection number
customer_reftextNoCustomer reference
requested_pickup_attimestamp with time zoneNoRequested collection
pickup_attimestamp with time zoneNoCollected
requested_delivery_attimestamp with time zoneNoRequested delivery
promised_delivery_attimestamp with time zoneNoPromised delivery
delivered_attimestamp with time zoneNoDelivered
quoted_amountnumericNoQuoted
currencytextNoCurrency
cost_center_iduuidNoCost center
declared_valuenumericNoDeclared value
is_hazardousbooleanNoDangerous goods
is_temperature_controlledbooleanNoTemperature controlled
temperature_min_cnumericNoMinimum temperature (C)
temperature_max_cnumericNoMaximum temperature (C)
special_instructionstextNoSpecial instructions
notestextNoNotes

Sample body

{
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_no": "FRE-000001",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "direction": "outbound",
  "mode": "text",
  "incoterm": "text",
  "payment_terms": "text",
  "bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bol_no": "BOL-000001"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/freight-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_service_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","transport_lane_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/freight-orders/{id}Change a freight order

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
load_iduuidNoLoad
carrier_iduuidNoCarrier
carrier_service_iduuidNoService
transport_lane_iduuidNoLane
tariff_iduuidNoTariff
directiontextNoDirection
Allowed: outbound inbound transfer return third_party
modetextNoMode
incotermtextNoIncoterm
payment_termstextNoWho pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party.
bill_to_account_iduuidNoBill to
bol_notextNoBill of lading
pro_notextNoCarrier number
tracking_notextNoTracking number
pickup_notextNoCollection number
customer_reftextNoCustomer reference
requested_pickup_attimestamp with time zoneNoRequested collection
pickup_attimestamp with time zoneNoCollected
requested_delivery_attimestamp with time zoneNoRequested delivery
promised_delivery_attimestamp with time zoneNoPromised delivery
delivered_attimestamp with time zoneNoDelivered
quoted_amountnumericNoQuoted
currencytextNoCurrency
cost_center_iduuidNoCost center
declared_valuenumericNoDeclared value
is_hazardousbooleanNoDangerous goods
is_temperature_controlledbooleanNoTemperature controlled
temperature_min_cnumericNoMinimum temperature (C)
temperature_max_cnumericNoMaximum temperature (C)
special_instructionstextNoSpecial instructions
notestextNoNotes

Sample body

{
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_no": "FRE-000001",
  "load_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_service_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport_lane_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tariff_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "direction": "outbound",
  "mode": "text",
  "incoterm": "text",
  "payment_terms": "text",
  "bill_to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bol_no": "BOL-000001"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"load_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/scm/freight-orders/{id}Delete a freight order

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-orders/{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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/scm/freight-orders/{id}/tenderTender

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):

response, carrierId, note

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tender" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"response":"value","carrierId":"value","note":"value"}'
POST/api/scm/freight-orders/{id}/trackTrack

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):

eventType, eventCode, description, occurredAt, city, region, country, latitude, longitude, signedBy, source, exceptionCode; eventType one of booked|picked_up|departed|arrived|in_transit|customs_hold|customs_cleared|out_for_delivery|delivered|exception|delayed|refused|returned|lost|damaged|geofence_enter|geofence_exit|position; source one of carrier_api|webhook|edi|telematics|geofence|manual|driver_app|email

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/track" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"eventType":"value","eventCode":"value","description":"value","occurredAt":"value","city":"value","region":"value"}'
GET/api/scm/freight-orders/{id}/trackingTracking

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tracking" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/freight-orders/{parentId}/linesLines

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-orders/{parentId}/linesLines

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/freight-orders/{parentId}/lines/{lineId}Lines

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/freight-orders/{parentId}/lines/{lineId}Lines

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/freight-orders/{parentId}/chargesCharges

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-orders/{parentId}/chargesCharges

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/freight-orders/{parentId}/charges/{lineId}Charges

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/freight-orders/{parentId}/charges/{lineId}Charges

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/freight-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a freight order, 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
freight_order_notextread onlyFreight order no
load_iduuidread, writeLoad
carrier_iduuidread, writeCarrier
carrier_service_iduuidread, writeService
transport_lane_iduuidread, writeLane
tariff_iduuidread, writeTariff
directiontextread, writeDirection
Allowed: outbound inbound transfer return third_party
modetextread, writeMode
incotermtextread, writeIncoterm
payment_termstextread, writeWho pays — Prepaid, collect and third party are three different receivables, and getting it wrong bills the wrong party.
bill_to_account_iduuidread, writeBill to
bol_notextread, writeBill of lading
pro_notextread, writeCarrier number
tracking_notextread, writeTracking number
pickup_notextread, writeCollection number
customer_reftextread, writeCustomer reference
requested_pickup_attimestamp with time zoneread, writeRequested collection
pickup_attimestamp with time zoneread, writeCollected
requested_delivery_attimestamp with time zoneread, writeRequested delivery
promised_delivery_attimestamp with time zoneread, writePromised delivery
delivered_attimestamp with time zoneread, writeDelivered
quoted_amountnumericread, writeQuoted
accrued_amountnumericread onlyAccrued amount
invoiced_amountnumericread onlyInvoiced amount
currencytextread, writeCurrency
cost_center_iduuidread, writeCost center
total_weight_kgnumericread onlyTotal weight kg
chargeable_weight_kgnumericread onlyChargeable weight kg
total_volume_lnumericread onlyTotal volume l
piece_countintegerread onlyPiece count
declared_valuenumericread, writeDeclared value
is_hazardousbooleanread, writeDangerous goods
is_temperature_controlledbooleanread, writeTemperature controlled
temperature_min_cnumericread, writeMinimum temperature (C)
temperature_max_cnumericread, writeMaximum temperature (C)
special_instructionstextread, writeSpecial instructions
tendered_attimestamp with time zoneread onlyTendered at
tender_response_attimestamp with time zoneread onlyTender response at
tender_attemptsintegerread onlyTender attempts
statustextread onlyStatus
notestextread, writeNotes
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 › Freight Orders 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.