Notify an event for the given parcel.

Sends an event notification for the specified parcel. Currently, only the ready_to_pickup
event is supported.

This event is typically used in food delivery workflows to signal that an order is prepared
and ready to be collected by a driver.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the parcel to notify an event for.

Body Params

Request body for sending an event notification for a parcel.

string
enum
required

The event to notify. Currently, only ready_to_pickup is supported, which signals that the order is prepared and ready to be collected by a driver.

Allowed:
Responses
202

Event accepted and queued for processing.

429

Too many requests. This API is rate limited per account and per endpoint. A 429 is an expected condition rather than a failed request: back off and retry it. The limits are not the same for every endpoint and can change, so handle the status instead of hard-coding a rate. See the Limits and reliability guide.

500

An unexpected server error occurred.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json