TRANXACT.AI Help

Supply Chain · Third-Party Logistics

Carrier Accounts

One set of credentials with one provider. Sealed the way every other connector in the product seals them, and never sent back to the browser.

Type REST8 operationsBase path /api/scm/carrier-accountsPublished as /api/v1/carrier-accounts

Download specification (OpenAPI 3.1) Screen: Carrier Accounts

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 › Carrier Accounts 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.carrier_accounts · 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

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

GET/api/scm/carrier-accountsList carrier accounts

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",
      "code": "COD-000001",
      "name": "Example",
      "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_number": "ACC-000001",
      "meter_number": "MET-000001",
      "shipper_number": "SHI-000001",
      "site_id": "text",
      "api_key_cipher": "text",
      "api_secret_cipher": "text",
      "username": "Example",
      "password_cipher": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number": "ACC-000001",
  "meter_number": "MET-000001",
  "shipper_number": "SHI-000001",
  "site_id": "text",
  "api_key_cipher": "text",
  "api_secret_cipher": "text",
  "username": "Example",
  "password_cipher": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/carrier-accountsCreate a carrier account

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
provider_iduuidNoProvider
carrier_iduuidNoCarrier
account_numbertextNoAccount number
meter_numbertextNoMeter number — FedEx.
shipper_numbertextNoShipper number — UPS.
site_idtextNoSite id — DHL.
usernametextNoUsername
environmenttextNoEnvironment — Labels bought in a sandbox are not real. Switch to production before shipping anything.
Allowed: sandbox production
ship_from_place_iduuidNoShips from
default_label_formattextNoLabel format
default_service_iduuidNoDefault service
negotiated_ratesbooleanNoUse negotiated rates
is_defaultbooleanNoDefault account
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number": "ACC-000001",
  "meter_number": "MET-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number": "ACC-000001",
  "meter_number": "MET-000001",
  "shipper_number": "SHI-000001",
  "site_id": "text",
  "api_key_cipher": "text",
  "api_secret_cipher": "text",
  "username": "Example",
  "password_cipher": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/carrier-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_number":"ACC-000001","meter_number":"MET-000001"}'
PUT/api/scm/carrier-accounts/{id}Change a carrier account

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
codetextYesCode
nametextYesName
provider_iduuidNoProvider
carrier_iduuidNoCarrier
account_numbertextNoAccount number
meter_numbertextNoMeter number — FedEx.
shipper_numbertextNoShipper number — UPS.
site_idtextNoSite id — DHL.
usernametextNoUsername
environmenttextNoEnvironment — Labels bought in a sandbox are not real. Switch to production before shipping anything.
Allowed: sandbox production
ship_from_place_iduuidNoShips from
default_label_formattextNoLabel format
default_service_iduuidNoDefault service
negotiated_ratesbooleanNoUse negotiated rates
is_defaultbooleanNoDefault account
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_number": "ACC-000001",
  "meter_number": "MET-000001",
  "shipper_number": "SHI-000001",
  "site_id": "text",
  "api_key_cipher": "text",
  "api_secret_cipher": "text",
  "username": "Example",
  "password_cipher": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/carrier-accounts/{id}Delete a carrier account

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credentials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/carrier-accounts/{id}/checkCheck

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/carrier-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a carrier account, 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
codetextread, writeCode
nametextread, writeName
provider_iduuidread, writeProvider
carrier_iduuidread, writeCarrier
account_numbertextread, writeAccount number
meter_numbertextread, writeMeter number — FedEx.
shipper_numbertextread, writeShipper number — UPS.
site_idtextread, writeSite id — DHL.
api_key_cipherbytearead onlyApi key cipher
api_secret_cipherbytearead onlyApi secret cipher
usernametextread, writeUsername
password_cipherbytearead onlyPassword cipher
access_token_cipherbytearead onlyAccess token cipher
token_expires_attimestamp with time zoneread onlyToken expires at
environmenttextread, writeEnvironment — Labels bought in a sandbox are not real. Switch to production before shipping anything.
Allowed: sandbox production
ship_from_place_iduuidread, writeShips from
default_label_formattextread, writeLabel format
default_service_iduuidread, writeDefault service
negotiated_ratesbooleanread, writeUse negotiated rates
webhook_secret_cipherbytearead onlyWebhook secret cipher
last_ok_attimestamp with time zoneread onlyLast ok at
last_error_attimestamp with time zoneread onlyLast error at
last_errortextread onlyLast error
calls_todayintegerread onlyCalls today
is_defaultbooleanread, writeDefault account
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 › Carrier Accounts 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.