Skip to content

Update a booking item

PUT
/api/v5/bookings/{id}/items/{item_id}

Updates the given item line (description, weight in kg, dimensions in cm, quantity); omitted fields keep their existing value. Recalculates the booking total weight. Requires an API key and booking ownership. Not permitted on Multipick bookings.

item_id
required
string
/^\d+$/
Example
123

Numeric ID of the item line within the booking.

id
required
string

The booking ID.

object
description

Package type or contents description (e.g. “Carton”).

string
nullable >= 1 characters
weight

Item weight in kg.

number
length

Item length in cm.

number
width

Item width in cm.

number
height

Item height in cm.

number
quantity

Number of identical items of these dimensions.

integer
id

Existing booking item id to update; omit to add a new item.

integer

Booking item

object
id
required

Booking item identifier.

number
description
required

Package type or contents description.

string
weight
required

Item weight in kg.

number
length
required

Item length in cm.

number
width
required

Item width in cm.

number
height
required

Item height in cm.

number
quantity
required

Number of identical items of these dimensions.

number

Invalid item mutation

object
error

Single error message describing the failure.

string
errors
Any of:
string

Missing or invalid API key

Item not found

object
error

Single error message describing the failure.

string
errors
Any of:
string