Skip to navigation

Get Order

View as Markdown

Returns one of the signed-in shopper’s orders with its lines and current state.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Path parameters

referencestringRequired
The order reference.

Headers

channelstringRequired
shopper-tokenstringRequired

The token returned when the shopper signed in. Treat it as a secret: never put it in a URL or a log.

Response

Successfully fetched order
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error