Skip to main content
GET
Error

Authorizations

x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Path Parameters

orderId
string
required

Response

order details

id
string
required

order id

code
string
required

order sequential code

externalCode
string | null
required

external code

deliveryWindowsType
enum<string>
required

indicates if order has delivery windows by order or product

Available options:
BY_PRODUCT,
BY_ORDER
customerId
string | null
required

customer id

customerCode
string | null
required

customer code

salesRepresentativeCode
string | null
required

sales representative code

status
enum<string>
required

order status

Available options:
DRAFT,
IN_REVISION,
ON_APPROVAL,
APPROVED,
SENT,
CANCELED,
ABANDONED,
REJECTED,
SUGGESTED
type
enum<string>
required

order type

Available options:
PRE_ORDER,
READY_FOR_DELIVERY,
BOTH
subTotal
number
required

order subtotal

totalDiscount
number
required

order discount

totalCharges
number
required

order total charges

totalShippingCostValue
number
required

order total shipping cost

totalValue
number
required

order total value

totalPieces
number
required

order total pieces: sum of all pieces

totalItems
number
required

order total items: its calculated by group of [product - color - availability - delivery window]

synchronizedStatus
enum<string>
required

order synchronization status

Available options:
SUCCESS,
SUCCESS_RESET,
ERROR,
NOT_SYNCHRONIZED,
PROCESSING,
PROCESSING_AFTER_RESET,
SUCCESS_WITH_PAYMENT_ERROR
createdAt
string
required

order creation date

updatedAt
string
required

order last update date

maxChangedDate
string
required

order or relations max changed date

observation
string | null
required

order description

archived
boolean
required

order archived

priceTableCode
string | null
required

price table code

items
object[]
required

order items

conditions
object[]
required

order conditions

splitSettings
object[]
required

order split settings

gatewayPayments
object[]
required

gateway payments

sellerEmail
string | null

seller email

priceComposition
object[]

price composition

consultantCode
string | null

consultant code

consultantName
string | null

consultant name