Skip to main content
PATCH
/
v1
/
orders
/
{orderId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "code": "<string>",
  "externalCode": {},
  "deliveryWindowsType": "BY_PRODUCT",
  "customerId": {},
  "customerCode": {},
  "salesRepresentativeCode": {},
  "sellerEmail": {},
  "status": "DRAFT",
  "type": "PRE_ORDER",
  "subTotal": 123,
  "totalDiscount": 123,
  "totalCharges": 123,
  "totalShippingCostValue": 123,
  "totalValue": 123,
  "totalPieces": 123,
  "totalItems": 123,
  "synchronizedStatus": "SUCCESS",
  "createdAt": "<string>",
  "maxChangedDate": "<string>",
  "observation": {},
  "archived": true,
  "consultantCode": {},
  "consultantName": {},
  "priceTableCode": {},
  "priceComposition": [
    {
      "id": "<string>",
      "label": "<string>",
      "price": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

orderId
string
required

Body

application/json
archived
boolean

Response

update order

id
string
required

order id

code
string
required

order sequential code

externalCode
object
required

external code

deliveryWindowsType
enum<string>
required

indicates if order has delivery windows by order or product

Available options:
BY_PRODUCT,
BY_ORDER
customerId
object
required

customer id

customerCode
object
required

customer code

salesRepresentativeCode
object
required

sales representative code

sellerEmail
object
required

seller email

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
createdAt
string
required

order creation date

maxChangedDate
string
required

order or relations max changed date

observation
object
required

order description

archived
boolean
required

order archived

consultantCode
object
required

consultant code

consultantName
object
required

consultant name

priceTableCode
object
required

price table code

priceComposition
object[]

price composition