Supply Chain · Warehouse Systems
WMS Connections
Another system already runs the warehouse. Map its field names to these and its movements arrive as scan sessions — no code changes to take another one on.
/api/scm/wms-systemsPublished as /api/v1/wms-systemsDownload specification (OpenAPI 3.1) Screen: WMS Connections
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 › WMS Connections 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.wms_systems · 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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/wms-systemsList wms connections
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",
"code": "COD-000001",
"name": "Example",
"vendor": "text",
"system_type": "wms",
"direction": "inbound",
"payload_format": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unknown_item_policy": "reject",
"auto_post": true,
"status": "draft",
"message_count": 10,
"error_count": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/wms-systems?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/wms-systems/{id}Read one wms systems
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",
"code": "COD-000001",
"name": "Example",
"vendor": "text",
"system_type": "wms",
"direction": "inbound",
"payload_format": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unknown_item_policy": "reject",
"auto_post": true,
"status": "draft",
"message_count": 10,
"error_count": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/wms-systemsCreate a wms systems
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | System code |
name | text | Yes | Name |
vendor | text | No | Vendor |
system_type | text | No | Type Allowed: wms wcs tms 3pl erp mes other |
direction | text | No | Direction Allowed: inbound outbound bidirectional |
payload_format | text | No | Payload format |
connection_id | uuid | No | Platform connection — Reuses the cross-application integration record rather than keeping a second set of credentials. |
warehouse_id | uuid | No | Warehouse |
unknown_item_policy | text | No | When the item is unknown Allowed: reject hold create |
auto_post | boolean | No | Post its movements automatically — Only for a system trusted to be right: the movement hits the ledger with nobody looking. |
status | text | No | Status Allowed: draft configured active error disabled |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example",
"vendor": "text",
"system_type": "wms",
"direction": "inbound",
"payload_format": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"vendor": "text",
"system_type": "wms",
"direction": "inbound",
"payload_format": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unknown_item_policy": "reject",
"auto_post": true,
"status": "draft",
"message_count": 10,
"error_count": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/wms-systems" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","vendor":"text","system_type":"wms","direction":"inbound","payload_format":"text"}'PUT/api/scm/wms-systems/{id}Change a wms systems
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 |
|---|---|---|---|
code | text | Yes | System code |
name | text | Yes | Name |
vendor | text | No | Vendor |
system_type | text | No | Type Allowed: wms wcs tms 3pl erp mes other |
direction | text | No | Direction Allowed: inbound outbound bidirectional |
payload_format | text | No | Payload format |
connection_id | uuid | No | Platform connection — Reuses the cross-application integration record rather than keeping a second set of credentials. |
warehouse_id | uuid | No | Warehouse |
unknown_item_policy | text | No | When the item is unknown Allowed: reject hold create |
auto_post | boolean | No | Post its movements automatically — Only for a system trusted to be right: the movement hits the ledger with nobody looking. |
status | text | No | Status Allowed: draft configured active error disabled |
notes | text | No | Notes |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"vendor": "text",
"system_type": "wms",
"direction": "inbound",
"payload_format": "text",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"unknown_item_policy": "reject",
"auto_post": true,
"status": "draft",
"message_count": 10,
"error_count": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/wms-systems/{id}Delete a wms systems
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/wms-systems/{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/wms-systems/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/wms-systems/{id}/preview-mappingPreview mapping
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):
records, recordResponse
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview-mapping" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"records":"value","record":"value"}'POST/api/scm/wms-systems/{id}/inboundInbound
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):
movementType, externalRef, records*; movementType one of goods_receipt|goods_issue|transfer|physical_inventory|cycle_count|scrap|return_to_vendor|put_away|pick|initial_stockResponse
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/inbound" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"movementType":"value","externalRef":"value","records":"value"}'GET/api/scm/wms-systems/{parentId}/mappingsMappings
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/wms-systems/{parentId}/mappingsMappings
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/wms-systems/{parentId}/mappings/{lineId}Mappings
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/wms-systems/{parentId}/mappings/{lineId}Mappings
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/wms-systems/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a wms systems, 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 |
code | text | read, write | System code |
name | text | read, write | Name |
vendor | text | read, write | Vendor |
system_type | text | read, write | Type Allowed: wms wcs tms 3pl erp mes other |
direction | text | read, write | Direction Allowed: inbound outbound bidirectional |
payload_format | text | read, write | Payload format |
connection_id | uuid | read, write | Platform connection — Reuses the cross-application integration record rather than keeping a second set of credentials. |
warehouse_id | uuid | read, write | Warehouse |
unknown_item_policy | text | read, write | When the item is unknown Allowed: reject hold create |
auto_post | boolean | read, write | Post its movements automatically — Only for a system trusted to be right: the movement hits the ledger with nobody looking. |
status | text | read, write | Status Allowed: draft configured active error disabled |
message_count | integer | read only | Message count |
error_count | integer | read only | Error count |
last_message_at | timestamp with time zone | read only | Last message at |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit 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 › WMS Connections 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.