TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/carriersPublished as /api/v1/carriers

Download specification (OpenAPI 3.1) Screen: Carriers

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

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

GET/api/scm/carriersList carriers

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

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

FieldTypeRequiredDescription
carrier_notextNoCarrier number
nametextYesName
supplier_iduuidNoBills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled.
carrier_typetextNoType
scactextNoSCAC — The standard carrier alpha code.
mc_numbertextNoMC number
dot_numbertextNoDOT number
iata_codetextNoIATA code
vat_numbertextNoVAT number
integration_codetextNoIntegration
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
fuel_surcharge_pctnumericNoFuel surcharge %
accessorial_policytextNoAccessorial policy
contract_iduuidNoContract
insurance_expires_ondateNoInsurance expires
liability_limitnumericNoLiability limit
is_hazmat_certifiedbooleanNoCertified for dangerous goods
is_customs_bondedbooleanNoCustoms bonded
tracking_url_templatetextNoTracking URL — Put {tracking_no} where the number goes.
contact_nametextNoContact
contact_emailtextNoEmail
contact_phonetextNoTelephone
statustextNoStatus
Allowed: prospect active suspended expired terminated
is_activebooleanNoActive
notestextNoNotes

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

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
carrier_notextNoCarrier number
nametextYesName
supplier_iduuidNoBills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled.
carrier_typetextNoType
scactextNoSCAC — The standard carrier alpha code.
mc_numbertextNoMC number
dot_numbertextNoDOT number
iata_codetextNoIATA code
vat_numbertextNoVAT number
integration_codetextNoIntegration
currencytextNoCurrency
payment_terms_daysintegerNoPayment terms (days)
fuel_surcharge_pctnumericNoFuel surcharge %
accessorial_policytextNoAccessorial policy
contract_iduuidNoContract
insurance_expires_ondateNoInsurance expires
liability_limitnumericNoLiability limit
is_hazmat_certifiedbooleanNoCertified for dangerous goods
is_customs_bondedbooleanNoCustoms bonded
tracking_url_templatetextNoTracking URL — Put {tracking_no} where the number goes.
contact_nametextNoContact
contact_emailtextNoEmail
contact_phonetextNoTelephone
statustextNoStatus
Allowed: prospect active suspended expired terminated
is_activebooleanNoActive
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
carrier_notextread, writeCarrier number
nametextread, writeName
supplier_iduuidread, writeBills through supplier — Without this there is nowhere to post the payable and a freight invoice cannot be settled.
carrier_typetextread, writeType
scactextread, writeSCAC — The standard carrier alpha code.
mc_numbertextread, writeMC number
dot_numbertextread, writeDOT number
iata_codetextread, writeIATA code
vat_numbertextread, writeVAT number
integration_codetextread, writeIntegration
currencytextread, writeCurrency
payment_terms_daysintegerread, writePayment terms (days)
fuel_surcharge_pctnumericread, writeFuel surcharge %
accessorial_policytextread, writeAccessorial policy
contract_iduuidread, writeContract
on_time_pctnumericread onlyOn time pct
damage_rate_pctnumericread onlyDamage rate pct
invoice_accuracy_pctnumericread onlyInvoice accuracy pct
performance_scorenumericread onlyPerformance score
insurance_expires_ondateread, writeInsurance expires
liability_limitnumericread, writeLiability limit
is_hazmat_certifiedbooleanread, writeCertified for dangerous goods
is_customs_bondedbooleanread, writeCustoms bonded
tracking_url_templatetextread, writeTracking URL — Put {tracking_no} where the number goes.
contact_nametextread, writeContact
contact_emailtextread, writeEmail
contact_phonetextread, writeTelephone
statustextread, writeStatus
Allowed: prospect active suspended expired terminated
is_activebooleanread, writeActive
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 › Carriers 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.