Supply Chain · Dock Scheduling
Dock Appointments
Carrier bookings of a door and a slot — a gate entry for a delivery: what is coming or going, against which order or notice, how many pallets — and when the truck actually arrived. A door cannot be booked twice for the same time.
/api/scm/dock-appointmentsPublished as /api/v1/dock-appointmentsDownload specification (OpenAPI 3.1) Screen: Dock Appointments
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 › Dock Appointments 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.dock_appointments · 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/dock-appointmentsList dock appointments
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",
"appointment_no": "APP-000001",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "inbound",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"asn_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference": "text",
"pallets": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/dock-appointments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/dock-appointments/{id}Read one dock appointment
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",
"appointment_no": "APP-000001",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "inbound",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"asn_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference": "text",
"pallets": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointmentsCreate a dock appointment
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
reference | text | No | Reference |
pallets | integer | No | Pallets |
trailer_no | text | No | Trailer |
driver_name | text | No | Driver |
driver_phone | text | No | Driver phone |
notes | text | No | Notes |
Sample body
{
"reference": "text",
"pallets": 10,
"trailer_no": "TRA-000001",
"driver_name": "Example"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_no": "APP-000001",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "inbound",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"asn_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference": "text",
"pallets": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/dock-appointments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reference":"text","pallets":10,"trailer_no":"TRA-000001","driver_name":"Example"}'PUT/api/scm/dock-appointments/{id}Change a dock appointment
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 |
|---|---|---|---|
reference | text | No | Reference |
pallets | integer | No | Pallets |
trailer_no | text | No | Trailer |
driver_name | text | No | Driver |
driver_phone | text | No | Driver phone |
notes | text | No | Notes |
Sample body
{
"reference": "text",
"pallets": 10
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_no": "APP-000001",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"door_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "inbound",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_name": "Example",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"asn_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"reference": "text",
"pallets": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reference":"text","pallets":10}'DELETE/api/scm/dock-appointments/{id}Delete a dock appointment
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/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/dock-appointments/slotsSlots
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/dock-appointments/slots" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointments/{id}/check-inCheck in
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-in" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointments/{id}/to-doorTo door
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/to-door" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointments/{id}/check-outCheck out
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-out" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointments/{id}/cancelCancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/dock-appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/dock-appointments/mark-no-showsMark no shows
Request body
The keys this action reads (* = required; "one of" lists the only values):
warehouseIdResponse
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/dock-appointments/mark-no-shows" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouseId":"value"}'POST/api/scm/dock-appointments/{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/dock-appointments/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 appointment, 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 |
appointment_no | text | read only | Appointment no |
warehouse_id | uuid | read only | Warehouse |
door_id | uuid | read only | Door — Leave empty for the first suitable free door. |
direction | text | read only | Direction Allowed: inbound outbound |
carrier_id | uuid | read only | Carrier |
carrier_name | text | read only | Carrier (not on file) |
supplier_id | uuid | read only | Supplier |
po_id | uuid | read only | Purchase order |
asn_id | uuid | read only | Asn id |
shipment_id | uuid | read only | Shipment id |
reference | text | read, write | Reference |
pallets | integer | read, write | Pallets |
needs_reefer | boolean | read only | Needs a refrigerated door |
hazmat | boolean | read only | Hazardous goods |
trailer_no | text | read, write | Trailer |
driver_name | text | read, write | Driver |
driver_phone | text | read, write | Driver phone |
starts_at | timestamp with time zone | read only | Slot starts — On the calendar's grid: the opening time plus whole slots. |
ends_at | timestamp with time zone | read only | Ends at |
status | text | read only | Status |
arrival | text | read only | Arrival |
late_minutes | integer | read only | Late minutes |
checked_in_at | timestamp with time zone | read only | Checked in at |
at_door_at | timestamp with time zone | read only | At door at |
checked_out_at | timestamp with time zone | read only | Checked out at |
yard_movement_id | uuid | read only | Yard movement id |
booked_via | text | read only | Booked via |
portal_user_id | uuid | read only | Portal user id |
cancel_reason | text | read only | Cancel reason |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 Appointments 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.