amarix

Справочник API

Заказы

Чтение и изменение заказов вашего бренда. Список поддерживает больше тридцати фильтров, карточка отдаёт полную историю изменений и движений склада, а смена статуса на «отправлен» физически списывает товар — это не пометка, а складская операция.

GET/orders/admin/all

Список заказов

Постраничный список заказов бренда с фильтрами, поиском и сортировкой.

Доступ:Ключ интеграцииСессия сотрудникаПраво:view_orders или manage_orders

Возвращает голый массив. Чтобы получить общее число записей, добавьте withTotal=1 — тогда ответ станет объектом с полями items и total.

Параметры запроса

ПараметрТипОбязателенОписание
limitnumberнетпо умолчанию 50Сколько записей вернуть. Больше 200 не отдаст.
offsetnumberнетпо умолчанию 0Сколько записей пропустить.
withTotal1нетВернуть объект с общим числом записей вместо массива.
includeUnpaid1нетПоказать неоплаченные заказы — по умолчанию они скрыты.
statusstringнетСтатус заказа. Можно перечислить через запятую. Значение all снимает фильтр.
paymentStatusstringнетСтатус оплаты. Указание этого фильтра само по себе снимает сокрытие неоплаченных.
deliveryStatusstringнетСтатус доставки по данным перевозчика.
deliveryMethodstringнетСпособ доставки.
paymentMethodstringнетСпособ оплаты.
searchstringнетОбщий поиск: номер, телефон, почта, имя. Телефон ищется по цифрам, написание значения не имеет.
orderNumberstringнетТочный поиск по номеру. Понимает кириллические и латинские написания одинаковых букв.
phonestringнетПоиск по телефону.
emailstringнетПоиск по почте.
citystringнетГород доставки.
addressQuerystringнетПоиск по адресу целиком.
trackingNumberstringнетТрек-номер.
promoCodestringнетПромокод в заказе.
fromdateнетЗаказы с этой даты включительно.
todateнетЗаказы по эту дату включительно: конец дня по московскому времени.
minTotalnumberнетМинимальная сумма. Внимание: этот фильтр принимается в РУБЛЯХ, а не в копейках.
maxTotalnumberнетМаксимальная сумма, тоже в рублях.
productIdsstringнетЗаказы, содержащие эти товары. Через запятую.
productMatchall | anyнетпо умолчанию anyВсе перечисленные товары или любой из них.
tagsstringнетМетки заказа через запятую.
tagMatchall | anyнетпо умолчанию anyВсе метки или любая.
counterpartiesstringнетКлючи контрагентов из подсказок.
hasComment1нетТолько заказы с комментарием.
hasTrackingNumber1нетТолько заказы с треком.
includeDeleted1нетПоказать удалённые заказы.
sortBystringнетпо умолчанию date_descПорядок сортировки. Неизвестное значение молча заменяется на порядок по умолчанию.date_desc · date_asc · total_asc · total_desc · order_number · order_number_desc · updated_desc · updated_asc
curl -s "https://api.amarix.ru/orders/admin/all?limit=20&status=processing&withTotal=1" \
  -H "Authorization: Bearer $AMARIX_KEY"

Поля ответа

ПолеТипОписание
idnumberИдентификатор для запросов к API.
orderNumberstringНомер, который видят покупатель и сотрудник.
hashstringКлюч публичной ссылки отслеживания.
totalnumberИтог заказа.в копейках
deliveryCostnumberСтоимость доставки.в копейках
promoDiscountnumberСкидка по промокоду.в копейках
statusstringСтадия работы с заказом.
paymentStatusstringСтадия оплаты.
deliveryStatusstringКод статуса доставки.
deliveryStatusRustringТот же статус по-русски, готовый к показу.
itemsarrayПозиции заказа. Поле price в позиции — цена за единицу.price в копейках
orderTagsarrayМетки, проставленные сотрудниками.
createdAtstringДата создания в формате ISO, зона UTC.
ответ
[
  {
    "id": 15243,
    "orderNumber": "CSH-10245",
    "hash": "a1b2c3d4e5",
    "lastName": "Иванов",
    "firstName": "Иван",
    "phone": "+79001234567",
    "total": 480000,
    "deliveryCost": 30000,
    "promoCode": null,
    "promoDiscount": 0,
    "status": "processing",
    "paymentStatus": "PAID",
    "deliveryStatus": "ACCEPTED",
    "deliveryStatusRu": "Принят на склад",
    "deliveryMethod": "cdek_pvz",
    "city": "Москва",
    "createdAt": "2026-08-21T09:14:22.000Z",
    "items": [
      { "id": 40881, "productId": 341, "sizeId": 1923, "quantity": 1, "price": 450000 }
    ]
  }
]

