Supply Chain · Warehouse Execution
Waves
The decision to work on THESE orders now. Picking one order at a time walks the same aisle forty times; a truck leaving at four means the work starts at one.
/api/scm/wavesPublished as /api/v1/wavesOverview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Waves 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 | scm.waves · 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
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/wavesList waves
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",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"wave_no": "WAV-000001",
"name": "Example",
"wave_type": "text",
"pick_method": "text",
"release_rule": "text",
"cutoff_at": "2026-10-30T09:00:00Z",
"planned_start": "2026-10-30T09:00:00Z",
"planned_finish": "2026-10-30T09:00:00Z",
"released_at": "2026-10-30T09:00:00Z",
"completed_at": "2026-10-30T09:00:00Z",
"released_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/waves?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/waves/{id}Read one waves
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",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"wave_no": "WAV-000001",
"name": "Example",
"wave_type": "text",
"pick_method": "text",
"release_rule": "text",
"cutoff_at": "2026-10-30T09:00:00Z",
"planned_start": "2026-10-30T09:00:00Z",
"planned_finish": "2026-10-30T09:00:00Z",
"released_at": "2026-10-30T09:00:00Z",
"completed_at": "2026-10-30T09:00:00Z",
"released_by": "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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/wavesCreate a waves
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
name | text | No | Name |
wave_type | text | No | Type |
pick_method | text | No | Pick method |
release_rule | text | No | Release rule |
cutoff_at | timestamp with time zone | No | Cutoff |
planned_start | timestamp with time zone | No | Planned start |
planned_finish | timestamp with time zone | No | Planned finish |
carrier_cutoff_at | timestamp with time zone | No | Carrier cutoff — The commitment the wave exists to meet. Past it, the wave is flagged. |
door_id | uuid | No | Door |
staging_area_id | uuid | No | Staged to |
notes | text | No | Notes |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"wave_type": "text",
"pick_method": "text",
"release_rule": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"wave_no": "WAV-000001",
"name": "Example",
"wave_type": "text",
"pick_method": "text",
"release_rule": "text",
"cutoff_at": "2026-10-30T09:00:00Z",
"planned_start": "2026-10-30T09:00:00Z",
"planned_finish": "2026-10-30T09:00:00Z",
"released_at": "2026-10-30T09:00:00Z",
"completed_at": "2026-10-30T09:00:00Z",
"released_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/waves" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","wave_type":"text","pick_method":"text","release_rule":"text"}'PUT/api/scm/waves/{id}Change a waves
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 |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
name | text | No | Name |
wave_type | text | No | Type |
pick_method | text | No | Pick method |
release_rule | text | No | Release rule |
cutoff_at | timestamp with time zone | No | Cutoff |
planned_start | timestamp with time zone | No | Planned start |
planned_finish | timestamp with time zone | No | Planned finish |
carrier_cutoff_at | timestamp with time zone | No | Carrier cutoff — The commitment the wave exists to meet. Past it, the wave is flagged. |
door_id | uuid | No | Door |
staging_area_id | uuid | No | Staged to |
notes | text | No | Notes |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"wave_no": "WAV-000001",
"name": "Example",
"wave_type": "text",
"pick_method": "text",
"release_rule": "text",
"cutoff_at": "2026-10-30T09:00:00Z",
"planned_start": "2026-10-30T09:00:00Z",
"planned_finish": "2026-10-30T09:00:00Z",
"released_at": "2026-10-30T09:00:00Z",
"completed_at": "2026-10-30T09:00:00Z",
"released_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'DELETE/api/scm/waves/{id}Delete a waves
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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/waves/{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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/scm/waves/{id}/releaseRelease
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):
tasksPerOrder, resourceIdResponse
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/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"tasksPerOrder":"value","resourceId":"value"}'GET/api/scm/waves/{parentId}/demandDemand
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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/demand" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/waves/{parentId}/demandDemand
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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/demand" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/waves/{parentId}/demand/{lineId}Demand
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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/demand/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/waves/{parentId}/demand/{lineId}Demand
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/scm/waves/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/demand/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a waves, 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 |
warehouse_id | uuid | read, write | Warehouse |
wave_no | text | read only | Wave no |
name | text | read, write | Name |
wave_type | text | read, write | Type |
pick_method | text | read, write | Pick method |
release_rule | text | read, write | Release rule |
cutoff_at | timestamp with time zone | read, write | Cutoff |
planned_start | timestamp with time zone | read, write | Planned start |
planned_finish | timestamp with time zone | read, write | Planned finish |
released_at | timestamp with time zone | read only | Released at |
completed_at | timestamp with time zone | read only | Completed at |
released_by | uuid | read only | Released by |
carrier_cutoff_at | timestamp with time zone | read, write | Carrier cutoff — The commitment the wave exists to meet. Past it, the wave is flagged. |
door_id | uuid | read, write | Door |
staging_area_id | uuid | read, write | Staged to |
order_count | integer | read only | Order count |
line_count | integer | read only | Line count |
task_count | integer | read only | Task count |
tasks_done | integer | read only | Tasks done |
units_planned | numeric | read only | Units planned |
units_picked | numeric | read only | Units picked |
estimated_minutes | numeric | read only | Estimated minutes |
actual_minutes | numeric | read only | Actual minutes |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Supply Chain › Waves 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.