TRANXACT.AI Help

Supply Chain · Warehouse Execution

Warehouse Tasks

One move: this quantity of this item, from this bin, to that one. Every kind of warehouse work is this shape, which is why there is one list rather than six. Confirming a task is the only thing here that moves stock.

Type REST7 operationsBase path /api/scm/warehouse-tasksPublished as /api/v1/warehouse-tasks

Download specification (OpenAPI 3.1) Screen: Warehouse Tasks

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 › Warehouse Tasks 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.warehouse_tasks · 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

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

GET/api/scm/warehouse-tasksList warehouse tasks

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",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "task_no": "TAS-000001",
      "warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wave_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wave_demand_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "task_type": "text",
      "sequence_no": 10,
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "serial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_no": "TAS-000001",
  "warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_demand_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_type": "text",
  "sequence_no": 10,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/warehouse-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/warehouse-tasksCreate a warehouse task

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
warehouse_iduuidYesWarehouse
warehouse_order_iduuidNoWarehouse order id
wave_iduuidNoWave id
task_typetextNoType
sequence_nointegerNoSequence no
item_iduuidNoItem
hu_iduuidNoHandling unit
lot_notextNoLot
quantitynumericNoQuantity
uom_iduuidNoUnit
from_bin_iduuidNoFrom bin
to_bin_iduuidNoTo bin
from_staging_area_iduuidNoFrom staging area id
to_staging_area_iduuidNoTo staging area id
stock_statustextNoStock status
resource_iduuidNoAssigned to
priorityintegerNoPriority
due_attimestamp with time zoneNoDue
notestextNoNotes

Sample body

{
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_type": "text",
  "sequence_no": 10
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_no": "TAS-000001",
  "warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_demand_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_type": "text",
  "sequence_no": 10,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/warehouse-tasks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","wave_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","task_type":"text","sequence_no":10}'
PUT/api/scm/warehouse-tasks/{id}Change a warehouse task

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
warehouse_iduuidYesWarehouse
warehouse_order_iduuidNoWarehouse order id
wave_iduuidNoWave id
task_typetextNoType
sequence_nointegerNoSequence no
item_iduuidNoItem
hu_iduuidNoHandling unit
lot_notextNoLot
quantitynumericNoQuantity
uom_iduuidNoUnit
from_bin_iduuidNoFrom bin
to_bin_iduuidNoTo bin
from_staging_area_iduuidNoFrom staging area id
to_staging_area_iduuidNoTo staging area id
stock_statustextNoStock status
resource_iduuidNoAssigned to
priorityintegerNoPriority
due_attimestamp with time zoneNoDue
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_no": "TAS-000001",
  "warehouse_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wave_demand_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "task_type": "text",
  "sequence_no": 10,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hu_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000"
}

Sample request

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

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

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

quantity, toBinId, actualMinutes, exceptionCode, exceptionNote

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/warehouse-tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/confirm" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"quantity":"value","toBinId":"value","actualMinutes":"value","exceptionCode":"value","exceptionNote":"value"}'

Data model

Every field of a warehouse task, 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
warehouse_iduuidread, writeWarehouse
task_notextread onlyTask no
warehouse_order_iduuidread, writeWarehouse order id
wave_iduuidread, writeWave id
wave_demand_iduuidread onlyWave demand id
task_typetextread, writeType
sequence_nointegerread, writeSequence no
item_iduuidread, writeItem
hu_iduuidread, writeHandling unit
lot_notextread, writeLot
serial_iduuidread onlySerial id
quantitynumericread, writeQuantity
uom_iduuidread, writeUnit
quantity_stock_uomnumericread onlyQuantity stock uom
quantity_confirmednumericread onlyQuantity confirmed
from_bin_iduuidread, writeFrom bin
to_bin_iduuidread, writeTo bin
from_staging_area_iduuidread, writeFrom staging area id
to_staging_area_iduuidread, writeTo staging area id
stock_statustextread, writeStock status
resource_iduuidread, writeAssigned to
assigned_attimestamp with time zoneread onlyAssigned at
started_attimestamp with time zoneread onlyStarted at
confirmed_attimestamp with time zoneread onlyConfirmed at
confirmed_byuuidread onlyConfirmed by
standard_minutesnumericread onlyStandard minutes
actual_minutesnumericread onlyActual minutes
travel_metersnumericread onlyTravel meters
priorityintegerread, writePriority
due_attimestamp with time zoneread, writeDue
exception_codetextread onlyException code
exception_notetextread onlyException note
short_quantitynumericread onlyShort quantity
inventory_txn_idbigintread onlyInventory txn id
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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 › Warehouse Tasks 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.