Guides API reference

Search…⌘K

Open navigation

SchemasStoreStatus

HPOS 2 APIClose navigation

Guides API reference

Connection

GETCheck the key and read the connection's state
GETRead the webhook URL and the dates of the active secrets
PUTSet or change the webhook URL
POSTGet a new signing secret

Orders

POSTCreate an order
GETRead an order's status
POSTCancel an order
POSTCourier update, for orders with your own courier

Webhooks

EVENTThe restaurant accepted an order
EVENTThe order is ready
EVENTThe restaurant completed the order
EVENTThe restaurant rejected the order
EVENTThe order was cancelled, by the restaurant or by you
EVENTThe menu file was written
EVENTThe restaurant started or stopped taking orders through this connection
EVENTThe restaurant deleted the connection

Schemas

Menu file
ErrorBody
ErrorCode
WebhookEnvelope

↑↓select↵openescclose

Schemas

StoreStatus

View as Markdown

StoreStatusstringStoreStatus

online while the restaurant takes orders through this connection

Allowed values

onlineoffline

Example

"online"