CAcabify
parcels

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.

post/v1/parcels/{parcel_id}/notify

Request

  • Base URL
    https://logistics.api.cabify-sandbox.com
  • URL
    https://logistics.api.cabify-sandbox.com/v1/parcels/{parcel_id}/notify
  • Auth
    HTTP bearer

Path parameters

parcel_idstring uuid required

UUID of the parcel to notify an event for.

Request body

event'ready_to_pickup' 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.

Example request

{
  "event": "ready_to_pickup"
}

Response

Event accepted and queued for processing.

Changes

No recorded changes to this operation across all 1 revision of this API.