Ошибки

КодОтвет сервераКогда возникаетЧто делать
401{"error":"Unauthorized"}Ключ не принят.Смотрите раздел про ключи.
403{"error":"Forbidden: Missing permission view_orders"}У ключа нет права на чтение заказов.—
403{"error":"Forbidden: no brand access configured"}У ключа нет бренда.—
GET/orders/admin/order/{id}

Карточка заказа

Полные данные одного заказа: состав, история изменений, движения склада, возвраты.

Доступ:Ключ интеграцииСессия сотрудникаПраво:view_orders или manage_orders

Отдаёт заметно больше, чем список: журнал правок заказа, движения товара по складу и связанные возвраты. Полезно для экрана «карточка заказа» и для разбора спорных ситуаций.

Параметры пути

ПараметрТипОбязателенОписание
idnumberдаИдентификатор заказа.

Поля ответа

ПолеТипОписание
orderAuditLinesarrayЖурнал изменений заказа, до 150 последних записей.
warehouseStockAuditsarrayДвижения товара по складу, до 200 записей.
orderReturnsarrayВозвраты и обмены, связанные с заказом.
shippedAtstring | nullКогда заказ отгрузили.
stockWarehouseIdnumber | nullСклад, с которого списывается товар.

Ошибки

КодОтвет сервераКогда возникаетЧто делать
400{"error":"Неверный ID заказа"}В пути не число.—
404{"error":"Заказ не найден"}Заказа нет.—
403{"error":"Forbidden: brand not allowed"}Заказ существует, но принадлежит другому бренду.Каждая такая попытка записывается в журнал безопасности.
PUT/orders/{id}/status

Сменить статус заказа

Переводит заказ на следующую стадию. Переход в «отправлен» списывает товар со склада.

Доступ:Ключ интеграцииСессия сотрудникаПраво:manage_orders

Статус двигается только вперёд: ожидает → в обработке → отправлен → доставлен. Отмена возможна из любого статуса. Понизить статус нельзя — для возврата отгруженного заказа в работу есть отдельная операция отмены отгрузки, которая вернёт товар на склад.

Параметры пути

ПараметрТипОбязателенОписание
idnumberдаИдентификатор заказа.

Тело запроса

ПараметрТипОбязателенОписание
statusstringдаНовый статус.pending · processing · shipped · delivered · cancelled
curl -s -X PUT "https://api.amarix.ru/orders/15243/status" \
  -H "Authorization: Bearer $AMARIX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"shipped"}'

Ошибки

КодОтвет сервераКогда возникаетЧто делать
409{"error":"Заказ уже отгружен, товар списан со склада. Чтобы вернуть его в работу, отмените отгрузку — товар вернётся на склад."}code: STATUS_REGRESSIONПопытка понизить статус отгруженного заказа.Отмените отгрузку — это вернёт товар на склад и переведёт заказ в работу.
409{"error":"Статус нельзя понизить с «X» на «Y». Отмена заказа доступна из любого статуса."}code: STATUS_REGRESSIONПопытка понизить статус в остальных случаях.—
403{"error":"Forbidden: Missing permission manage_orders"}Нет права на изменение заказов.—
404{"error":"Заказ не найден"}Заказа нет или он чужого бренда.—
GET/orders/admin/unshipped-with-stock

Заказы к отгрузке

Оплаченные и ещё не отправленные заказы вместе с остатками под каждую позицию.

Доступ:Ключ интеграцииСессия сотрудникаПраво:view_orders или manage_orders

Готовый список для сборки: по каждой позиции видно, хватает ли товара на складе с учётом чужих резервов. Заказы, которые собрать нельзя, помечены отдельно.

Параметры запроса

ПараметрТипОбязателенОписание
warehouseIdnumberнетСклад, относительно которого считать остатки.
includeNotReady1нетВключить заказы, которые пока нельзя собрать.

Поля ответа

ПолеТипОписание
totalnumberВсего заказов в выдаче.
readyCountnumberСколько можно собрать прямо сейчас.
notReadyCountnumberСколько ждут товара.

Ошибки

КодОтвет сервераКогда возникаетЧто делать
403{"error":"Forbidden: Missing permission view_orders"}Нет права на чтение заказов.—
GET/orders/admin/export.xlsx

Выгрузка заказов в Excel

Тот же список, что и в интерфейсе, но файлом. Принимает те же фильтры.

Доступ:Ключ интеграцииСессия сотрудникаПраво:view_orders или manage_orders

Ошибки

КодОтвет сервераКогда возникаетЧто делать
403{"error":"Forbidden: Missing permission view_orders"}Нет права на чтение заказов.—