Замовлення

Update Custom Order Status

patch/api/v1/orders/custom_status/{order_id}

Request

  • Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
  • URL: https://api.checkbox.ua/api/v1/orders/custom_status/{order_id}
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required

Query parameters

new_status'NEW' | 'IN_WORK' | 'APPROVED' | 'TRANSFERRED_TO_WMS' | 'PREPARING' | 'DELIVERING' | 'DELIVERED' | 'DONE' | 'CANCELED' | 'TEST' required

An enumeration.

Новий статус замовлення

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

Response

Successful Response

idstring uuid required
order_idstring
status'PENDING' | 'SAVING' | 'SUCCESS' | 'CANCELLED' required

An enumeration.

custom_status'NEW' | 'IN_WORK' | 'APPROVED' | 'TRANSFERRED_TO_WMS' | 'PREPARING' | 'DELIVERING' | 'DELIVERED' | 'DONE' | 'CANCELED' | 'TEST'

An enumeration.

is_paidboolean required
payment_method'CARD_AFTER_ASSEMBLING' | 'CASH_ON_DELIVERY' | 'CASHLESS_ON_DELIVERY'

An enumeration.

created_atstring date-time required
updated_atstring date-time
not_fiscalizeboolean

Example response

{
  "receipt_draft": {
    "payments": [
      {
        "type": "CASH",
        "value": 4242
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.