try out ↗

← API Index


/api/client/state1

Polling endpoint: client passes a known order id (with its last-changed timestamp) OR a delivery date and tour id, server tells whether the order / date is still actionable.

Change Note: add age indication

Parameters

Name Description Type
oid order id to check; if given, lastchanged is also required (oid branch) int
lastchanged iso8601 timestamp of the last order change known to the client (required with oid) date
tid tour id to check (required for the date branch) int
ddate iso8601 delivery date to check (required for the date branch) date
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
OrderState 1 Polling result that tells whether a specific order or a specific delivery date is still actionable for the client. Can be used by shops to decide if a stale (old, modified) cart needs to reload data (a order may have changes on server side). For a complete overview about possible dates and orders, use the dates endpoint.

OpenAPI

See state1.yaml

Referenced in skills