order

Order - Modify Financial Status

Update the financial/payment status of one or more orders.

put/order/modify_financial_status

Request body

store_idstring required

Store ID

order_numberstring required

Order number

financial_status'pending' | 'paid' required

New financial status

status_datestring

Date for the status change

orderobject

Order reference object

refresh_cacheboolean

Refresh cache after update

Example request

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

Response

Financial status updated

successboolean required

Whether the operation succeeded

Changes

Changed in 3 of the 13 revisions of this API.9623

Mar 2, 2026fa53dd949b8e69See the full diff
- ▲
  request property financial_status was restricted to a list of enum values
  request-property-became-enum
- ▲
  the request property financial_status became required
  request-property-became-required
- ▲
  the request property order_number became required
  request-property-became-required
- ▲
  the request property store_id became required
  request-property-became-required
- ▲
  the order request property type/format changed from string/ to object/
  request-property-type-changed
- ▲
  the refresh_cache request property type/format changed from string/ to boolean/
  request-property-type-changed
- ○
  api operation id put_order_modify_financial_status was added
  api-operation-id-added
- ○
  added the new paid enum value to the request property financial_status
  request-property-enum-value-added
- ○
  added the new pending enum value to the request property financial_status
  request-property-enum-value-added
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Apr 22, 202408cd9cfa14dd162See the full diff
- ▲
  added required request body
  request-body-added-required
- ●
  deleted the query request parameter financial_status
  request-parameter-removed
- ●
  deleted the query request parameter order
  request-parameter-removed
- ●
  deleted the query request parameter order_number
  request-parameter-removed
- ●
  deleted the query request parameter refresh_cache
  request-parameter-removed
- ●
  deleted the query request parameter status_date
  request-parameter-removed
- ●
  deleted the query request parameter store_id
  request-parameter-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
Apr 19, 202446ceda528000212See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  api operation id put_order_modify_financial_status removed and replaced with
  api-operation-id-removed
- ○
  added the new optional query request parameter financial_status
  new-optional-request-parameter
- ○
  added the new optional query request parameter order
  new-optional-request-parameter
- ○
  added the new optional query request parameter order_number
  new-optional-request-parameter
- ○
  added the new optional query request parameter refresh_cache
  new-optional-request-parameter
- ○
  added the new optional query request parameter status_date
  new-optional-request-parameter
- ○
  added the new optional query request parameter store_id
  new-optional-request-parameter
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history