order

Order - Modify Status

Changed on

Update the fulfillment status of one or more orders.

put/order/modify_status

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/order/modify_status
  • Auth
    HTTP bearer

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

log_notestring

Optional note recorded in the order activity log for this status change. Preserved when unarchive is true; if omitted on an unarchive, a default note is recorded.

unarchiveboolean

When true, forces the order out of the archived state: returns it to processing, removes the "Hold - Archived" tag, and flags it to prevent immediate auto re-archiving. Combine with a status (e.g. "unstarted") to restart a previously shipped or archived order.

Example request

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

Response

Status updated

successboolean required

Whether the operation succeeded

Changes

  • 3bf9d805a276Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • fa53dd949b8eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property type changed from string to boolean

    • breaking

      the request property type changed from string to object

    • breaking

      the request property type changed from string to boolean

    • info

      api operation id put_order_modify_status was added

    • info

      added the new archived enum value to the request property

    • info

      added the new awaiting fulfillment enum value to the request property

    • info

      added the new cancelled enum value to the request property

    • info

      added the new cleared enum value to the request property

    • info

      added the new delayed enum value to the request property

    • info

      added the new in_progress enum value to the request property

    • info

      added the new partially cleared enum value to the request property

    • info

      added the new partially shipped enum value to the request property

    • info

      added the new pending enum value to the request property

    • info

      added the new shipped enum value to the request property

    • info

      added the new stopped enum value to the request property

    • info

      added the new unstarted enum value to the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status