↑↓select↵openescclose

Horeca24 Partner API › Orders

Read an order's status

GEThttps://management.horeca-24.de/api/partner/v1/orders/{externalId}

404 ORDER_NOT_FOUND for an unknown order, another connection's order, or one still being received. cancellation is present after your own cancel.

Headers

AuthorizationstringRequired

Bearer pk_<connectionId>.<keyId>.<secret>

The connection's API key, from the restaurant's till. Treat it as one opaque string. 401 UNAUTHORIZED for a missing, wrong, expired or revoked key; 403 CONNECTION_REVOKED for the key of a deleted connection. After a rotation by the restaurant, the previous key keeps working for 24 hours.

Path parameters

externalIdstringRequiredpattern: ^[A-Za-z0-9._~-]{1,64}$

Your order id, as sent in POST /orders.

Response

200The order's state
orderIdstringRequiredpattern: ^oo_[0-9a-f]{64}$

Our order id

externalIdstringRequiredpattern: ^[A-Za-z0-9._~-]{1,64}$

Your order id, unique per connection

statusstringOrderStatusRequiredinProgressacceptedreadycompletedrejectedcancelled

completed, rejected and cancelled are final

versionintegerRequired≥ 1

1 at receipt; +1 per status change

updatedAtstringRequiredformat: date-time
cancellationobjectOptional

Present after your own cancel

Show child attributesHide child attributes
statusstringRequiredapproved
reasonstringOptional

Errors

objectErrorBody

401

UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

404

An error; see ErrorCode