Skip to main content
POST
Retrieve an order

Authorizations

Authorization
string
header
required

An API key from Settings → API keys in Arcade Studio.

Body

application/json
orderId
string

The order's ID.

Pattern: ^\d+$
checkoutId
string

The checkout's ID. After payment, pass it to orders/get to find the order.

Pattern: ^\d+$

Response

200 - application/json

OK

orderId
string
required

The order's ID.

Pattern: ^\d+$
orderCode
string | null
required

The Arcade order code. Null when the order has none.

orderNumber
string
required

The order number to show people, such as "#1042".

status
enum<string>
required

Where the order stands, based on the makers' progress and any refunds.

Available options:
ordered,
cadReview,
sampleReview,
inProduction,
inReview,
inCorrection,
approved,
updatedInfo,
shipped,
delivered,
fulfilled,
refunded
placedAt
string<date-time>
required

When the order was placed.

total
object
required

The order's total.

itemCount
integer
required

How many units the order holds.

Required range: -9007199254740991 <= x <= 9007199254740991
imageUrl
string<uri> | null
required

URL of the image. It expires; call the endpoint again for a fresh one. The host can change.

lines
object[]
required

The products in the order.

subtotal
object | null
required

The total of the lines, before shipping and tax.

shipping
object | null
required

The shipping cost.

tax
object | null
required

The tax.

volumeDiscount
object | null
required

The makers' volume discount.

discounts
object | null
required

Other discounts, not counting the volume discount.

shippingAddress
object | null
required

Where the order ships. Null when there is no address.

tracking
object[]
required

Tracking for each shipment sent so far.

refunds
object[]
required

Refunds made on the order.