TRANXACT.AI Help

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.

Type REST12 operationsBase path /api/scm/dock-appointmentsPublished as /api/v1/dock-appointments

Download specification (OpenAPI 3.1) Screen: Dock Appointments

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 › 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.
Tablescm.dock_appointments · 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

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

GET/api/scm/dock-appointmentsList dock appointments

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
referencetextNoReference
palletsintegerNoPallets
trailer_notextNoTrailer
driver_nametextNoDriver
driver_phonetextNoDriver phone
notestextNoNotes

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

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
referencetextNoReference
palletsintegerNoPallets
trailer_notextNoTrailer
driver_nametextNoDriver
driver_phonetextNoDriver phone
notestextNoNotes

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

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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):

warehouseId

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/mark-no-shows" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouseId":"value"}'
POST/api/scm/dock-appointments/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
appointment_notextread onlyAppointment no
warehouse_iduuidread onlyWarehouse
door_iduuidread onlyDoor — Leave empty for the first suitable free door.
directiontextread onlyDirection
Allowed: inbound outbound
carrier_iduuidread onlyCarrier
carrier_nametextread onlyCarrier (not on file)
supplier_iduuidread onlySupplier
po_iduuidread onlyPurchase order
asn_iduuidread onlyAsn id
shipment_iduuidread onlyShipment id
referencetextread, writeReference
palletsintegerread, writePallets
needs_reeferbooleanread onlyNeeds a refrigerated door
hazmatbooleanread onlyHazardous goods
trailer_notextread, writeTrailer
driver_nametextread, writeDriver
driver_phonetextread, writeDriver phone
starts_attimestamp with time zoneread onlySlot starts — On the calendar's grid: the opening time plus whole slots.
ends_attimestamp with time zoneread onlyEnds at
statustextread onlyStatus
arrivaltextread onlyArrival
late_minutesintegerread onlyLate minutes
checked_in_attimestamp with time zoneread onlyChecked in at
at_door_attimestamp with time zoneread onlyAt door at
checked_out_attimestamp with time zoneread onlyChecked out at
yard_movement_iduuidread onlyYard movement id
booked_viatextread onlyBooked via
portal_user_iduuidread onlyPortal user id
cancel_reasontextread onlyCancel reason
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Dock Appointments 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.