Рефсейлс API
Справочники

Создать статус заказа

POST
/api/v1/references/order-statuses

Создаёт статус в выбранном этапе. Название уникально внутри этапа. У нового статуса code: null, заказу его выставляют по id через statusId. Право: references:write.

Авторизация

bearerApiKey
headerАвторизацияBearer <ключ>

Ключ API в заголовке Authorization: Bearer rsk_live_…. Ключ создаёт владелец магазина: Настройки → Интеграции → API-ключи.

Тело запроса

application/json
  1. body
group*string

Этап, к которому относится статус.

Value in"new""agreement""packing""delivery""completed""cancelled"
name*string

Название, уникально внутри этапа.

Length1 <= length <= 100

Ответ

Запись создана.

application/json
  1. response
data*
curl -X POST "https://example.com/api/v1/references/order-statuses" \  -H "Content-Type: application/json" \  -d '{    "group": "packing",    "name": "Ждёт упаковку"  }'
{  "data": {    "id": "3e9a1c7f-5b2d-4f8e-a6c1-9d4b2e7f1a53",    "code": null,    "name": "Ждёт упаковку",    "group": "packing",    "isActive": true,    "sortOrder": 4  }}

Статусы заказов GET

Статусы заказов магазина. Системный код передавайте в status при изменении заказа и в filter[status]. Статусы, которые магазин создал сам, приходят с code: null: для них используйте id в statusId и filter[statusId]. Список короткий, поэтому приходит одной страницей. Право: references:read.

Изменить статус заказа PATCH

Переименовывает или отключает статус. Системные статусы не переименовываются. При отключении заказы статуса переходят в основной статус этапа. Право: references:write.