Skip to main content
PATCH
Update Order

Authorizations

X-Api-Key
string
header
required

Path Parameters

order_id
integer
required

Body

reference_id
string

Reference ID of the order, for internal tracking by the shop.

is_critical
boolean

Mark the order as critical for prioritized handling.

cod
string[][]

Cash-on-delivery amount to collect upon delivery in case of STANDARD delivery, or to be paid by shop on return for RETURN orders.Format: [['USD', '123.5']].

Can only be modified if:

  • Workflow is 'STANDARD', or
  • Workflow is 'RETURN' and the delivery state is 'CREATED'.
Required array length: 2 elements
number_of_packages
integer

Number of packages in the order.

description
string

Optional description of the order contents.

notes
string

Customer-visible notes about the order.

return_reason
string

Applicable if the order is a return. Reason for the return.

Response

Successful patch

order_id
string | null
required
read-only
resolved_customer
object
required
resolved_customer_location
object
required
merchant_location
integer
required
delivery_fee
string[][]
required
read-only

Delivery fees charged on the delivery operation. Irrelevant in case of RETURN orders.

Required array length: 2 elements
delivery_state
enum<string>
required
  • CREATED - Created
  • PICKUP_REQUESTED - Pickup Requested
  • PICKUP_ASSIGNED - Pickup Assigned
  • SCANNED_FOR_PICKUP - Scanned for Pickup
  • PICKED_UP - Picked Up
  • AT_WAREHOUSE - At Warehouse
  • DELIVERY_ASSIGNED - Delivery Assigned
  • SCANNED_FOR_DELIVERY - Scanned For Delivery
  • PICKED_UP_FOR_DELIVERY - Picked Up For Delivery
  • IN_TRANSIT - In Transit
  • DELIVERED - Delivered
  • AWAITING_RETURN - Awaiting Return
  • CANCELLED - Cancelled
  • DELIVERED_AT_WAREHOUSE - Delivered At Warehouse
Available options:
CREATED,
PICKUP_REQUESTED,
PICKUP_ASSIGNED,
SCANNED_FOR_PICKUP,
PICKED_UP,
AT_WAREHOUSE,
DELIVERY_ASSIGNED,
SCANNED_FOR_DELIVERY,
PICKED_UP_FOR_DELIVERY,
IN_TRANSIT,
DELIVERED,
AWAITING_RETURN,
CANCELLED,
DELIVERED_AT_WAREHOUSE
payment_state
string
required
read-only
merchant_invoice
integer | null
required
read-only
reference_id
string
Maximum string length: 40
Pattern: ^([A-Za-z0-9]|\.|-)*$
is_exchange
boolean
workflow
enum<string>
  • STANDARD - Standard
  • RETURN - Return
Available options:
STANDARD,
RETURN
is_critical
boolean
cod
string[][]

Total amount to be collected upon delivery. Example: [['USD', '123.5']]

Required array length: 2 elements
number_of_packages
integer
Required range: 1 <= x <= 99
description
string
Maximum string length: 300
notes
string
return_reason
string
Maximum string length: 300