Skip to main content
GET
Get order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is the account token returned from the Login endpoint.

Path Parameters

orderId
string
required

The public order reference (order_id)

Response

Success

id
string<uuid>
ref
string

Public order reference

email
string<email>
currencyCode
string
items
object[]
subtotal
string
shipping
string
tax
string
discount
string | null
discountCodes
string
pointsRedeemed
integer
pointsDiscount
string | null
total
string
totalRaw
number
status
string
paymentMethod
object | null
paymentStatus
string | null
shippingAddress
object
billingAddress
object
shippingMethod
string | null
tracking
object | null
deliveryInstructions
string | null
giftMessage
string | null
createdAt
string
updatedAt
string
paymentProviders
object

Enabled payment provider configuration (paypal, stripe, payfast) for paying the order