Supply Chain · Warehouse Structure
Dock Doors
Where a vehicle meets the building. A real constraint: two trailers cannot be on one door, and a load whose door is occupied is a load that will not leave on time.
/api/scm/warehouse-doorsPublished as /api/v1/warehouse-doorsOverview
| 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 › Dock Doors 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.warehouse_doors · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/warehouse-doorsList dock doors
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"door_type": "inbound",
"dock_type": "dock_leveler",
"max_vehicle_length_mm": "1250.00",
"has_dock_lock": true,
"is_refrigerated": true,
"staging_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"x_mm": "1250.00",
"y_mm": "1250.00",
"status": "available"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/warehouse-doors?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/warehouse-doors/{id}Read one dock door
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"door_type": "inbound",
"dock_type": "dock_leveler",
"max_vehicle_length_mm": "1250.00",
"has_dock_lock": true,
"is_refrigerated": true,
"staging_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"x_mm": "1250.00",
"y_mm": "1250.00",
"status": "available"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/warehouse-doors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/warehouse-doorsCreate a dock door
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
code | text | Yes | Door |
name | text | Yes | Name |
door_type | text | No | Used for Allowed: inbound outbound both cross_dock |
dock_type | text | No | Dock type Allowed: dock_leveler ground_level ramp rail side_load other |
max_vehicle_length_mm | numeric | No | Longest vehicle (mm) |
has_dock_lock | boolean | No | Has a dock lock |
is_refrigerated | boolean | No | Refrigerated |
staging_area_id | uuid | No | Stages to |
x_mm | numeric | No | X on the map (mm) |
y_mm | numeric | No | Y on the map (mm) |
status | text | No | Status Allowed: available occupied reserved maintenance closed |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"door_type": "inbound",
"dock_type": "dock_leveler",
"max_vehicle_length_mm": "1250.00",
"has_dock_lock": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"door_type": "inbound",
"dock_type": "dock_leveler",
"max_vehicle_length_mm": "1250.00",
"has_dock_lock": true,
"is_refrigerated": true,
"staging_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"x_mm": "1250.00",
"y_mm": "1250.00",
"status": "available"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/warehouse-doors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","door_type":"inbound","dock_type":"dock_leveler","max_vehicle_length_mm":"1250.00","has_dock_lock":true}'PUT/api/scm/warehouse-doors/{id}Change a dock door
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 |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
code | text | Yes | Door |
name | text | Yes | Name |
door_type | text | No | Used for Allowed: inbound outbound both cross_dock |
dock_type | text | No | Dock type Allowed: dock_leveler ground_level ramp rail side_load other |
max_vehicle_length_mm | numeric | No | Longest vehicle (mm) |
has_dock_lock | boolean | No | Has a dock lock |
is_refrigerated | boolean | No | Refrigerated |
staging_area_id | uuid | No | Stages to |
x_mm | numeric | No | X on the map (mm) |
y_mm | numeric | No | Y on the map (mm) |
status | text | No | Status Allowed: available occupied reserved maintenance closed |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"door_type": "inbound",
"dock_type": "dock_leveler",
"max_vehicle_length_mm": "1250.00",
"has_dock_lock": true,
"is_refrigerated": true,
"staging_area_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"x_mm": "1250.00",
"y_mm": "1250.00",
"status": "available"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/warehouse-doors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001"}'DELETE/api/scm/warehouse-doors/{id}Delete a dock door
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/warehouse-doors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/warehouse-doors/{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/warehouse-doors/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 dock door, 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 |
org_unit_id | uuid | read only | Org unit id |
warehouse_id | uuid | read, write | Warehouse |
code | text | read, write | Door |
name | text | read, write | Name |
door_type | text | read, write | Used for Allowed: inbound outbound both cross_dock |
dock_type | text | read, write | Dock type Allowed: dock_leveler ground_level ramp rail side_load other |
max_vehicle_length_mm | numeric | read, write | Longest vehicle (mm) |
has_dock_lock | boolean | read, write | Has a dock lock |
is_refrigerated | boolean | read, write | Refrigerated |
staging_area_id | uuid | read, write | Stages to |
x_mm | numeric | read, write | X on the map (mm) |
y_mm | numeric | read, write | Y on the map (mm) |
status | text | read, write | Status Allowed: available occupied reserved maintenance closed |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
max_pallets | integer | read only | Max pallets |
handles_hazmat | boolean | read only | Handles hazmat |
bookable_by_carriers | boolean | read only | Bookable by carriers |
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 › Dock Doors 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.