Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
order

Order - Modify Status

Update the fulfillment status of one or more orders.

put/order/modify_status

Request body

store_idstring required

Store ID

order_numberstring required

Order number

status'unstarted' | 'in_progress' | 'shipped' | 'cancelled' | 'cleared' | 'delayed' | 'stopped' | 'partially shipped' | 'archived' | 'awaiting fulfillment' | 'pending' | 'partially cleared' required

New status value

refresh_cacheboolean

Refresh cache after update

status_datestring

Date to set for the status change

forceboolean

Force the status change

orderobject

Order reference object

Example request

{
  "store_id": "507f1f77bcf86cd799439011",
  "status_date": "2025-01-15T12:00:00.000Z"
}

Response

Status updated

successboolean required

Whether the operation succeeded