Skip to content

Generate a signed public label URL

GET
/api/v5/bookings/{id}/public_url
id
required
string
/^\d+$/
Example
623630

Signed public label URL

object
success
required

Always true when the public URL was generated.

boolean
url
required

Temporary public URL for the booking document/label.

string
expires_at
required

ISO 8601 timestamp after which the URL stops working.

string

Label not ready or collection-point state incomplete

object
error
required

Error code or short reason the document could not be produced.

string
message

Human-readable explanation of the error.

string
booking_id

Booking the document request related to.

number
status

Booking status at the time of the error.

string

Missing or invalid API key

Booking not found