order

Order - Modify Financial Status

Changed on

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

put/order/modify_financial_status

Request

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

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

  • 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 object

    • breaking

      the request property type changed from string to boolean

    • info

      api operation id put_order_modify_financial_status was added

    • info

      added the new paid enum value to the request property

    • info

      added the new pending 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

  • 08cd9cfa14ddRevision changes
    • breaking

      added required request body

    • warning

      deleted the query request parameter financial_status

    • warning

      deleted the query request parameter order

    • warning

      deleted the query request parameter order_number

    • warning

      deleted the query request parameter refresh_cache

    • warning

      deleted the query request parameter status_date

    • warning

      deleted the query request parameter store_id

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status