TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Warehouse

Dimensions, packing, putaway and picking — what the physical handling of the thing needs to know, as distinct from what planning needs.

Type REST6 operationsBase path /api/scm/item-wmsPublished as /api/v1/item-wms

Download specification (OpenAPI 3.1) Screen: Item · Warehouse

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 › Item · Warehouse 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.item_wms · 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

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

GET/api/scm/item-wmsList item · warehouse

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",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "length_mm": "1250.00",
      "width_mm": "1250.00",
      "height_mm": "1250.00",
      "gross_weight_kg": "1250.00",
      "net_weight_kg": "1250.00",
      "volume_cm3": "1250.00",
      "units_per_case": "1250.00",
      "cases_per_layer": "1250.00",
      "layers_per_pallet": "1250.00",
      "units_per_pallet": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00",
  "width_mm": "1250.00",
  "height_mm": "1250.00",
  "gross_weight_kg": "1250.00",
  "net_weight_kg": "1250.00",
  "volume_cm3": "1250.00",
  "units_per_case": "1250.00",
  "cases_per_layer": "1250.00",
  "layers_per_pallet": "1250.00",
  "units_per_pallet": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
warehouse_iduuidNoWarehouse (leave empty for all)
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
gross_weight_kgnumericNoGross weight (kg)
net_weight_kgnumericNoNet weight (kg)
volume_cm3numericNoVolume cm3
units_per_casenumericNoUnits per case
cases_per_layernumericNoCases per layer
layers_per_palletnumericNoLayers per pallet
units_per_palletnumericNoUnits per pallet
pallet_typetextNoPallet type
is_stackablebooleanNoStackable
max_stack_heightintegerNoMax stack height
putaway_ruletextNoPutaway rule
Allowed: default fixed nearest consolidate by_velocity by_zone manual
pick_ruletextNoPick rule
Allowed: fifo lifo fefo nearest by_lot by_serial manual
pick_uomtextNoPick uom
velocity_classtextNoVelocity
Allowed: fast medium slow dead
storage_zonetextNoStorage zone
requires_temperature_controlbooleanNoTemperature controlled
min_temperature_cnumericNoMinimum °C
max_temperature_cnumericNoMaximum °C
requires_humidity_controlbooleanNoRequires humidity control
is_fragilebooleanNoFragile
is_high_valuebooleanNoHigh value — secure storage
handling_notestextNoHandling notes
requires_scan_on_receiptbooleanNoMust be scanned on receipt
requires_scan_on_pickbooleanNoMust be scanned on pick
gtintextNoGTIN
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

{
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00",
  "width_mm": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00",
  "width_mm": "1250.00",
  "height_mm": "1250.00",
  "gross_weight_kg": "1250.00",
  "net_weight_kg": "1250.00",
  "volume_cm3": "1250.00",
  "units_per_case": "1250.00",
  "cases_per_layer": "1250.00",
  "layers_per_pallet": "1250.00",
  "units_per_pallet": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/item-wms" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","length_mm":"1250.00","width_mm":"1250.00"}'
PUT/api/scm/item-wms/{id}Change a item wms

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
item_iduuidYesItem
org_unit_iduuidNoApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
warehouse_iduuidNoWarehouse (leave empty for all)
length_mmnumericNoLength (mm)
width_mmnumericNoWidth (mm)
height_mmnumericNoHeight (mm)
gross_weight_kgnumericNoGross weight (kg)
net_weight_kgnumericNoNet weight (kg)
volume_cm3numericNoVolume cm3
units_per_casenumericNoUnits per case
cases_per_layernumericNoCases per layer
layers_per_palletnumericNoLayers per pallet
units_per_palletnumericNoUnits per pallet
pallet_typetextNoPallet type
is_stackablebooleanNoStackable
max_stack_heightintegerNoMax stack height
putaway_ruletextNoPutaway rule
Allowed: default fixed nearest consolidate by_velocity by_zone manual
pick_ruletextNoPick rule
Allowed: fifo lifo fefo nearest by_lot by_serial manual
pick_uomtextNoPick uom
velocity_classtextNoVelocity
Allowed: fast medium slow dead
storage_zonetextNoStorage zone
requires_temperature_controlbooleanNoTemperature controlled
min_temperature_cnumericNoMinimum °C
max_temperature_cnumericNoMaximum °C
requires_humidity_controlbooleanNoRequires humidity control
is_fragilebooleanNoFragile
is_high_valuebooleanNoHigh value — secure storage
handling_notestextNoHandling notes
requires_scan_on_receiptbooleanNoMust be scanned on receipt
requires_scan_on_pickbooleanNoMust be scanned on pick
gtintextNoGTIN
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "length_mm": "1250.00",
  "width_mm": "1250.00",
  "height_mm": "1250.00",
  "gross_weight_kg": "1250.00",
  "net_weight_kg": "1250.00",
  "volume_cm3": "1250.00",
  "units_per_case": "1250.00",
  "cases_per_layer": "1250.00",
  "layers_per_pallet": "1250.00",
  "units_per_pallet": "1250.00"
}

Sample request

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

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/item-wms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/item-wms/{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/item-wms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a item wms, 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
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants.
warehouse_iduuidread, writeWarehouse (leave empty for all)
length_mmnumericread, writeLength (mm)
width_mmnumericread, writeWidth (mm)
height_mmnumericread, writeHeight (mm)
gross_weight_kgnumericread, writeGross weight (kg)
net_weight_kgnumericread, writeNet weight (kg)
volume_cm3numericread, writeVolume cm3
units_per_casenumericread, writeUnits per case
cases_per_layernumericread, writeCases per layer
layers_per_palletnumericread, writeLayers per pallet
units_per_palletnumericread, writeUnits per pallet
pallet_typetextread, writePallet type
is_stackablebooleanread, writeStackable
max_stack_heightintegerread, writeMax stack height
putaway_ruletextread, writePutaway rule
Allowed: default fixed nearest consolidate by_velocity by_zone manual
pick_ruletextread, writePick rule
Allowed: fifo lifo fefo nearest by_lot by_serial manual
pick_uomtextread, writePick uom
velocity_classtextread, writeVelocity
Allowed: fast medium slow dead
storage_zonetextread, writeStorage zone
requires_temperature_controlbooleanread, writeTemperature controlled
min_temperature_cnumericread, writeMinimum °C
max_temperature_cnumericread, writeMaximum °C
requires_humidity_controlbooleanread, writeRequires humidity control
is_fragilebooleanread, writeFragile
is_high_valuebooleanread, writeHigh value — secure storage
handling_notestextread, writeHandling notes
requires_scan_on_receiptbooleanread, writeMust be scanned on receipt
requires_scan_on_pickbooleanread, writeMust be scanned on pick
gtintextread, writeGTIN
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
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 › Item · Warehouse 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.