Update an item
Endpoint
Section titled “Endpoint”PUT /api/bookings/v4/{id}/items/{item_id}Updates the details of an existing item within a booking. You only need to include the fields you want to change.
Path parameters
Section titled “Path parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The booking ID |
item_id | integer | Yes | The item ID |
Request body
Section titled “Request body”| Field | Type | Required | Description |
|---|---|---|---|
weight | number | No | Weight in kilograms |
height | number | No | Height in centimetres |
width | number | No | Width in centimetres |
length | number | No | Length in centimetres |
quantity | integer | No | Number of identical items (minimum 1) |
description | string | No | Description of the item contents |
Request
Section titled “Request”curl -X PUT \ -H "Api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "weight": 7.5, "description": "Updated electronics parcel" }' \ https://www.transdirect.com.au/api/bookings/v4/123456/items/1Response
Section titled “Response”A successful response returns a 200 status code with the updated item.
{ "id": 1, "booking_id": 123456, "weight": 7.5, "height": 20, "width": 30, "length": 40, "quantity": 1, "description": "Updated electronics parcel"}Error responses
Section titled “Error responses”| Status code | Meaning |
|---|---|
400 | Bad request — invalid field values |
401 | Unauthorised — invalid credentials or API key |
404 | Not found — the booking or item does not exist, or does not belong to your account |
422 | Unprocessable entity — validation errors (e.g. weight must be greater than 0) |