TRANXACT.AI Help

CRM · Selling

Shipments

Read and maintain shipments records (crm.shipments).

Type REST11 operationsBase path /api/crm/shipmentsPublished as /api/v1/shipments

Download specification (OpenAPI 3.1) Screen: Shipments

Overview

PackageCRM
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 CRM › Shipments 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.
Tablecrm.shipments · 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

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

GET/api/crm/shipmentsList shipments

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",
      "shipment_no": "SHI-000001",
      "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier": "text",
      "service_level": "text",
      "tracking_no": "TRA-000001",
      "ship_date": "2026-10-30",
      "eta_date": "2026-10-30",
      "delivered_at": "2026-10-30T09:00:00Z",
      "freight_cost": "1250.00",
      "currency": "USD",
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "shipment_no": "SHI-000001",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier": "text",
  "service_level": "text",
  "tracking_no": "TRA-000001",
  "ship_date": "2026-10-30",
  "eta_date": "2026-10-30",
  "delivered_at": "2026-10-30T09:00:00Z",
  "freight_cost": "1250.00",
  "currency": "USD",
  "status": "draft"
}

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

Sample request

curl "https://demo.tranxact.ai/api/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/shipmentsCreate a shipments

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
delivery_iduuidNoDelivery id
account_iduuidNoAccount id
carriertextNoCarrier
service_leveltextNoService level
tracking_notextNoTracking number
ship_datedateNoShip date
eta_datedateNoExpected arrival
freight_costnumericNoFreight cost
currencytextNoCurrency
statustextNoStatus
notestextNoNotes
exchange_ratenumericNoExchange rate

Sample body

{
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier": "text",
  "service_level": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "shipment_no": "SHI-000001",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier": "text",
  "service_level": "text",
  "tracking_no": "TRA-000001",
  "ship_date": "2026-10-30",
  "eta_date": "2026-10-30",
  "delivered_at": "2026-10-30T09:00:00Z",
  "freight_cost": "1250.00",
  "currency": "USD",
  "status": "draft"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/shipments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"delivery_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier":"text","service_level":"text"}'
PUT/api/crm/shipments/{id}Change a shipments

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
delivery_iduuidNoDelivery id
account_iduuidNoAccount id
carriertextNoCarrier
service_leveltextNoService level
tracking_notextNoTracking number
ship_datedateNoShip date
eta_datedateNoExpected arrival
freight_costnumericNoFreight cost
currencytextNoCurrency
statustextNoStatus
notestextNoNotes
exchange_ratenumericNoExchange rate

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "shipment_no": "SHI-000001",
  "delivery_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier": "text",
  "service_level": "text",
  "tracking_no": "TRA-000001",
  "ship_date": "2026-10-30",
  "eta_date": "2026-10-30",
  "delivered_at": "2026-10-30T09:00:00Z",
  "freight_cost": "1250.00",
  "currency": "USD",
  "status": "draft"
}

Sample request

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

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

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/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/packages" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/shipments/{parentId}/packagesPackages

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/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/packages" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/shipments/{parentId}/packages/{lineId}Packages

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/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/packages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/shipments/{parentId}/packages/{lineId}Packages

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/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/packages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/shipments/{id}/mark-deliveredMark delivered

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/crm/shipments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mark-delivered" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a shipments, 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
shipment_notextread onlyShipment no
delivery_iduuidread, writeDelivery id
account_iduuidread, writeAccount id
carriertextread, writeCarrier
service_leveltextread, writeService level
tracking_notextread, writeTracking number
ship_datedateread, writeShip date
eta_datedateread, writeExpected arrival
delivered_attimestamp with time zoneread onlyDelivered at
freight_costnumericread, writeFreight cost
currencytextread, writeCurrency
statustextread, writeStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
exchange_ratenumericread, writeExchange rate
base_freight_costnumericread onlyBase freight cost
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 CRM › Shipments 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.