Skip to content

Get an item

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

Returns the details of a specific item within a booking.

ParameterTypeRequiredDescription
idintegerYesThe booking ID
item_idintegerYesThe item 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/1

A successful response returns a 200 status code with the item object.

{
"id": 1,
"booking_id": 123456,
"weight": 5,
"height": 20,
"width": 30,
"length": 40,
"quantity": 1,
"description": "Electronics"
}
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 or item does not exist, or does not belong to your account