HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Store Status

webhook
https://yourwebhook.com/store_status

Sends each change when a store opens or closes on a channel.

Purpose

When a store is set to open or closed for online ordering, a webhook event can be sent to a designated endpoint.

Format

Each event lists the status change as it applies per Channel

Status changes can originate from one of three sources:

  • Deliverect: A user deliberately pauses online orders, either from the Deliverect web/mobile app (guide here) or via an integrated use of the Busy Mode endpoint
  • Ordering platform (manual): A user deliberately pauses online orders directly in their online ordering application, outside of Deliverect.
  • Ordering platform (automated): The ordering platform changes the status automatically, for example after a threshold of failed orders is reached.
Payload

Sent by Deliverect as a JSON payload.

storeStatusSyncUpdates
array of objects

Store status changes included in this event.

storeStatusSyncUpdates
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.

Updated 1 day ago

Did this page help you?
LoadingLoading…

Updated 1 day ago

Did this page help you?