Skip to main content

Booking diary attributes for dock appointments

account_id
integer
required

Stock account ID (owner of the goods)

Example:

1

consignment_reference
string
required

Consignment reference number

direction
enum<string>
required

Direction of goods movement

Available options:
inbound,
outbound
end_time
string<date-time>
required

Booking end time (ISO 8601)

hazardous
boolean
required

Whether the goods are hazardous

location_id
integer
required

Dock location ID (must have available_in_booking_diary enabled)

Example:

100

start_time
string<date-time>
required

Booking start time (ISO 8601)

account_reference
string | null

Account's own reference for this booking

booking_reference
string | null

Booking reference number (auto-generated if not provided)

container_number
string | null

Container number (for container intake type)

haulier
string | null

Haulier/carrier name

intake_type
enum<string> | null

Type of intake

Available options:
container,
part_load,
full_load
notes
string | null

Free text notes

status
enum<string>

Booking status (default: pending)

Available options:
pending,
arrived,
departed,
fail_to_arrive,
cancelled
storage_unit_quantity
integer | null

Expected number of storage units (e.g., pallets)