Skip to navigation

About the Order API

Order requests behind click & collect and ship-from-store.

View as Markdown

The Order API exposes endpoints for order requests: the orders a customer places in one channel and fulfils through a store.

Endpoints

MethodPathPurpose
POST/orders/v1Save an order to the database
GET/orders/v1Retrieve all unprocessed orders
GET/orders/v1/orderid/{orderId}Retrieve one order request
GET/orders/v1/collectchainnum/{collectchainnum}Unprocessed orders for a chain
GET/orders/v1/collectchainnum/{collectchainnum}/collectstorenum/{collectstorenum}Unprocessed orders for a store
PATCH/orders/v1/orderid/{orderId}/status/{newStatus}Update an order’s status
POST/ordermanagement/v1Order management submission

The collect-side model

The parameters are named collectchainnum and collectstorenum rather than chain and store, and that naming is the point: an order is queried by where it will be collected, not where it was placed.

That is what makes the store-scoped GET the natural poll for a store’s own fulfilment queue. A store asks “what do I need to pick today?” and gets exactly its own unprocessed orders.

Retrieval endpoints return unprocessed orders. Advancing an order’s status with PATCH is what removes it from that queue, so status updates are part of the contract rather than bookkeeping.

Order management

How 52ViKING models order management.

Unified commerce

Where click & collect fits in the wider platform.