CRM · Selling
Deliveries
Read and maintain deliveries records (crm.deliveries).
/api/crm/deliveriesPublished as /api/v1/deliveriesOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Deliveries 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. |
| Table | crm.deliveries · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/deliveriesList deliveries
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"delivery_no": "DEL-000001",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_date": "2026-10-30",
"status": "draft",
"ship_to_address": "text",
"incoterms": "text",
"goods_issued_at": "2026-10-30T09:00:00Z",
"notes": "text",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/deliveries?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/deliveries/{id}Read one deliveries
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"delivery_no": "DEL-000001",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_date": "2026-10-30",
"status": "draft",
"ship_to_address": "text",
"incoterms": "text",
"goods_issued_at": "2026-10-30T09:00:00Z",
"notes": "text",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/deliveriesCreate a deliveries
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
sales_order_id | uuid | No | Sales order id |
account_id | uuid | Yes | Account id |
delivery_date | date | No | Delivery date |
status | text | No | Status |
ship_to_address | text | No | Ship to |
incoterms | text | No | Incoterms |
notes | text | No | Notes |
currency | text | No | Currency |
exchange_rate | numeric | No | Exchange rate |
Sample body
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_date": "2026-10-30",
"status": "draft",
"ship_to_address": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_no": "DEL-000001",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_date": "2026-10-30",
"status": "draft",
"ship_to_address": "text",
"incoterms": "text",
"goods_issued_at": "2026-10-30T09:00:00Z",
"notes": "text",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/deliveries" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","delivery_date":"2026-10-30","status":"draft","ship_to_address":"text"}'PUT/api/crm/deliveries/{id}Change a deliveries
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
sales_order_id | uuid | No | Sales order id |
account_id | uuid | Yes | Account id |
delivery_date | date | No | Delivery date |
status | text | No | Status |
ship_to_address | text | No | Ship to |
incoterms | text | No | Incoterms |
notes | text | No | Notes |
currency | text | No | Currency |
exchange_rate | numeric | No | Exchange rate |
Sample body
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_no": "DEL-000001",
"sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_date": "2026-10-30",
"status": "draft",
"ship_to_address": "text",
"incoterms": "text",
"goods_issued_at": "2026-10-30T09:00:00Z",
"notes": "text",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"created_at": "2026-10-30T09:00:00Z",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/deliveries/{id}Delete a deliveries
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/deliveries/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/deliveries/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/deliveries/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/deliveries/{parentId}/linesLines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/deliveries/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/deliveries/{parentId}/lines/{lineId}Lines
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/deliveries/{id}/lines/{lineId}/serialsLines serials
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
serialsResponse
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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/serials" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"serials":"value"}'POST/api/crm/deliveries/{id}/post-goods-issuePost goods issue
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post-goods-issue" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/deliveries/{id}/create-shipmentCreate shipment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
carrier, serviceLevel, trackingNo, shipDate, etaDate, freightCost; packages: [{ packageNo, packageType, weightKg, trackingNo, contents }]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/deliveries/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/create-shipment" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"carrier":"value","serviceLevel":"value","trackingNo":"value","shipDate":"value","etaDate":"value","freightCost;":"value"}'Data model
Every field of a deliveries, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
delivery_no | text | read only | Delivery no |
sales_order_id | uuid | read, write | Sales order id |
account_id | uuid | read, write | Account id |
delivery_date | date | read, write | Delivery date |
status | text | read, write | Status |
ship_to_address | text | read, write | Ship to |
incoterms | text | read, write | Incoterms |
goods_issued_at | timestamp with time zone | read only | Goods issued at |
notes | text | read, write | Notes |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
location_id | uuid | read only | Location id |
warehouse_id | uuid | read only | Warehouse id |
cost_center_id | uuid | read only | Cost center id |
profit_center_id | uuid | read only | Profit center id |
cancelled_at | timestamp with time zone | read only | Cancelled at |
cancelled_by | uuid | read only | Cancelled by |
cancel_reason | text | read only | Cancel reason |
reversed_by_id | uuid | read only | Reversed by id |
reverses_id | uuid | read only | Reverses id |
currency | text | read, write | Currency |
exchange_rate | numeric | read, write | Exchange rate |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
eway_bill_required | boolean | read only | Eway bill required |
consignment_value | numeric | read only | Consignment value |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Deliveries for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.