Skip to main content
GET
Retrieve order details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orderId
string
required

ID of the order to query. Example: '0000012194-081101'

Response

Order details

orderId
string

Unique order ID

accountId
string

ID of the account that placed the order

account
string

Account name

source
string

Source of the order, e.g., App or Kiosco

platform
string

Platform used to place the order, e.g., Android, iOS

createdAt
string<date-time>

Order creation timestamp

channelId
string

Channel ID of the order

channelName
string

Channel name of the order

selectedShippingMethod
string

Selected shipping method, e.g., delivery or pickup

accumulatePoints
boolean

Whether the order accumulates loyalty points

redeemPoints
boolean

Whether the order redeems loyalty points

stock
boolean

Indicates if stock is available

discount
boolean

Indicates if a discount was applied

orderComment
string

General comment on the order

client
object

Information about the client

store
object

Store details where the order was placed

order
object
shippingMethod
object
payments
object
marketing
object
additionalInfo
object