Courier Update

Where delivery platforms provide courier statuses or a 3rd party 'Dispatch' service is enabled, the details of the delivery progress will be sent whenever they change.

Payload

Sent by Deliverect as a JSON payload.

Each event is sent as a single HTTP POST request with a timeout of 20 seconds. Every event is delivered in one attempt, whatever response status is returned, so we recommend acknowledging with a 2xx response straight away and processing the payload asynchronously.

date-time

Timestamp of when the update was generated, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

string

Unique Deliverect order ID.

date-time

The correct pickupTime for the order when the status was generated, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

date-time

The anticipated order delivery time, in the format yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

string

locationId is the unique identifier of a physical restaurant location, store, or kitchen

courier
object

Courier assigned to the delivery and their current progress.

string

Instructions for handing the order to the courier.

string

Passcode the courier presents at pickup, where applicable.

integer
enum

The source from where the update is coming:

  • 2 = Channel
  • 6 = Courier (via Dispatch)
Allowed:
string

Not currently in use; sent empty.

Headers
string
required

Identifies Deliverect as the sender, in the format Deliverect/{version}.

string
required

Signature of the raw request body using your shared secret; recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).

Response
200

Return a 2xx status to acknowledge receipt.

LoadingLoading…