Supply Chain · Goods Movement
Movement History
One movement in progress. Scan a barcode, wave a tag or photograph the pallet; the platform decodes it, checks it and posts it. Every kind of movement is the same three steps.
/api/scm/scan-sessionsPublished as /api/v1/scan-sessionsDownload specification (OpenAPI 3.1) Screen: Movement History
Overview
| 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 › Movement History 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.scan_sessions · 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
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/scan-sessionsList movement history
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",
"session_no": "SES-000001",
"movement_type": "text",
"capture_mode": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_type": "purchase_order",
"reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_code": "REA-000001",
"device_id": "text",
"operator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/scan-sessions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/scan-sessions/{id}Read one scan sessions
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",
"session_no": "SES-000001",
"movement_type": "text",
"capture_mode": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_type": "purchase_order",
"reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_code": "REA-000001",
"device_id": "text",
"operator_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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/scan-sessionsCreate a scan sessions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
movement_type | text | Yes | Movement |
capture_mode | text | No | Captured by |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin — Where the goods are, or are coming from. |
to_bin_id | uuid | No | Destination bin — Transfers and put-aways only. |
reference_type | text | No | Against what Allowed: purchase_order delivery work_order asn wms none |
reference_id | uuid | No | Reference id |
reference_no | text | No | Reference number |
supplier_id | uuid | No | Supplier — Receipts and returns to vendor. |
reason_code | text | No | Reason — Required in spirit for scrapping and returns — it is what the write-off is explained by. |
device_id | text | No | Device |
operator_id | uuid | No | Operator id |
reader_id | uuid | No | RFID reader |
cost_center_id | uuid | No | Cost center |
notes | text | No | Notes |
document_date | date | No | Document date |
posting_date | date | No | Posting date |
delivery_note | text | No | Delivery note |
bill_of_lading | text | No | Bill of lading |
material_slip | text | No | Material slip |
unloading_point | text | No | Unloading point |
goods_recipient | text | No | Goods recipient |
header_text | text | No | Header text |
item_text | text | No | Item text |
wbs_element | text | No | Wbs element |
gl_account_id | uuid | No | Gl account id |
label_printer | text | No | Label printer |
label_copies | integer | No | Label copies |
Sample body
{
"movement_type": "text",
"capture_mode": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"session_no": "SES-000001",
"movement_type": "text",
"capture_mode": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_type": "purchase_order",
"reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_code": "REA-000001",
"device_id": "text",
"operator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/scan-sessions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"movement_type":"text","capture_mode":"text","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/scan-sessions/{id}Change a scan sessions
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 |
|---|---|---|---|
movement_type | text | Yes | Movement |
capture_mode | text | No | Captured by |
warehouse_id | uuid | No | Warehouse |
bin_id | uuid | No | Bin — Where the goods are, or are coming from. |
to_bin_id | uuid | No | Destination bin — Transfers and put-aways only. |
reference_type | text | No | Against what Allowed: purchase_order delivery work_order asn wms none |
reference_id | uuid | No | Reference id |
reference_no | text | No | Reference number |
supplier_id | uuid | No | Supplier — Receipts and returns to vendor. |
reason_code | text | No | Reason — Required in spirit for scrapping and returns — it is what the write-off is explained by. |
device_id | text | No | Device |
operator_id | uuid | No | Operator id |
reader_id | uuid | No | RFID reader |
cost_center_id | uuid | No | Cost center |
notes | text | No | Notes |
document_date | date | No | Document date |
posting_date | date | No | Posting date |
delivery_note | text | No | Delivery note |
bill_of_lading | text | No | Bill of lading |
material_slip | text | No | Material slip |
unloading_point | text | No | Unloading point |
goods_recipient | text | No | Goods recipient |
header_text | text | No | Header text |
item_text | text | No | Item text |
wbs_element | text | No | Wbs element |
gl_account_id | uuid | No | Gl account id |
label_printer | text | No | Label printer |
label_copies | integer | No | Label copies |
Sample body
{
"movement_type": "text",
"capture_mode": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"session_no": "SES-000001",
"movement_type": "text",
"capture_mode": "text",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_type": "purchase_order",
"reference_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference_no": "REF-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reason_code": "REA-000001",
"device_id": "text",
"operator_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"movement_type":"text","capture_mode":"text"}'DELETE/api/scm/scan-sessions/{id}Delete a scan sessions
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/scan-sessions/{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/scan-sessions/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/scan-sessions/{id}/scanScan
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):
code, itemId, itemNo; scans: [{ code, itemNo, source, itemId, hint, quantity, lotNo, serialNo, binId, uom, expiryDate, unitCost, confidence }]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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/scan" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"value","itemId":"value","itemNo;":"value","itemNo":"value","source":"value"}'POST/api/scm/scan-sessions/{id}/capture-imageCapture image
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):
image*, mediaType, noteResponse
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/capture-image" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"image":"value","mediaType":"value","note":"value"}'POST/api/scm/scan-sessions/{id}/postPost
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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/scan-sessions/{id}/cancelCancel
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):
reason*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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/scm/scan-sessions/{id}/exportExport
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):
wmsSystemIdResponse
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"wmsSystemId":"value"}'GET/api/scm/scan-sessions/{parentId}/eventsEvents
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/scan-sessions/{parentId}/eventsEvents
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/scan-sessions/{parentId}/events/{lineId}Events
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/scan-sessions/{parentId}/events/{lineId}Events
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/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a scan sessions, 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 |
session_no | text | read only | Session no |
movement_type | text | read, write | Movement |
capture_mode | text | read, write | Captured by |
warehouse_id | uuid | read, write | Warehouse |
bin_id | uuid | read, write | Bin — Where the goods are, or are coming from. |
to_bin_id | uuid | read, write | Destination bin — Transfers and put-aways only. |
reference_type | text | read, write | Against what Allowed: purchase_order delivery work_order asn wms none |
reference_id | uuid | read, write | Reference id |
reference_no | text | read, write | Reference number |
supplier_id | uuid | read, write | Supplier — Receipts and returns to vendor. |
reason_code | text | read, write | Reason — Required in spirit for scrapping and returns — it is what the write-off is explained by. |
device_id | text | read, write | Device |
operator_id | uuid | read, write | Operator id |
reader_id | uuid | read, write | RFID reader |
wms_system_id | uuid | read only | Wms system id |
status | text | read only | Status |
scan_count | integer | read only | Scan count |
accepted_count | integer | read only | Accepted count |
rejected_count | integer | read only | Rejected count |
posted_count | integer | read only | Posted count |
total_quantity | numeric | read only | Total quantity |
manual_count | integer | read only | Manual count |
cost_center_id | uuid | read, write | Cost center |
journal_id | uuid | read only | Journal id |
posted_at | timestamp with time zone | read only | Posted at |
posted_by | uuid | read only | Posted by |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
document_date | date | read, write | Document date |
posting_date | date | read, write | Posting date |
delivery_note | text | read, write | Delivery note |
bill_of_lading | text | read, write | Bill of lading |
material_slip | text | read, write | Material slip |
unloading_point | text | read, write | Unloading point |
goods_recipient | text | read, write | Goods recipient |
header_text | text | read, write | Header text |
item_text | text | read, write | Item text |
wbs_element | text | read, write | Wbs element |
gl_account_id | uuid | read, write | Gl account id |
label_printer | text | read, write | Label printer |
label_copies | integer | read, write | Label copies |
reverses_id | uuid | read only | Reverses id |
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 › Movement History 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.