POS Health check

Purpose

For certain channels, they require a verification that a store's POS is able to accept orders to mitigate the risk of failed order injection.

A POS can support this by reporting the live status of the POS to Deliverect, where an absence of reports signals an outage.

Only POS Health Status
This endpoint only updates the status of the in-store POS to verify if it is online and accepting orders, it is unrelated order statuses

Format

  • Call this endpoint every 10 minutes per location.
  • Apply jitter so that locations don't all report on the same minute.
  • A location is considered no longer ready if there have been no readiness updates and no other successful POS interaction for 30 minutes (two missed heartbeats).

Request Parameters

FieldTypeDescription
statusstringonline - store's POS is online and able to accept orders

offline - means the POS is shutting down or cannot accept orders. Deliverect marks the location as not ready immediately, rather than waiting for silence to time it out.

NB: If the status field is missing, it is treated as online.


Path Params
string
required
Body Params
string
required
Responses

403

Not allowed to access this location

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