Skip to navigation
StorefrontOrders

Look Up Order

View as Markdown

Lets a guest check an order with its reference and the email entered at checkout, or with the key from the link in the order email. A wrong pair returns 404 without saying which part was wrong.

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.

Headers

channelstringRequired
client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
referencestringRequired<=15 characters
Order reference from the checkout response or confirmation.
emailstringOptionalformat: "email"<=255 characters

The email entered at checkout. Required unless you send key.

keystringOptional=64 characters

The key from the link in the order email, sent instead of email. When you pass order_url at checkout, the email links there with reference and key in the query string.

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
429
Too Many Requests Error