Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
Orders · Get an order
API reference / Orders

Get an order

GET/api/v1/orders/:idorders:read

One order with its customer, merchant, lines and currency.

Path parameters

idintegerrequired

The order's ID.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

The order. status says where it is and kind what it is (1 online, 2 cart, 3 subscription, 4 invoice, 5 offline).

statusMeaning
1pending: waiting for the customer to pay.
2error: the payment failed.
3paid: orders.paid has been sent.
32partial: part of the total is paid.
4confirmed: the merchant accepted it.
5cancelled.
6prepared: ready to ship or collect.
7shipped.
8delivered.
9completed: delivered and confirmed.
10returned.
11refunded.
12verifying: the merchant is checking it.
13stale: pending for too long.
14archived.

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.
200result: false: there's no such object, or it isn't yours.