Update Order
Update specific fields of an existing order.
Modifiable fields:
reference_idis_criticalcodnumber_of_packagesdescriptionnotesreturn_reason
Important:
- You cannot modify the order once it reaches a terminal state:
DELIVERED,DELIVERED_AT_WAREHOUSE, orCANCELLED. - Attempts to update any other fields will result in a 400 error.
Authorizations
Path Parameters
Body
Reference ID of the order, for internal tracking by the shop.
Mark the order as critical for prioritized handling.
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'.
2 elementsNumber of packages in the order.
Optional description of the order contents.
Customer-visible notes about the order.
Applicable if the order is a return. Reason for the return.
Response
Successful patch
Delivery fees charged on the delivery operation. Irrelevant in case of RETURN orders.
2 elementsCREATED- CreatedPICKUP_REQUESTED- Pickup RequestedPICKUP_ASSIGNED- Pickup AssignedSCANNED_FOR_PICKUP- Scanned for PickupPICKED_UP- Picked UpAT_WAREHOUSE- At WarehouseDELIVERY_ASSIGNED- Delivery AssignedSCANNED_FOR_DELIVERY- Scanned For DeliveryPICKED_UP_FOR_DELIVERY- Picked Up For DeliveryIN_TRANSIT- In TransitDELIVERED- DeliveredAWAITING_RETURN- Awaiting ReturnCANCELLED- CancelledDELIVERED_AT_WAREHOUSE- Delivered At Warehouse
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 40^([A-Za-z0-9]|\.|-)*$STANDARD- StandardRETURN- Return
STANDARD, RETURN Total amount to be collected upon delivery. Example: [['USD', '123.5']]
2 elements1 <= x <= 99300300