TRANXACT.AI Help

Supply Chain · Third-Party Logistics

Logistics Providers

The integrations the platform knows how to speak, and what each one actually needs before it will work. "Configure your credentials" helps nobody.

Type REST6 operationsBase path /api/scm/logistics-providersPublished as /api/v1/logistics-providers

Download specification (OpenAPI 3.1) Screen: Logistics Providers

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 › Logistics Providers 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.logistics_providers · 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/logistics-providersList logistics providers

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",
      "code": "COD-000001",
      "name": "Example",
      "vendor": "text",
      "category": "parcel",
      "supports_rating": true,
      "supports_booking": true,
      "supports_labels": true,
      "supports_tracking": true,
      "supports_pickup": true,
      "supports_documents": true,
      "supports_webhooks": true,
      "protocol": "rest",
      "auth_method": "oauth2"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "text",
  "category": "parcel",
  "supports_rating": true,
  "supports_booking": true,
  "supports_labels": true,
  "supports_tracking": true,
  "supports_pickup": true,
  "supports_documents": true,
  "supports_webhooks": true,
  "protocol": "rest",
  "auth_method": "oauth2"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/logistics-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/logistics-providersCreate a logistics provider

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
vendortextNoVendor
categorytextNoCategory
Allowed: parcel ltl truckload ocean air forwarder aggregator postal last_mile visibility customs
supports_ratingbooleanNoCan rate
supports_bookingbooleanNoCan book
supports_labelsbooleanNoCan produce labels
supports_trackingbooleanNoCan track
supports_pickupbooleanNoCan arrange collection
supports_documentsbooleanNoCan produce documents
supports_webhooksbooleanNoPushes events back
protocoltextNoProtocol
Allowed: rest soap edi ftp sftp email manual
auth_methodtextNoAuthentication
Allowed: oauth2 api_key basic certificate token none
base_urltextNoProduction URL
sandbox_urltextNoSandbox URL
edi_standardtextNoEDI standard
tracking_url_templatetextNoTracking URL template
documentation_urltextNoDocumentation
setup_notestextNoWhat has to be got first
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "vendor": "text",
  "category": "parcel",
  "supports_rating": true,
  "supports_booking": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "text",
  "category": "parcel",
  "supports_rating": true,
  "supports_booking": true,
  "supports_labels": true,
  "supports_tracking": true,
  "supports_pickup": true,
  "supports_documents": true,
  "supports_webhooks": true,
  "protocol": "rest",
  "auth_method": "oauth2"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/logistics-providers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","vendor":"text","category":"parcel","supports_rating":true,"supports_booking":true}'
PUT/api/scm/logistics-providers/{id}Change a logistics provider

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
vendortextNoVendor
categorytextNoCategory
Allowed: parcel ltl truckload ocean air forwarder aggregator postal last_mile visibility customs
supports_ratingbooleanNoCan rate
supports_bookingbooleanNoCan book
supports_labelsbooleanNoCan produce labels
supports_trackingbooleanNoCan track
supports_pickupbooleanNoCan arrange collection
supports_documentsbooleanNoCan produce documents
supports_webhooksbooleanNoPushes events back
protocoltextNoProtocol
Allowed: rest soap edi ftp sftp email manual
auth_methodtextNoAuthentication
Allowed: oauth2 api_key basic certificate token none
base_urltextNoProduction URL
sandbox_urltextNoSandbox URL
edi_standardtextNoEDI standard
tracking_url_templatetextNoTracking URL template
documentation_urltextNoDocumentation
setup_notestextNoWhat has to be got first
is_activebooleanNoActive

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "vendor": "text",
  "category": "parcel",
  "supports_rating": true,
  "supports_booking": true,
  "supports_labels": true,
  "supports_tracking": true,
  "supports_pickup": true,
  "supports_documents": true,
  "supports_webhooks": true,
  "protocol": "rest",
  "auth_method": "oauth2"
}

Sample request

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

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/logistics-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/logistics-providers/{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/logistics-providers/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 logistics provider, 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
codetextread, writeCode
nametextread, writeName
vendortextread, writeVendor
categorytextread, writeCategory
Allowed: parcel ltl truckload ocean air forwarder aggregator postal last_mile visibility customs
supports_ratingbooleanread, writeCan rate
supports_bookingbooleanread, writeCan book
supports_labelsbooleanread, writeCan produce labels
supports_trackingbooleanread, writeCan track
supports_pickupbooleanread, writeCan arrange collection
supports_documentsbooleanread, writeCan produce documents
supports_webhooksbooleanread, writePushes events back
protocoltextread, writeProtocol
Allowed: rest soap edi ftp sftp email manual
auth_methodtextread, writeAuthentication
Allowed: oauth2 api_key basic certificate token none
base_urltextread, writeProduction URL
sandbox_urltextread, writeSandbox URL
edi_standardtextread, writeEDI standard
label_formats_textread onlyLabel formats
tracking_url_templatetextread, writeTracking URL template
documentation_urltextread, writeDocumentation
setup_notestextread, writeWhat has to be got first
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 › Logistics Providers 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.