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

Order ID

Pattern: ^\d+$
checkoutId
string

The checkout's draft order ID; orders.get finds the order once it is placed

Pattern: ^\d+$

Response

200 - application/json

OK

orderId
string
required

Order ID

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

The Arcade order code; null when there is none

orderNumber
string
required

Display name, e.g. "#1042"

status
enum<string>
required

Derived from the makers' fulfillment and any refunds

Available options:
ordered,
cadReview,
sampleReview,
inProduction,
inReview,
inCorrection,
approved,
updatedInfo,
shipped,
delivered,
fulfilled,
refunded
placedAt
string<date-time>
required
total
object
required
itemCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
imageUrl
string<uri> | null
required

Short-lived; read again to renew. Host not guaranteed.

lines
object[]
required
subtotal
object | null
required
shipping
object | null
required
tax
object | null
required
volumeDiscount
object | null
required

The makers' volume discount

discounts
object | null
required

Other discounts, excluding the volume discount

shippingAddress
object | null
required
tracking
object[]
required

Tracking of the shipments made so far

refunds
object[]
required