Skip to content

List booking items

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

Returns all items associated with a booking. Each item represents a parcel or package within the 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 a 200 status code with an array of item objects.

[
{
"id": 1,
"booking_id": 123456,
"weight": 5,
"height": 20,
"width": 30,
"length": 40,
"quantity": 1,
"description": "Electronics"
},
{
"id": 2,
"booking_id": 123456,
"weight": 2.5,
"height": 15,
"width": 15,
"length": 25,
"quantity": 2,
"description": "Books"
}
]
FieldTypeDescription
idintegerUnique item ID
booking_idintegerThe parent booking ID
weightnumberWeight in kilograms
heightnumberHeight in centimetres
widthnumberWidth in centimetres
lengthnumberLength in centimetres
quantityintegerNumber of identical items
descriptionstringDescription of the item contents
Status codeMeaning
401Unauthorised — invalid credentials or API key
404Not found — the booking does not exist or does not belong to your account