TRANXACT.AI Help

Supply Chain · Third-Party Logistics

Shipping Labels

Labels that have been bought. Kept because voiding one is a real action with a real refund window, and reprinting is the commonest request a shipping desk gets.

Type REST6 operationsBase path /api/scm/shipping-labelsPublished as /api/v1/shipping-labels

Download specification (OpenAPI 3.1) Screen: Shipping Labels

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 › Shipping Labels 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.shipping_labels · kept per company (and organisational unit where it has one)
RecordRead only; 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/shipping-labelsList shipping labels

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",
      "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tracking_no": "TRA-000001",
      "label_format": "text",
      "label_data": "text",
      "label_url": "https://example.com",
      "cost_amount": "1250.00",
      "currency": "USD",
      "purchased_at": "2026-10-30T09:00:00Z",
      "printed_at": "2026-10-30T09:00:00Z",
      "voided_at": "2026-10-30T09:00:00Z",
      "void_reason": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tracking_no": "TRA-000001",
  "label_format": "text",
  "label_data": "text",
  "label_url": "https://example.com",
  "cost_amount": "1250.00",
  "currency": "USD",
  "purchased_at": "2026-10-30T09:00:00Z",
  "printed_at": "2026-10-30T09:00:00Z",
  "voided_at": "2026-10-30T09:00:00Z",
  "void_reason": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/shipping-labels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/shipping-labelsPost shipping labels

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/shipping-labels" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/shipping-labels/{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/shipping-labels/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/shipping-labels/{id}Put shipping labels

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/shipping-labels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/shipping-labels/{id}Delete shipping labels

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 DELETE "https://demo.tranxact.ai/api/scm/shipping-labels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a shipping label, 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
freight_order_iduuidread onlyFreight order id
hu_iduuidread onlyHu id
carrier_account_iduuidread onlyCarrier account id
tracking_notextread onlyTracking no
label_formattextread onlyLabel format
label_datatextread onlyLabel data
label_urltextread onlyLabel url
cost_amountnumericread onlyCost amount
currencytextread onlyCurrency
purchased_attimestamp with time zoneread onlyPurchased at
printed_attimestamp with time zoneread onlyPrinted at
voided_attimestamp with time zoneread onlyVoided at
void_reasontextread onlyVoid reason
statustextread onlyStatus
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 › Shipping Labels 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.