Skip to content

List booking items

GET /api/bookings/v4/{id}/items

Returns all items associated with a booking.

ParameterTypeRequiredDescription
idintegerYesThe booking ID
Terminal window
curl -X GET \
-H "Api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://www.transdirect.com.au/api/bookings/v4/123456/items

A successful response returns 200 with an array of item objects:

[
{
"id": 1,
"description": "Carton",
"weight": 5,
"length": 40,
"width": 30,
"height": 20,
"quantity": 1
},
{
"id": 2,
"description": "Satchel",
"weight": 2.5,
"length": 25,
"width": 15,
"height": 15,
"quantity": 2
}
]
FieldTypeDescription
idintegerUnique item ID
descriptionstringPackaging type
weightnumberWeight in kilograms
lengthnumberLength in centimetres
widthnumberWidth in centimetres
heightnumberHeight in centimetres
quantityintegerNumber of identical items

The parent booking is only identified by the path ({id}); item objects do not include a booking_id field.

Status codeMeaning
401Unauthorised
404Booking not found or has no items