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

Список статусов магазина с его собственными, постоянный смысл каждого и разрешённые переходы.

Загружаем поисковый индекс…

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

Объекты

OrderStatus

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • codestringобязательно

    Код статуса — значение status заказа. Коды системных статусов одинаковы во всех магазинах.

  • nameсловарь stringобязательно

    Название статуса по языкам, как его показывает магазин.

  • status_groupstringобязательно

    Постоянный смысл статуса, те же значения, что у status_group заказа.

    Значения:
    pos_openplacedpending_paymentpaidconfirmedpreparingreadyready_for_pickupout_for_deliverydelivery_faileddeliveredcompletedcancelledrefunded
  • allowed_nextмассив stringобязательно

    Коды статусов, в которые заказ переходит из этого, по правилам переходов магазина. Переход ещё сверяется с заказом: самовывоз не передают курьеру, доставке нужен курьер, завершению — оплата.

  • is_systembooleanобязательно

    Системный статус: по одному на каждый смысл status_group, одинаковый во всех магазинах. У статусов, добавленных магазином, — false.

  • positionintegerобязательно

    Позиция в списке статусов магазина.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

  • deleted_atstring (date-time) или nullобязательно

    Когда магазин вывел статус из обихода: заказы в него больше не переходят, прошлые заказы его показывают. null у действующего статуса.

Методы

Статусы заказа магазина и переходы между ними

get/order-statuses

Scope: orders:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

Ответы

200Успешно

application/json

  • dataмассив OrderStatusобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/order-statuses" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "code": "string",
      "name": {
        "key": "string"
      },
      "status_group": "pos_open",
      "allowed_next": [
        "string"
      ],
      "is_system": true,
      "position": 0,
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z",
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}