TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/scm/scan-sessionsPublished as /api/v1/scan-sessions

Download specification (OpenAPI 3.1) Screen: Movement History

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 › 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.
Tablescm.scan_sessions · 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

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

GET/api/scm/scan-sessionsList movement history

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
movement_typetextYesMovement
capture_modetextNoCaptured by
warehouse_iduuidNoWarehouse
bin_iduuidNoBin — Where the goods are, or are coming from.
to_bin_iduuidNoDestination bin — Transfers and put-aways only.
reference_typetextNoAgainst what
Allowed: purchase_order delivery work_order asn wms none
reference_iduuidNoReference id
reference_notextNoReference number
supplier_iduuidNoSupplier — Receipts and returns to vendor.
reason_codetextNoReason — Required in spirit for scrapping and returns — it is what the write-off is explained by.
device_idtextNoDevice
operator_iduuidNoOperator id
reader_iduuidNoRFID reader
cost_center_iduuidNoCost center
notestextNoNotes
document_datedateNoDocument date
posting_datedateNoPosting date
delivery_notetextNoDelivery note
bill_of_ladingtextNoBill of lading
material_sliptextNoMaterial slip
unloading_pointtextNoUnloading point
goods_recipienttextNoGoods recipient
header_texttextNoHeader text
item_texttextNoItem text
wbs_elementtextNoWbs element
gl_account_iduuidNoGl account id
label_printertextNoLabel printer
label_copiesintegerNoLabel 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

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
movement_typetextYesMovement
capture_modetextNoCaptured by
warehouse_iduuidNoWarehouse
bin_iduuidNoBin — Where the goods are, or are coming from.
to_bin_iduuidNoDestination bin — Transfers and put-aways only.
reference_typetextNoAgainst what
Allowed: purchase_order delivery work_order asn wms none
reference_iduuidNoReference id
reference_notextNoReference number
supplier_iduuidNoSupplier — Receipts and returns to vendor.
reason_codetextNoReason — Required in spirit for scrapping and returns — it is what the write-off is explained by.
device_idtextNoDevice
operator_iduuidNoOperator id
reader_iduuidNoRFID reader
cost_center_iduuidNoCost center
notestextNoNotes
document_datedateNoDocument date
posting_datedateNoPosting date
delivery_notetextNoDelivery note
bill_of_ladingtextNoBill of lading
material_sliptextNoMaterial slip
unloading_pointtextNoUnloading point
goods_recipienttextNoGoods recipient
header_texttextNoHeader text
item_texttextNoItem text
wbs_elementtextNoWbs element
gl_account_iduuidNoGl account id
label_printertextNoLabel printer
label_copiesintegerNoLabel 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

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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/scan-sessions/{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/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

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):

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

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):

image*, mediaType, note

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/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

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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/scan-sessions/{id}/cancelCancel

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):

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

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):

wmsSystemId

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/export" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"wmsSystemId":"value"}'
GET/api/scm/scan-sessions/{parentId}/eventsEvents

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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/scan-sessions/{parentId}/eventsEvents

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/scm/scan-sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/scan-sessions/{parentId}/events/{lineId}Events

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/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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
session_notextread onlySession no
movement_typetextread, writeMovement
capture_modetextread, writeCaptured by
warehouse_iduuidread, writeWarehouse
bin_iduuidread, writeBin — Where the goods are, or are coming from.
to_bin_iduuidread, writeDestination bin — Transfers and put-aways only.
reference_typetextread, writeAgainst what
Allowed: purchase_order delivery work_order asn wms none
reference_iduuidread, writeReference id
reference_notextread, writeReference number
supplier_iduuidread, writeSupplier — Receipts and returns to vendor.
reason_codetextread, writeReason — Required in spirit for scrapping and returns — it is what the write-off is explained by.
device_idtextread, writeDevice
operator_iduuidread, writeOperator id
reader_iduuidread, writeRFID reader
wms_system_iduuidread onlyWms system id
statustextread onlyStatus
scan_countintegerread onlyScan count
accepted_countintegerread onlyAccepted count
rejected_countintegerread onlyRejected count
posted_countintegerread onlyPosted count
total_quantitynumericread onlyTotal quantity
manual_countintegerread onlyManual count
cost_center_iduuidread, writeCost center
journal_iduuidread onlyJournal id
posted_attimestamp with time zoneread onlyPosted at
posted_byuuidread onlyPosted by
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
document_datedateread, writeDocument date
posting_datedateread, writePosting date
delivery_notetextread, writeDelivery note
bill_of_ladingtextread, writeBill of lading
material_sliptextread, writeMaterial slip
unloading_pointtextread, writeUnloading point
goods_recipienttextread, writeGoods recipient
header_texttextread, writeHeader text
item_texttextread, writeItem text
wbs_elementtextread, writeWbs element
gl_account_iduuidread, writeGl account id
label_printertextread, writeLabel printer
label_copiesintegerread, writeLabel copies
reverses_iduuidread onlyReverses 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 › Movement History 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.