v1.0.0 · обновлено 13.11.2026
MCP API для учётных систем openapi.yaml

API Целиком

Интеграция складской системы Целиком с внешними сервисами: создание и чтение документов, заказы FBS, товары, курьерские службы и дополнительные поля фулфилмента.

Общая информация

API работает поверх HTTPS и возвращает JSON. Каждая площадка Целикома имеет собственный домен, все запросы отправляются на домен вашего инстанса:

https://{clientName}/api/{token}/…

Общая информация по API Celicom

Данное API предназначено для интеграции складской системы с внешними сервисами.

Основные возможности:

  • Создание, получение, удаление, отправление в сборку заявок на отгрузку (DispatchOrders).
  • Создание, получение, удаление заявок на приемку (UnloadingOrders).
  • Получение заказов FBS c фильтрами по диапазону дат, статусам и id заказов (Orders).
  • Получение товаров c фильтрами по диапазону дат, статусами, по баркоду, по артикулам (Items).
  • Чтение и поиск (list/get) по всем остальным документам: заявки на перемещение, возврат, транзит и комплектацию, приёмки, разгрузки, отгрузки, перемещения, комплектации, инвентаризации, обработки возвратов.
  • Дополнительные поля, настроенные фулфилментом, — в ответах и при создании документов отдельным объектом customfields.
  • Интеграция с курьерскими службами (СДЭК, Яндекс Go или самовывоз).

Ограничения:

  • Лимит: 300 запросов в минуту на ключ и 600 запросов в минуту с одного IP. При превышении сервер отвечает кодом 429 (Too many requests), повторите запрос после паузы.
  • При запросах из бд за один запрос можно получить не более 30 элементов.

Авторизация:

Все запросы должны содержать персональный токен доступа в URL: /api/{token}/...

Заявки на отгрузку

DispatchOrders
POST/api/{token}/dispatchorders/add/
Создание заявки на отгрузку в система Целиком

Метод создает заявку на отгрузу в статусе Новая

Поля, которые лежат НЕ в additinfo

additinfo - это только реквизиты службы доставки. Остальные поля заявки передаются в корне запроса:

  • comment: комментарий к заявке.
  • planned_dispatch_date: «Планируемая дата отгрузки», формат YYYY-MM-DD.
  • ttn_name, ttn_cost: «Наименование груза» и «Объявленная стоимость» из блока «Данные для ТТН».
  • customfields: только дополнительные поля, которые фулфилмент создал сам и отметил как доступные в API. Штатные поля заявки через него не заполняются, неизвестные ключи игнорируются.
  • file[]: файлы (этикетки, документы) - работает только при отправке запроса как multipart/form-data. К уже созданной заявке файл добавляется методом dispatchorders/addfile.

Ключ API службы доставки

Для delivery 1 (CDEK), 4 (Яндекс.Доставка) и 5 (Ozon Delivery, отдельный кабинет) заявка создаётся только при наличии ключа API этой службы, заведённого под юрлицом клиента в разделе «Настройки API». Без ключа метод отвечает Connector not found и заявку не оставляет. Самовывоз (delivery = 2) ключа не требует.

Правила заполнения additinfo:

1. Для YandexGoGlobal (delivery=4):

  • pickup_type: 'custom_location' (до двери) или 'platform_station' (ПВЗ) — обязательно.
  • region: объект с value (GeoID) и textvalue (Название города) — обязательно.
  • recipient_name, recipient_lname, recipient_email и recipient_phones: данные получателя — обязательно.
  • Если pickup_type = 'custom_location':
    • to_location_street и to_location_streetnumber — обязательно.
    • to_location_streetnumber_corpus, to_location_streetnumber_bld, to_location_appartment — опционально.
  • Если pickup_type = 'platform_station':
    • delivery_point (код ПВЗ) — обязательно.
  • externalorderid: request_id уже существующей заявки Яндекс.Доставки (создана другой интеграцией) — опционально. Формат: 32 hex-символа с суффиксом, например a1b2c3d4e5f64718b9c0d1e2f3a4b5c6-udp — это идентификатор, который API Яндекс.Доставки возвращает при создании заявки (поле request_id). Заявка подвяжется к ней: новая заявка при закрытии отгрузки создаваться не будет, этикетки и статусы берутся из существующей. Остальные обязательные поля additinfo при этом передаются как обычно (автоподтяжки данных из заявки, в отличие от СДЭК, нет). Важно: в настройках API Яндекс.Доставки в системе должен быть указан тот же OAuth-токен (тот же кабинет), которым внешняя интеграция создала заявку, — под другими ключами система заявку не увидит и вернёт ошибку externalorderid not found. Согласуйте с фулфилментом заведение ключей до начала передачи заявок.

2. Для CDEK (delivery=1):

  • tariff_code: код тарифа СДЭК — обязательно.

Склад-склад (до ПВЗ):

  • 136 — Посылка склад-склад.
  • 234 — Посылка эконом склад-склад.
  • 483 — Экспресс склад-склад.
  • 62 — Магистральный экспресс склад-склад.
  • 63 — Магистральный суперэкспресс склад-склад.
  • 368 — CDEK Sellers склад-склад.
  • 377 — Экономичная посылка склад-склад.

Склад-дверь (курьер):

  • 137 — Посылка склад-дверь.
  • 233 — Посылка эконом склад-дверь.
  • 482 — Экспресс склад-дверь.
  • 122 — Магистральный экспресс склад-дверь.
  • 125 — Магистральный суперэкспресс склад-дверь.
  • 366 — CDEK Sellers склад-дверь.
  • 378 — Экономичная посылка склад-дверь.

Код передаётся внутри additinfo.tariff_code.value, например {"value": "136"}.

Граница поддержки: коды 368 и 377 проходят проверку реквизитов, но при создании новой накладной через этот метод пока обрабатываются адресной веткой вместо ПВЗ. Поддержка новой доставки в ПВЗ по этим двум тарифам для dispatchorders/add не заявляется. Это ограничение не относится к привязке уже существующего заказа через externalorderid.

Доступность тарифа по договору, ограничения по весу и габаритам уточняются по актуальному справочнику тарифов СДЭК на apidoc.cdek.ru. Перечень кодов WMS не гарантирует доступность тарифа у перевозчика для конкретного договора и направления.

  • recipient_name и recipient_phones: ФИО и телефон (минимум 11 цифр) — обязательно.
  • city: ID города или его название. Важно: Если указан ПВЗ, город можно не передавать (определится автоматически).
  • Если тариф 'до склада': обязателен delivery_point (код ПВЗ).
  • Если тариф 'до двери': обязателен to_location_address (полный адрес) И город (ID или название).
  • Автоматика: Если вы не передали region или city, система попытается найти их по коду ПВЗ или названию города.
  • externalorderid: номер уже существующего заказа СДЭК (создан другой интеграцией) — опционально. Формат: числовой номер заказа СДЭК (cdek_number), например 1106207373 — именно номер заказа, а не uuid сущности. Заявка подвяжется к нему: новый заказ при закрытии отгрузки создаваться не будет, этикетки и статусы берутся из существующего, а незаполненные поля доставки (тариф, город, ПВЗ, адрес, получатель) подтянутся из заказа автоматически — достаточно передать только externalorderid и состав. Важно: в настройках API СДЭК в системе должны быть указаны те же учётные данные (аккаунт/пароль того же договора), которыми внешняя интеграция создала заказ, — под другими ключами система заказ не найдёт и вернёт ошибку externalorderid not found. Согласуйте с фулфилментом заведение ключей до начала передачи заявок. Число мест в заказе должно совпадать с числом упаковок отгрузки.

3. Для Самовывоза (delivery=2):

  • Данный тип не требует передачи адреса или ПВЗ.
  • Рекомендуется передать recipient_name и recipient_phones для идентификации клиента при выдаче.

4. Для Ozon Delivery (delivery=5):

  • Все поля ниже передаются внутри additinfo как объекты {value: ...}; координаты и код ПВЗ также можно передавать строками.
  • pickup_type: delivery_point (ПВЗ/постамат) или courier (курьер) — обязательно.
  • recipient_phones: телефон получателя +7XXXXXXXXXX — обязательно; recipient_name: ФИО — необязательно.
  • cutoff_at: крайний срок передачи Ozon в ISO 8601 с часовым поясом, например 2026-10-01T18:00:00+03:00 — обязательно. Замените дату на актуальную: при оформлении отправления срок должен быть в будущем.
  • Для delivery_point: delivery_point — числовой ID из ozondeliveryorders/points, а не код ПВЗ другой службы.
  • Для courier обязательны latitude, longitude, zip_code, country, region, city, street. Регион и город — названия текстом, не GeoID.
  • Для курьера необязательны house_number, entrance, floor, apartment, intercom.
  • externalorderid: номер готового отправления Ozon Delivery (posting_number, не order_number) строкой либо объектом {value: ...}. Отправление должно быть в статусе ready_for_shipping, в том же кабинете и с тем же shipment_method_id, что у подключения клиента и склада. Новое отправление не создаётся: WMS получает этикетку и статусы существующего, не вызывает расчёт доставки и не передаёт новые габариты в Ozon. Остальные реквизиты доставки при привязке необязательны; ФИО/телефон можно передать для карточки заявки. Одна заявка = одно отправление = одна физическая упаковка. Повторная привязка номера отклоняется; автоматического подтверждения отправления нет. Прикладывать PDF не требуется. Окончательная стоимость перевозчика этим не фиксируется.
  • Для привязки используйте dispatchorders/add, затем dispatchorders/send с id ответа. Метод ozondeliveryorders/add предназначен для создания WMS-заказа с последующим оформлением нового отправления, external_id в нём не является номером готового отправления.
  • Создаётся заявка DispatchOrders. Поле id ответа передайте в dispatchorders/send; без externalorderid заказ перевозчика создаётся позже, при закрытии упакованной отгрузки.
  • fbo=0 меняет источник остатков, но сохраняет процесс DispatchOrders → ShipmentsFBO. Для создания именно FBS-заказа используйте ozondeliveryorders/add с workflow=fbs.
  • Параметра api_id нет: кабинет выбирается штатно для клиента и склада. Без externalorderid повторное создание заявки не защищено; при привязке готового отправления повтор номера отклоняется. Для явного выбора кабинета и безопасного повтора используйте ozondeliveryorders/add с workflow=fbo, api_id и external_id.
  • Склад WMS выбирается параметром URL ?warehouse_id=N; не путайте его с shipping_warehouse_id Яндекс.Доставки.

Тело запроса application/json или multipart/form-data (для файлов)

ПараметрТипОписание
deliveryОБЯЗАТЕЛЬНОintegerСлужба доставки: 1 - CDEK, 2 - Самовывоз, 4 - Яндекс.Доставка, 5 - Ozon Delivery (отдельный кабинет). Для Ozon Delivery также доступен ozondeliveryorders/add с выбором процесса FBO/FBS и защитой от повторного создания. Других значений нет: код 3 (Boxberry) существует в системе, но заявками на отгрузку не занимается и отклоняется с явной ошибкой. Для 1, 4 и 5 обязателен ключ API этой службы, заведённый под вашим юрлицом в разделе «Настройки API»; без ключа заявка не создаётся (Connector not found). Самовывоз (2) ключа не требует. Допустимо: 1, 2, 4, 5.
shipping_warehouse_idопциональноintegerДля Яндекс.Доставки: ID склада отправления из справочника складов площадок. Не warehouse_id склада WMS. Обязателен, если склад не задан в старых настройках подключенияПример: 86
fboопциональноintegerСлой остатка, с которого резервируется товар: 1 - FBO, 0 - FBS. Настоятельно рекомендуется передавать явно. Если не передан, используется FBO. При отсутствии свободного остатка на выбранном слое заказ отклоняется с ошибкой Insufficient free stock (перенос между слоями не выполняется). Допустимо: 0, 1. По умолчанию 1.
commentопциональноstringКомментарий к заявке. Если не передан, пишется «Заказ через API»Пример: "Заказ 12345"
planned_dispatch_dateопциональноstringПланируемая дата отгрузки, формат YYYY-MM-DD. Передаётся в корне запроса, а НЕ в additinfo или customfields. Сегодняшняя дата допустима, прошедшая отклоняетсяПример: "2026-08-20"
ttn_nameопциональноstring«Наименование груза» из блока «Данные для ТТН» заявки. Печатается в ТТН отгрузкиПример: "Одежда"
ttn_costопциональноstring«Объявленная стоимость» из блока «Данные для ТТН» заявки, целое число рублей без пробелов и знака валюты. Печатается в ТТН отгрузкиПример: "15000"
additinfoопциональноobject
itemsОБЯЗАТЕЛЬНОarray of object
customfieldsопциональноobjectДополнительные поля, настроенные фулфилментом: объект {системное_имя: значение}; неизвестные ключи игнорируютсяПример: {"ext_id":"A-123"}

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

200 OKУспешная регистрация
200Ошибка СДЭК: ПВЗ
200Ошибка Яндекс: GeoID

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
idintegerID созданной заявки на отгрузку, он же её номер в кабинетеПример: 12345
delivery_infoobjectРеквизиты доставки так, как их принял выбранный перевозчик. Состав полей зависит от перевозчика и тарифа
delivery_info.tariff_codeobjectКод тарифа перевозчика
delivery_info.tariff_code.valuestringЗначение реквизита
delivery_info.cityobjectГород доставки в справочнике перевозчика
delivery_info.city.valuestringЗначение реквизита
delivery_info.delivery_pointobjectКод пункта выдачи, если тариф требует ПВЗ
delivery_info.delivery_point.valuestringЗначение реквизита
Попробовать запрос
POST /api/{token}/dispatchorders/add/
POST/api/{token}/dispatchorders/addfile/
Добавление файла к существующей заявке на отгрузку

Метод прикладывает файлы (этикетки, документы) к уже созданной заявке. Файлы попадают в блок «Фотографии/документы» заявки - то же место, куда их кладут вручную в кабинете и откуда их берёт кладовщик.

Запрос отправляется только как multipart/form-data. Файлы добавляются к уже приложенным, ничего не затирая; одноимённый файл сохраняется под уникальным именем. Имя файла транслитерируется, расширение сохраняется.

Прикладывать файлы можно на любом этапе, кроме аннулированной заявки. Если файл нужно приложить сразу при создании, используйте file[] в методе dispatchorders/add.

Тело запроса multipart/form-data

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID заявки на отгрузку, он же её номер в кабинетеПример: 12345
file[]ОБЯЗАТЕЛЬНОarray of stringМассив файлов. Можно передать и один файл полем file

Пример запроса

200 OKРезультат обработки запроса

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
order_idintegerID заявки, к которой приложены файлыПример: 12345
filesarray of stringИмена сохранённых файлов
Попробовать запрос
POST /api/{token}/dispatchorders/addfile/
POST/api/{token}/dispatchorders/send/
Отправка заявки на сборку

Метод подтверждает заявку и переводит её в статус сборки. При вызове создается запись об отгрузке (Shipment) и проверяется заполнение обязательных интеграционных полей.

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID заявки на отгрузкуПример: 12345

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

200 OKУспешная отправка на сборку

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
messagestringПояснение к результатуПример: "Order successfully sent for processing"
order_idintegerID заявки, которую отправили на сборкуПример: 12345
shipment_idintegerID созданной отгрузкиПример: 6789
400Ошибка валидации или прав доступа
Попробовать запрос
POST /api/{token}/dispatchorders/send/
POST/api/{token}/dispatchorders/delete/
Удаление заявки на отгрузку

Полностью удаляет заявку из системы. При удалении все товары, зарезервированные в заказе, автоматически возвращаются на остатки склада (инвентаризируются обратно).

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerУникальный идентификатор заявки (orderId)Пример: 12345

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

200 OKУспешное удаление

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
messagestringПояснение к результату с номером удалённой заявкиПример: "Order with ID 12345 has been deleted"
400Ошибка при удалении (не найден или нет прав)
Попробовать запрос
POST /api/{token}/dispatchorders/delete/
GET/api/{token}/dispatchorders/get
Получение заявки на отгрузку

Возвращает заявку с детализацией по товарам, внешним ID и кодам маркировки (CIS).

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringId заявки.

Пример запроса

200 OKУспешный ответ

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectЗаявки по переданным ID
data[].dispatch_datestringТекущая планируемая дата отгрузки Может быть null.
data[].dispatch_date_changeobjectПоследний перенос после включения журнала: id, changed_at (время сервера), user_id, user_name, old_date, new_date (null при очистке), source (manual/system), reason_code, reason, comment. Начальная установка даты не является переносом; старые переносы задним числом не восстанавливаются Может быть null.
data[].dispatch_date_change.idintegerID события
data[].dispatch_date_change.changed_atstringВремя сервера, YYYY-MM-DD HH:mm:ss
data[].dispatch_date_change.user_idintegerАвтор; -1 для системного пользователя
data[].dispatch_date_change.user_namestringИмя автора на момент переноса
data[].dispatch_date_change.old_datestring
data[].dispatch_date_change.new_datestringМожет быть null.
data[].dispatch_date_change.sourcestringРучное изменение в форме либо программное обновление Допустимо: "manual", "system".
data[].dispatch_date_change.reason_codestringКод причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data[].dispatch_date_change.reasonstringНазвание причины на момент переноса
data[].dispatch_date_change.commentstring
data[].dispatch_date_historyarray of objectИстория переносов, от новых к старым. Поля элементов такие же, как dispatch_date_change. Причина сохраняется на момент изменения, независимо от последующего редактирования справочника
data[].dispatch_date_history[].idintegerID события
data[].dispatch_date_history[].changed_atstringВремя сервера, YYYY-MM-DD HH:mm:ss
data[].dispatch_date_history[].user_idintegerАвтор; -1 для системного пользователя
data[].dispatch_date_history[].user_namestringИмя автора на момент переноса
data[].dispatch_date_history[].old_datestring
data[].dispatch_date_history[].new_datestringМожет быть null.
data[].dispatch_date_history[].sourcestringРучное изменение в форме либо программное обновление Допустимо: "manual", "system".
data[].dispatch_date_history[].reason_codestringКод причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data[].dispatch_date_history[].reasonstringНазвание причины на момент переноса
data[].dispatch_date_history[].commentstring
data[].orderidintegerID заявки на отгрузку в системеПример: 101
data[].externalidstringНомер заявки во внешней системе клиента, если он передавался при созданииПример: "12345678"
data[].shipmentidintegerID отгрузки, созданной по заявке. 0, если заявка ещё не отправлена на сборкуПример: 550
data[].commentstringКомментарий к заявке
data[].warehousestringСклад отгрузки маркетплейса. При транзите - склад сдачи, конечный склад в directionПример: "ДОМОДЕДОВО_РФЦ_КРОССДОКИНГ"
data[].directionstringНаправление (при транзите) из заявки: склад или кластер маркетплейса, куда товар едет дальше, если он сдаётся транзитом или кросс-докингом через склад из warehouse. Заполняется по поставке маркетплейса или вручную в заявке. Пустая строка, если направления нетПример: "Невинномысск"
data[].statusstringСтатус заявки строкой Допустимо: "new", "combinig", "waitingdelivery", "ondelivery", "waitclientapproval", "delivered", "combined", "waitforcombine", "annuled", "unknown".Пример: "waitingdelivery"
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
data[].itemsarray of objectСостав заявки
data[].items[].articlestringАртикул товараПример: "SKU-99"
data[].items[].countintegerКоличество товара в заявкеПример: 2
data[].items[].cisarray of stringМассив кодов маркировки Честный Знак (КИЗ), отсканированных по товару при сборке (FBO-поставка и комплектация). Поле присутствует, только если сканы есть
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/dispatchorders/get
GET/api/{token}/dispatchorders/list/
Получение списка заявок на отгрузку (Dispatch)

Возвращает список заявок из системы отгрузок. Поддерживает фильтрацию по внутренним ID (ids), английским статусам заявки и диапазону дат. Данные сгруппированы по ID заявки.

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

ПараметрТипОписание
idsопциональноstringJSON-массив внутренних ID заявок (например: [101, 102])
statusопциональноstringJSON-массив английских статусов ЗАЯВКИ: new, combinig, waitingdelivery, ondelivery, waitclientapproval, delivered, combined, waitforcombine, annuled
dateопциональноstringJSON-массив даты [дата от, дата до] (YYYY-MM-DD)
pageопциональноintegerНомер страницы (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЛимит записей (1-30, по умолчанию 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок заявок, сгруппированный по ID заявки

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataobject (карта)Ключи объекта — это ID заявок (orderid)
data.*.dispatch_datestringТекущая планируемая дата отгрузки Может быть null.
data.*.dispatch_date_changeobjectПоследний перенос после включения журнала: id, changed_at (время сервера), user_id, user_name, old_date, new_date (null при очистке), source (manual/system), reason_code, reason, comment. Начальная установка даты не является переносом; старые переносы задним числом не восстанавливаются Может быть null.
data.*.dispatch_date_change.idintegerID события
data.*.dispatch_date_change.changed_atstringВремя сервера, YYYY-MM-DD HH:mm:ss
data.*.dispatch_date_change.user_idintegerАвтор; -1 для системного пользователя
data.*.dispatch_date_change.user_namestringИмя автора на момент переноса
data.*.dispatch_date_change.old_datestring
data.*.dispatch_date_change.new_datestringМожет быть null.
data.*.dispatch_date_change.sourcestringРучное изменение в форме либо программное обновление Допустимо: "manual", "system".
data.*.dispatch_date_change.reason_codestringКод причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data.*.dispatch_date_change.reasonstringНазвание причины на момент переноса
data.*.dispatch_date_change.commentstring
data.*.orderidintegerID заявки на отгрузку в системеПример: 101
data.*.date_timestringДата создания заявки в системеПример: "2026-04-08 15:34:57"
data.*.externalidstringID в курьерской службе (Яндекс/СДЭК) Может быть null.
data.*.shipmentidstringId связанной отгрузки
data.*.statusstringАнглийский статус самой заявкиПример: "waitingdelivery"
data.*.commentstringКомментарий к заявке
data.*.last_status_date_timestringВремя смены статусаПример: "2026-04-08 15:34:57"
data.*.addit_infoobjectДополнительная информация по отгрузке Может быть null.
data.*.customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.warehousestringСклад отгрузки маркетплейса. При транзите - склад сдачи, конечный склад в directionПример: "ДОМОДЕДОВО_РФЦ_КРОССДОКИНГ"
data.*.directionstringНаправление (при транзите) из заявки: склад или кластер маркетплейса, куда товар едет дальше, если он сдаётся транзитом или кросс-докингом через склад из warehouse. Заполняется по поставке маркетплейса или вручную в заявке. Пустая строка, если направления нетПример: "Невинномысск"
data.*.shipment_create_datestringДата создания отгрузки FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipment_statusstringСтатус связанной отгрузки: Новая, На сборке, Ожидает отгрузки, Отгружена, На проверке клиентом, Вручена получателю, Собрана, Аннулирована, Принята в СЦ/Складе, Принята в СЦ c разногласиями, Отказ приемки в СЦ, Ожидает приемку товара, Ожидает поставку товара, Черновик Может быть null.Пример: "Ожидает отгрузки"
data.*.shipment_laststatus_datetimestringВремя последнего изменения статуса FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipment_shipped_datetimestringДата фактической передачи FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.userobjectСотрудник, создавший заявку
data.*.user.first_namestringИмя сотрудникаПример: "Иван"
data.*.user.last_namestringФамилия сотрудникаПример: "Петров"
data.*.itemsarray of objectСостав заявки
data.*.items[].idintegerID товара
data.*.items[].articlestringАртикул товараПример: "MS-00123"
data.*.items[].namestringНазвание товараПример: "Наименование товара"
data.*.items[].barcodestringОсновной штрихкод товараПример: "4601234567890"
data.*.items[].countintegerКоличество товара в заявкеПример: 1
data.*.items[].cisarray of stringМассив кодов маркировки Честный Знак (КИЗ), отсканированных по товару при сборке (FBO-поставка и комплектация)
data.*.items[].tzarray of stringТехническое задание
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/dispatchorders/list/

Заявки на приёмку

UnloadingOrders
GET/api/{token}/unloadingorders/list/
Получение списка заявок на приемку

Возвращает список заявок на приемку. Поддерживает фильтрацию по ID, статусам и диапазону дат. Содержит информацию по заявке на приемку и минимум информации по связанной приемке.

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

ПараметрТипОписание
idsопциональноstringJSON-массив внутренних ID заявок
statusопциональноstringJSON-массив названий статусов
dateопциональноstringJSON-массив диапазона дат [от, до]
pageопциональноintegerНомер страницы (для пагинации) По умолчанию 1.
limitопциональноintegerКоличество записей на страницу (max 30) По умолчанию 30.

Пример запроса

200 OKУспешный ответ со списком заявок

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
codeintegerHTTP-код результата, дублирует статус ответаПример: 200
dataobject (карта)Объект заявок, где ключом является ID заявки
data.*.unloading_order_idintegerНомер
data.*.create_date_timestringДата создания
data.*.delivery_date_timestringДата поставки
data.*.statusstringСтатус
data.*.commentstringКомментарий к заявке
data.*.acceptance_sent_datestringДата отправки на приемку Может быть null.
data.*.confirm_date_timestringДата подтверждения состава Может быть null.
data.*.check_datestringДата проверки Может быть null.
data.*.additional_infoobjectДополнительная информация Может быть null.
data.*.customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.unloading_idintegerID разгрузки Может быть null.
data.*.unloading_statusstringСтатус разгрузки Может быть null.
data.*.unloading_create_datestringДата создания разгрузки Может быть null.
data.*.unloading_time_startstringДата начала разгрузки Может быть null.
data.*.unloading_time_endstringДата окончания разгрузки Может быть null.
data.*.unloading_close_datestringДата закрытия Может быть null.
data.*.itemsarray of objectСписок товаров в заявке
data.*.items[].item_idintegerID товара
data.*.items[].namestringНазвание товара
data.*.items[].barcodestringБаркод
data.*.items[].countintegerКоличество
data.*.items[].commentstringКомментарий
data.*.items[].cisarray of stringМассив кодов маркировки Честный Знак (КИЗ), отсканированных по этому товару при разгрузке (включая коды, перенесённые на приемку при её проведении)
data.*.items[].tzarray of objectТехническое задание (детализация позиций, услуг и материалов)
data.*.items[].tz[].itemobjectМожет быть null.
data.*.items[].tz[].item.PricenumberЦена товара
data.*.items[].tz[].item.CountintegerКоличество
data.*.items[].tz[].item.MaterialsCountintegerКоличество материалов
data.*.items[].tz[].serviceobjectМожет быть null.
data.*.items[].tz[].service.NamestringНазвание услуги
data.*.items[].tz[].service.PricenumberЦена услуги
data.*.items[].tz[].materialobjectМожет быть null.
data.*.items[].tz[].material.ArticlestringАртикул материала
data.*.items[].tz[].material.NamestringНазвание материала
data.*.items[].tz[].material.BarcodestringШтрихкод материала
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/unloadingorders/list/
POST/api/{token}/unloadingorders/add/
Создание заявки на приемку

Метод создает новую заявку на поставку. Принимает список товаров, файлы и дополнительные метаданные. Валидирует дату поставки и наличие товаров.

Тело запроса multipart/form-data

ПараметрТипОписание
delivery_date_timeОБЯЗАТЕЛЬНОstringДата поставки (YYYY-MM-DD или YYYY-MM-DD HH:MM:SS)Пример: "2026-03-27 15:00:00"
itemsопциональноstringJSON-массив товаров (barcode или article + count). Обязателен при allow_itemless_acceptance = 0; при 1 и 2 может быть пустымПример: "[{\"barcode\":\"564637383243\",\"count\":1}]"
storage_typeопциональноstringТип хранения: FBO (склад маркетплейса) или FBS (склад продавца) Допустимо: "FBO", "FBS". По умолчанию "FBO".
allow_itemless_acceptanceопциональноinteger0: Состав указан, 1: Принимать по факту, 2: Заполню позже Допустимо: 0, 1, 2. По умолчанию 0.
commentопциональноstringКомментарий к заявкеПример: "Заказ через API"
additinfoопциональноstringДополнительная информация в формате JSONПример: "{\"external_id\": 12345}"
slot_idопциональноintegerОкно приёмки из метода slots/. Резервирует окно за черновиком; если зарезервировать не вышло, заявка всё равно создаётся, причина возвращается в поле slotПример: 34
customfieldsопциональноstringJSON-строка с дополнительными полями фулфилмента {системное_имя: значение}
fileопциональноarray of stringПрикрепляемые файлы (картинки/документы)

Пример запроса

200 OKЗаявка успешно создана

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
unloading_order_idintegerID созданной заявки на приёмку, он же её номер в кабинетеПример: 3260
delivery_infoobjectДекодированные данные из additinfo
400Ошибка валидации
Попробовать запрос
POST /api/{token}/unloadingorders/add/
GET/api/{token}/unloadingorders/slots/
Свободные окна приемки

Возвращает окна приёмки склада со свободной ёмкостью. Если склад окна не заводил, ответ пустой - значит заявку можно создавать на любую дату. Заявку без указанного состава (allow_itemless_acceptance 1 или 2) можно ставить только в окно, свободное целиком: смотрите признак whole_free.

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

ПараметрТипОписание
date_fromопциональноstringДата начала периода (YYYY-MM-DD). По умолчанию сегодня
date_toопциональноstringДата конца периода (YYYY-MM-DD). По умолчанию date_from + 14 дней, максимум 60 дней

Пример запроса

200 OKСписок свободных окон

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
slots_enabledinteger1 - склад принимает по окнам в этом периоде, 0 - окон нет, дата свободнаяПример: 1
unitstringЕдиница ёмкости окнаПример: "заявок"
dataarray of object
data[].slot_idintegerПример: 34
data[].datestringПример: "2026-08-21"
data[].time_startstringПример: "13:00"
data[].time_endstringПример: "15:00"
data[].freenumberСвободная ёмкость окнаПример: 2
data[].capacitynumberВсего ёмкости в окнеПример: 3
data[].whole_freeinteger1 - окно свободно целиком (годится для заявки без состава)Пример: 0
data[].book_untilstringМомент закрытия записи в окноПример: "2026-08-21 13:00:00"
data[].commentstringКомментарий склада к окнуПример: "приём паллет"
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/unloadingorders/slots/
POST/api/{token}/unloadingorders/send/
Отправка заявки в работу

Переводит созданную заявку из черновика в очередь на приёмку: склад начинает её ждать. До вызова этого метода заявка складом не обрабатывается. В строгом режиме укажите slot_id (или забронируйте окно ещё в методе add). Без строгого режима можно отправить заявку без окна с указанными датой и временем поставки.

Тело запроса multipart/form-data

ПараметрТипОписание
unloading_order_idОБЯЗАТЕЛЬНОintegerID заявки на приёмкуПример: 3260
slot_idопциональноintegerОкно приёмки. Обязательно, если склад принимает по окнам, а окно ещё не забронированоПример: 34

Пример запроса

200 OKЗаявка отправлена в работу

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
unloading_order_idintegerПример: 3260
unloading_idintegerID созданной разгрузкиПример: 5006
slotobjectЗабронированное окно, если склад принимает по окнам
400Ошибка: неподходящий статус, пустой состав, блокировка по балансу или недоступное окно
Попробовать запрос
POST /api/{token}/unloadingorders/send/
POST/api/{token}/unloadingorders/delete/
Удаление заявки на приемку

Удаляет заявку и все её позиции. Удаление возможно только для заявок в статусе 'Новая', при отсутствии привязанных разгрузок и активных резервов в заказах на отгрузку (Dispatch Orders).

Пример запроса

200 OKЗаявка успешно удалена

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
messagestringПояснение к результату с номером удалённой заявкиПример: "Unloading order with ID 3260 has been deleted"
400Ошибка удаления (статус не позволяет, найдены резервы или разгрузки)
403Ошибка доступа (заявка принадлежит другому юридическому лицу)
Попробовать запрос
POST /api/{token}/unloadingorders/delete/

Заказы FBS

Orders
POST/api/{token}/orders/add/
Создать заказ интернет-магазина в FBS

Интернет-магазин передаёт оплаченный заказ, состав товаров, получателя и данные доставки в WMS. Заранее создавать заказ или накладную у перевозчика не требуется: интеграции и реквизиты перевозчиков находятся в WMS. Тип delivery совпадает с dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery. Подключение клиента и текущего склада WMS выбирает сама и сохраняет в заказе. Создаёт штатные Orders и резервирует весь заказ в одной транзакции; при нехватке товара откатывает все строки и резервы (кроме настроенного дропшиппинга). В момент этого вызова обращения к перевозчику нет. Затем заказ включается в обычную отгрузку FBS, оператор подтверждает размеры посылок, и при упаковке WMS сама создаёт новое отправление (накладную) у перевозчика и получает этикетки. Номер отправления перевозчика возвращается через orders/delivery после оформления. external_id уникален для клиента, склада WMS и типа доставки; смена подключения не создаёт дубль: повтор с тем же нормализованным содержимым возвращает прежний заказ, другое содержимое отклоняется. Все ID и даты в примерах условные.

Тарифы СДЭК (delivery=1)

Код передаётся целым числом в tariff_code в корне запроса. Валидация WMS принимает следующие коды по способу доставки.

Склад-склад (до ПВЗ):

  • 136 — Посылка склад-склад.
  • 234 — Посылка эконом склад-склад.
  • 483 — Экспресс склад-склад.
  • 62 — Магистральный экспресс склад-склад.
  • 63 — Магистральный суперэкспресс склад-склад.
  • 368 — CDEK Sellers склад-склад.
  • 377 — Экономичная посылка склад-склад.

Склад-дверь (курьер):

  • 137 — Посылка склад-дверь.
  • 233 — Посылка эконом склад-дверь.
  • 482 — Экспресс склад-дверь.
  • 122 — Магистральный экспресс склад-дверь.
  • 125 — Магистральный суперэкспресс склад-дверь.
  • 366 — CDEK Sellers склад-дверь.
  • 378 — Экономичная посылка склад-дверь.

Для склад-склад передаётся destination.delivery_point; для склад-дверь — destination.courier.

Доступность тарифа по договору, ограничения по весу и габаритам уточняются по актуальному справочнику тарифов СДЭК на apidoc.cdek.ru. Перечень кодов WMS не гарантирует доступность тарифа у перевозчика для конкретного договора и направления.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS; рекомендуется передавать явно. Подключение и товары должны быть доступны клиенту и текущему складу.

Тело запроса application/json

ПараметрТипОписание
deliveryОБЯЗАТЕЛЬНОintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery. Подключение клиента и склада WMS выбирает сама. Допустимо: 1, 4, 5.
external_idОБЯЗАТЕЛЬНОstringСобственный номер покупки в интернет-магазине для защиты от повторов, например shop-1001. Заказа у перевозчика до этого вызова может ещё не быть. При повторе сохраняйте исходные данные.
payment_methodОБЯЗАТЕЛЬНОstringОбязательное подтверждение: товары и доставка оплачены; брать деньги с получателя не требуется. Допустимо: "prepaid".
cutoff_atОБЯЗАТЕЛЬНОstringПлановая передача перевозчику, ISO 8601 с часовым поясом. Для Ozon — крайний срок передачи.
recipientОБЯЗАТЕЛЬНОobject
destinationОБЯЗАТЕЛЬНОobjectРовно один вариант: delivery_point или courier. Формат courier зависит от подключения.
itemsОБЯЗАТЕЛЬНОarray of objectДо 10000 единиц суммарно; ровно один идентификатор товара на строку. Повторные позиции одного товара в одной посылке объединяются, если цены совпадают.
parcelsОБЯЗАТЕЛЬНОarray of objectВсе посылки с уникальными request_id и товарами. Вес в граммах, размеры в миллиметрах; перед оформлением подтвердить фактические значения.
tariff_codeопциональноintegerТолько CDEK, обязательно: код тарифа из перечня в описании метода. Склад-склад: 136, 234, 483, 62, 63, 368, 377; склад-дверь: 137, 233, 482, 122, 125, 366, 378. Точка отправления, отправитель и тип заказа берутся из выбранного подключения.
shipping_warehouse_idопциональноintegerТолько YandexGo, обязательно: ID доступной клиенту записи склада площадки, не warehouse_id склада WMS.
pickup_intervalопциональноobjectТолько YandexGo, обязательно: согласованный интервал отгрузки со склада/ПВЗ отправления; должен соответствовать доступной отгрузке ЯндексGo.

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

200 OKПроверяйте status в JSON: ошибки обработки также возвращаются при HTTP 200.

Поля ответа

ПолеТипОписание
statusstringPersistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
deliveryintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_idstringНомер заказа интернет-магазина
providerstringДопустимо: "ozon_delivery", "yandexgo", "cdek".
order_numberstringВнутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_idsarray of integerID товарных строк Orders; одна строка на единицу товара
stagestringЭтап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_numberstringНомер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmedbooleanПодтверждены ли фактические вес и размеры
last_errorstringСохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/add/
POST/api/{token}/orders/parcels/
Подтвердить посылки заказа магазина

До начала оформления у перевозчика. Передайте полный набор посылок с прежними request_id и составом. Сохраняет размеры и вес, само отправление не создаёт.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS; рекомендуется передавать явно. Подключение и товары должны быть доступны клиенту и текущему складу.

Тело запроса application/json

ПараметрТипОписание
deliveryОБЯЗАТЕЛЬНОintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery. Подключение клиента и склада WMS выбирает сама. Допустимо: 1, 4, 5.
external_idОБЯЗАТЕЛЬНОstringНомер заказа магазина, переданный при add
parcelsОБЯЗАТЕЛЬНОarray of object

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

200 OKПроверяйте status в JSON: ошибки обработки также возвращаются при HTTP 200.

Поля ответа

ПолеТипОписание
statusstringPersistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
deliveryintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_idstringНомер заказа интернет-магазина
providerstringДопустимо: "ozon_delivery", "yandexgo", "cdek".
order_numberstringВнутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_idsarray of integerID товарных строк Orders; одна строка на единицу товара
stagestringЭтап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_numberstringНомер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmedbooleanПодтверждены ли фактические вес и размеры
last_errorstringСохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/parcels/
POST/api/{token}/orders/delivery/
Получить состояние доставки заказа магазина

По умолчанию читает журнал WMS. refresh=1 запрашивает статус перевозчика; отправление и этикетки не создаёт. Складские статусы доступны в orders/get и orders/list.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS; рекомендуется передавать явно. Подключение и товары должны быть доступны клиенту и текущему складу.

Тело запроса application/json

ПараметрТипОписание
deliveryОБЯЗАТЕЛЬНОintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery. Подключение клиента и склада WMS выбирает сама. Допустимо: 1, 4, 5.
external_idОБЯЗАТЕЛЬНОstringНомер заказа магазина, переданный при add
refreshопциональноintegerДопустимо: 0, 1. По умолчанию 0.

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

200 OKПроверяйте status в JSON: ошибки обработки также возвращаются при HTTP 200.

Поля ответа

ПолеТипОписание
statusstringPersistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
deliveryintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_idstringНомер заказа интернет-магазина
providerstringДопустимо: "ozon_delivery", "yandexgo", "cdek".
order_numberstringВнутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_idsarray of integerID товарных строк Orders; одна строка на единицу товара
stagestringЭтап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_numberstringНомер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmedbooleanПодтверждены ли фактические вес и размеры
last_errorstringСохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/delivery/
POST/api/{token}/orders/canceldelivery/
Запросить отмену отправления заказа магазина

Отменяет всё отправление у перевозчика, асинхронно. После запроса проверяйте orders/delivery с refresh=1 до stage=canceled. Не отменяет строки Orders и не возвращает товар на остатки. До оформления у перевозчика отменяйте заказ штатным действием WMS.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS; рекомендуется передавать явно. Подключение и товары должны быть доступны клиенту и текущему складу.

Тело запроса application/json

ПараметрТипОписание
deliveryОБЯЗАТЕЛЬНОintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery. Подключение клиента и склада WMS выбирает сама. Допустимо: 1, 4, 5.
external_idОБЯЗАТЕЛЬНОstringНомер заказа магазина, переданный при add

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

200 OKПроверяйте status в JSON: ошибки обработки также возвращаются при HTTP 200.

Поля ответа

ПолеТипОписание
statusstringPersistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
deliveryintegerТип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_idstringНомер заказа интернет-магазина
providerstringДопустимо: "ozon_delivery", "yandexgo", "cdek".
order_numberstringВнутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_idsarray of integerID товарных строк Orders; одна строка на единицу товара
stagestringЭтап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_numberstringНомер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmedbooleanПодтверждены ли фактические вес и размеры
last_errorstringСохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/canceldelivery/
GET/api/{token}/orders/get
Получение информации о заказе

Возвращает детали заказа по его OrderId с проверкой прав доступа юридического лица

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

ПараметрТипОписание
orderIdОБЯЗАТЕЛЬНОstringИдентификатор заказа

Пример запроса

200 OKУспешный ответ

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectЗаказы по переданному номеру
data[].orderidstringНомер заказа на площадке (тот же, что передавался в запросе)Пример: "12345"
data[].itemsarray of objectСостав заказа
data[].items[].articlestringАртикул товараПример: "A100"
data[].items[].countintegerКоличество товара в заказеПример: 2
data[].items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции при сборке: по одному на единицу товара. Пустой массив, если кодов нет. Разделитель GS передаётся символом \u001d
data[].items[].stickerstringНомер этикетки/отправления как в колонке «Этикетка/доп инфо», без номера поставки. Для WB — видимый номер этикетки, а не закодированный barcode. null, если номер недоступен. Может быть null.Пример: "58972371585"
data[].items[].supply_idstringНомер поставки маркетплейса из колонки «Этикетка/доп инфо» (для WB — WB-GI-...). null, если коннектор его не возвращает. Не является номером отгрузки WMS. Может быть null.Пример: "WB-GI-292835702"
data[].items[].shipment_idintegerНомер отгрузки WMS, в которую входит позиция. null, если позиция ещё не в отгрузке. Может быть null.Пример: 1520
data[].items[].datetime_assembledstringДата окончания сборки позиции. null, если позиция ещё не собрана. Может быть null.Пример: "2026-04-09 10:15:00"
data[].statusstringСтатус заказа. Коды: new (Новый), processing (На сборке), ondelivery (На отгрузке), ondeliverybylogistic (Принят в МП), return (Возврат из МП), canceled (Отменён), delivered (Вручён получателю), refused (Отказ получателя, возврат), ondeliverymp (На доставке, ожидает приёмку на МП), canceledafterpack (Отменён площадкой после сборки: собран, площадка просит не передавать), reshipment (Требуется повторная отгрузка) Допустимо: "new", "processing", "ondelivery", "ondeliverybylogistic", "return", "canceled", "delivered", "refused", "ondeliverymp", "canceledafterpack", "reshipment".Пример: "processing"
data[].marketplacestringПлощадка заказа, как в колонке «Площадка» в WMS (например, Ozon, Wildberries). Может быть null.Пример: "Ozon"
data[].marketplace_statusobjectПоследний сохранённый статус МП, как в колонке «Статус МП». Не заменяет status WMS. null, если наблюдения нет или строки сгруппированного заказа относятся к разным подключениям. Поддерживаются WB, Ozon и Яндекс Маркет. Не вызывает опрос МП. Фильтры status и status_date относятся к статусу WMS, а не к этому блоку. Может быть null.
data[].marketplace_status.codestringКод статуса МП; подстатус Ozon/Яндекса, если есть, через ' / '.Пример: "sorted"
data[].marketplace_status.textstringНазвание статуса, как в таблице WMS.Пример: "Принят WB (сортировка)"
data[].marketplace_status.observed_atstringКогда WMS впервые получила текущий статус, UTC. Не точное время события на МП. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data[].marketplace_status.sorted_atstringПервое получение sorted у WB, UTC; иначе null. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data[].zonestringЗона отгрузки: зона из настроек подключения к площадке, через которое пришёл заказ. null, если зона не задана. Может быть null.Пример: "Склад Север"
data[].shipment_idintegerНомер отгрузки WMS (колонка «№ отгрузки»). null, если заказ ещё не в отгрузке или его позиции в разных отгрузках: тогда номер смотрите в items[].shipment_id. Может быть null.Пример: 1520
data[].datetime_assembledstringДата окончания сборки заказа: когда собрана последняя позиция. null, пока собраны не все позиции. Это не дата передачи на площадку. Может быть null.Пример: "2026-04-09 10:15:00"
[] — элемент массива, точка — вложенное поле.
400Ошибка валидации
Попробовать запрос
GET /api/{token}/orders/get
GET/api/{token}/orders/list/
Получение списка заказов с фильтрацией

Возвращает список заказов, сгруппированных по ID заказа. Поддерживает фильтры по ID заказов (orders_id), статусам и диапазону дат через JSON-массивы. Параметры могут передаваться как в GET, так и в POST.

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

ПараметрТипОписание
orders_idопциональноstringJSON-массив строковых или числовых ID заказов (например: ["ЗАКАЗ-1", "ЗАКАЗ-2"]). Если передан, пагинация игнорируется.
statusопциональноstringJSON-массив статусов. Коды: new (Новый), processing (На сборке), ondelivery (На отгрузке), ondeliverybylogistic (Принят в МП), return (Возврат из МП), canceled (Отменён), delivered (Вручён получателю), refused (Отказ получателя, возврат), ondeliverymp (На доставке, ожидает приёмку на МП), canceledafterpack (Отменён площадкой после сборки: собран, площадка просит не передавать), reshipment (Требуется повторная отгрузка)
dateопциональноstringФильтр по дате СОЗДАНИЯ заказа. JSON-массив [начало, конец] в формате YYYY-MM-DD, обе даты включены целиком. При указании времени границы учитываются точно и включительно
status_dateопциональноstringФильтр по дате последней СМЕНЫ СТАТУСА (last_status_date_time). JSON-массив [начало, конец] в формате YYYY-MM-DD, обе даты включены целиком. При указании времени границы учитываются точно и включительно
pageопциональноintegerНомер страницы (работает только без фильтра orders_id) По умолчанию 1.
limitопциональноintegerКоличество заказов на страницу (1-30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKУспешный ответ со списком заказов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataobject (карта)Ключи объекта — это внешние/внутренние ID заказов (orderid)
data.*.orderidstringID заказаПример: "12345"
data.*.datetimestringДата создания заказа в системеПример: "2026-04-08 15:34:57"
data.*.datetime_shippedstringДата отгрузки заказа Может быть null.Пример: "2026-04-09 11:20:00"
data.*.statusstringТекущий статус заказа. Коды: new (Новый), processing (На сборке), ondelivery (На отгрузке), ondeliverybylogistic (Принят в МП), return (Возврат из МП), canceled (Отменён), delivered (Вручён получателю), refused (Отказ получателя, возврат), ondeliverymp (На доставке, ожидает приёмку на МП), canceledafterpack (Отменён площадкой после сборки: собран, площадка просит не передавать), reshipment (Требуется повторная отгрузка)Пример: "processing"
data.*.last_status_date_timestringДата последней смены статусаПример: "2026-04-08 16:00:15"
data.*.marketplacestringПлощадка заказа, как в колонке «Площадка» в WMS (например, Ozon, Wildberries). Может быть null.Пример: "Ozon"
data.*.marketplace_statusobjectПоследний сохранённый статус МП, как в колонке «Статус МП». Не заменяет status WMS. null, если наблюдения нет или строки сгруппированного заказа относятся к разным подключениям. Поддерживаются WB, Ozon и Яндекс Маркет. Не вызывает опрос МП. Фильтры status и status_date относятся к статусу WMS, а не к этому блоку. Может быть null.
data.*.marketplace_status.codestringКод статуса МП; подстатус Ozon/Яндекса, если есть, через ' / '.Пример: "sorted"
data.*.marketplace_status.textstringНазвание статуса, как в таблице WMS.Пример: "Принят WB (сортировка)"
data.*.marketplace_status.observed_atstringКогда WMS впервые получила текущий статус, UTC. Не точное время события на МП. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data.*.marketplace_status.sorted_atstringПервое получение sorted у WB, UTC; иначе null. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data.*.zonestringЗона отгрузки: зона из настроек подключения к площадке, через которое пришёл заказ. null, если зона не задана. Может быть null.Пример: "Склад Север"
data.*.shipment_idintegerНомер отгрузки WMS (колонка «№ отгрузки»). null, если заказ ещё не в отгрузке или его позиции в разных отгрузках: тогда номер смотрите в items[].shipment_id. Может быть null.Пример: 1520
data.*.datetime_assembledstringДата окончания сборки заказа: когда собрана последняя позиция. null, пока собраны не все позиции. Это не дата передачи на площадку. Не путать с datetime_shipped. Может быть null.Пример: "2026-04-09 10:15:00"
data.*.itemsarray of object
data.*.items[].idintegerID товарной позиции
data.*.items[].articlestringАртикул товараПример: "ART-772"
data.*.items[].namestringНаименование товараПример: "Футболка белая XL"
data.*.items[].barcodestringШтрихкод товараПример: "4601234567890"
data.*.items[].countintegerКоличество единицПример: 1
data.*.items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции при сборке: по одному на единицу товара. Пустой массив, если кодов нет. Разделитель GS передаётся символом \u001d
data.*.items[].stickerstringНомер этикетки/отправления как в колонке «Этикетка/доп инфо», без номера поставки. Для WB — видимый номер этикетки, а не закодированный barcode. null, если номер недоступен. Может быть null.Пример: "58972371585"
data.*.items[].supply_idstringНомер поставки маркетплейса из колонки «Этикетка/доп инфо» (для WB — WB-GI-...). null, если коннектор его не возвращает. Не является номером отгрузки WMS. Может быть null.Пример: "WB-GI-292835702"
data.*.items[].shipment_idintegerНомер отгрузки WMS, в которую входит позиция. null, если позиция ещё не в отгрузке. Может быть null.Пример: 1520
data.*.items[].datetime_assembledstringДата окончания сборки позиции. null, если позиция ещё не собрана. Может быть null.Пример: "2026-04-09 10:15:00"
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/orders/list/

Ozon Delivery

OzonDelivery
POST/api/{token}/ozondeliveryorders/add/
Создать складской заказ Ozon Delivery (FBO/FBS)

Создаёт документы и резервы WMS, без обращения к Ozon. workflow=fbo: заявка DispatchOrders, затем dispatchorders/send с dispatch_order_id. workflow=fbs: строки штатной модели Orders, затем обычная сборка FBS и включение в отгрузку Shipments; dispatchorders/send не нужен. Общего метода orders/add этот маршрут не добавляет. При недостатке товара запрос откатывается целиком; для FBS допускается настроенный дропшиппинг. Повтор в том же подключении с тем же external_id и нормализованным содержимым возвращает исходный документ без нового резерва; изменённое содержимое отклоняется. Все примеры условные: замените кабинет, товары, ПВЗ, получателя и срок.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
api_idОБЯЗАТЕЛЬНОintegerID подключения ApiCredentials отдельного кабинета Ozon Delivery текущего клиента и склада. Не token API WMS и не shipment_method_id Ozon.Пример: 123
recipientОБЯЗАТЕЛЬНОobject
deliveryОБЯЗАТЕЛЬНОobjectРовно один вариант: delivery_point или courier.
cutoff_atОБЯЗАТЕЛЬНОstringПередать посылки Ozon до этой даты. ISO 8601 с часовым поясом; срок должен оставаться будущим к первому оформлению у перевозчика.Пример: "2026-10-01T18:00:00+03:00"
external_idОБЯЗАТЕЛЬНОstringУникальный номер заявки в пределах подключения api_id. Для безопасного повтора сохраняйте номер и исходное тело.Пример: "shop-order-1001"
workflowОБЯЗАТЕЛЬНОstringВыбор складского процесса Допустимо: "fbo", "fbs".
fboопциональноintegerПриоритет остатков для workflow=fbo; не переключает процесс в FBS. В workflow=fbs не используется. Допустимо: 0, 1. По умолчанию 1.
itemsОБЯЗАТЕЛЬНОarray of objectСостав по ID карточек товаров WMS текущего клиента. Для FBS до 10000 единиц суммарно; package_num обязателен, каждая посылка должна содержать товары.
parcelsопциональноarray of objectПосылки с уникальными request_id. Для FBS обязательны; при add размеры предварительные, при parcels подтверждаются фактические. Для FBO не передавать: используются фактические упаковки отгрузки.

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

200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
idintegerID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_idstringНомер, переданный клиентом при addПример: "shop-order-1001"
workflowstringДопустимо: "fbo", "fbs".
dispatch_order_idintegerID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_numberstringВнутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_numberstringНомер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stagestringЭтап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postingsarray of objectОтправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_idinteger
postings[].posting_numberstringНомер отправления Ozon
postings[].posting_external_idstring
posting_statusesarray of objectПоследние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_numberstring
posting_statuses[].statusstringСтатус перевозчика, например ready_for_shipping, delivered, canceled
last_errorstringСохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/add/
POST/api/{token}/ozondeliveryorders/parcels/
Подтвердить фактические размеры посылок FBS

Только workflow=fbs, до первой попытки создания у Ozon. Передайте полный массив посылок с прежними request_id: можно уточнить вес, размеры, стоимость и описание; добавлять/удалять посылки или менять состав нельзя. Подтверждение сохраняется в WMS; метод сам не создаёт и не подтверждает отправление у перевозчика.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501
parcelsОБЯЗАТЕЛЬНОarray of objectПосылки с уникальными request_id. Для FBS обязательны; при add размеры предварительные, при parcels подтверждаются фактические. Для FBO не передавать: используются фактические упаковки отгрузки.

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

200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
idintegerID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_idstringНомер, переданный клиентом при addПример: "shop-order-1001"
workflowstringДопустимо: "fbo", "fbs".
dispatch_order_idintegerID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_numberstringВнутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_numberstringНомер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stagestringЭтап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postingsarray of objectОтправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_idinteger
postings[].posting_numberstringНомер отправления Ozon
postings[].posting_external_idstring
posting_statusesarray of objectПоследние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_numberstring
posting_statuses[].statusstringСтатус перевозчика, например ready_for_shipping, delivered, canceled
last_errorstringСохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/parcels/
POST/api/{token}/ozondeliveryorders/get/
Состояние заказа Ozon Delivery в WMS

Читает сохранённое состояние текущего клиента и склада без обращения к Ozon. Пустые postings и ozon_order_number=null означают, что номер отправления ещё не получен.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501

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

200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
idintegerID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_idstringНомер, переданный клиентом при addПример: "shop-order-1001"
workflowstringДопустимо: "fbo", "fbs".
dispatch_order_idintegerID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_numberstringВнутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_numberstringНомер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stagestringЭтап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postingsarray of objectОтправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_idinteger
postings[].posting_numberstringНомер отправления Ozon
postings[].posting_external_idstring
posting_statusesarray of objectПоследние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_numberstring
posting_statuses[].statusstringСтатус перевозчика, например ready_for_shipping, delivered, canceled
last_errorstringСохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/get/
POST/api/{token}/ozondeliveryorders/checkout/
Предварительный расчёт Ozon Delivery

Обращается к Ozon для проверки получателя и расчёта. Не создаёт документы, резервы или заказ перевозчика. Наш метод принимает полный адрес courier, как add; в запрос расчёта к Ozon передаёт только координаты. shipment_method_id берётся из подключения api_id.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
api_idОБЯЗАТЕЛЬНОintegerID подключения ApiCredentials отдельного кабинета Ozon Delivery текущего клиента и склада. Не token API WMS и не shipment_method_id Ozon.Пример: 123
recipientОБЯЗАТЕЛЬНОobject
deliveryОБЯЗАТЕЛЬНОobjectРовно один вариант: delivery_point или courier.
cutoff_atОБЯЗАТЕЛЬНОstringПередать посылки Ozon до этой даты. ISO 8601 с часовым поясом; срок должен оставаться будущим к первому оформлению у перевозчика.Пример: "2026-10-01T18:00:00+03:00"
parcelsОБЯЗАТЕЛЬНОarray of objectПосылки для предварительного расчёта в любом складском процессе. Уникальные request_id; вес, размеры и объявленная стоимость обязательны.

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

200 OKОтвет расчёта Ozon либо ошибка обработки WMS

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
dataobjectОтвет /v1/order/checkout отдельного API Ozon Delivery без изменения его структуры
Попробовать запрос
POST /api/{token}/ozondeliveryorders/checkout/
POST/api/{token}/ozondeliveryorders/points/
ПВЗ и постаматы Ozon Delivery

Возвращает ПВЗ, подходящие для shipment_method_id выбранного подключения. Повторяйте запрос с полученным next_cursor до пустой строки, даже если текущая delivery_points пуста после фильтрации.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
api_idОБЯЗАТЕЛЬНОintegerID подключения Ozon Delivery текущего клиента и складаПример: 123
cursorопциональноstringnext_cursor предыдущего ответа; для первой страницы пропустить или передать пустую строку — WMS не передаст курсор в Ozon По умолчанию "".

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

200 OKСтраница ПВЗ Ozon либо ошибка обработки WMS

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
delivery_pointsarray of objectОбъекты ПВЗ из /v1/delivery-point/info Ozon, без изменения их структуры
next_cursorstringКурсор продолжения; пустая строка означает конец списка
Попробовать запрос
POST /api/{token}/ozondeliveryorders/points/
POST/api/{token}/ozondeliveryorders/refresh/
Обновить статусы Ozon Delivery

Запрашивает статусы уже известных отправлений и сохраняет их в журнал WMS. Не создаёт заказ, не скачивает этикетки и не меняет остатки; без известных отправлений возвращает текущее состояние. Статусы складских документов обновляются штатными обработчиками склада.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501

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

200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
idintegerID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_idstringНомер, переданный клиентом при addПример: "shop-order-1001"
workflowstringДопустимо: "fbo", "fbs".
dispatch_order_idintegerID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_numberstringВнутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_numberstringНомер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stagestringЭтап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postingsarray of objectОтправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_idinteger
postings[].posting_numberstringНомер отправления Ozon
postings[].posting_external_idstring
posting_statusesarray of objectПоследние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_numberstring
posting_statuses[].statusstringСтатус перевозчика, например ready_for_shipping, delivered, canceled
last_errorstringСохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/refresh/
POST/api/{token}/ozondeliveryorders/cancel/
Запросить отмену заказа у Ozon Delivery

Только для уже созданных у Ozon отправлений. Асинхронно: cancel_pending означает запрос отмены; проверяйте refresh до canceled у всех посылок. Доставленное отправление отменить нельзя. При неопределённом результате создания сначала требуется восстановить его с сохранённым ключом. До создания в Ozon отменяйте складской документ штатным способом. Метод не отменяет складские документы и не возвращает товар на остатки.

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

ПараметрТипОписание
warehouse_idопциональноintegerID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.

Тело запроса application/json

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501

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

200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK".
idintegerID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_idstringНомер, переданный клиентом при addПример: "shop-order-1001"
workflowstringДопустимо: "fbo", "fbs".
dispatch_order_idintegerID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_numberstringВнутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_numberstringНомер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stagestringЭтап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postingsarray of objectОтправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_idinteger
postings[].posting_numberstringНомер отправления Ozon
postings[].posting_external_idstring
posting_statusesarray of objectПоследние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_numberstring
posting_statuses[].statusstringСтатус перевозчика, например ready_for_shipping, delivered, canceled
last_errorstringСохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/cancel/

Товары

Items
POST/api/{token}/cmark/add/
Загрузить коды ЧЗ в карточку товара

Загрузка кодов для последующей печати и маркировки, с теми же проверками формата и дублей, что при импорте CSV. Это не приёмка товара и не привязка ЧЗ к заказу. Онлайн-проверка в Честном знаке при импорте не выполняется. Только доступная активная карточка клиента API-ключа. Повторные коды пропускаются без переноса и сброса печати. Максимум 1000 кодов за запрос. Результат каждой строки содержит её индекс с нуля и статус added, exists или invalid. Ошибки отдельных кодов не мешают загрузить остальные: общий статус PARTIAL. GS передавайте как символ U+001D (в JSON — \u001d) либо <GS>.

Тело запроса application/json

ПараметрТипОписание
item_idОБЯЗАТЕЛЬНОintegerID карточки из items/get
codesОБЯЗАТЕЛЬНОarray of string

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

200 OKРезультат импорта, включая пропуски и ошибки отдельных кодов

Поля ответа

ПолеТипОписание
statusstringДопустимо: "OK", "PARTIAL".
item_idinteger
import_idintegerНомер загрузки в истории импорта ЧЗ
totalinteger
addedinteger
existsinteger
invalidinteger
resultsarray of object
results[].indexintegerИндекс исходного кода с нуля
results[].statusstringДопустимо: "added", "exists", "invalid".
results[].messagestringПричина отклонения, для invalid
[] — элемент массива, точка — вложенное поле.
400Некорректный запрос или архивная карточка
403Ключ не имеет доступа к методу
404Карточка не найдена или недоступна клиенту
405Используйте POST
503Временная ошибка; запрос можно повторить
Попробовать запрос
POST /api/{token}/cmark/add/
POST/api/{token}/items/add/
Создать карточку товара клиента

Создаёт одну обычную карточку только у клиента, которому выдан ключ. Нужен клиентский ключ с разрешением items/add; общий ключ площадки не подходит. Content-Type: application/json. После создания карточек можно передать их штрихкоды в unloadingorders/add. Повтор запроса с теми же данными возвращает прежнюю карточку (created=false), не меняя её. Совпадение основного/дополнительного штрихкода либо артикула + цвета + размера с другой карточкой даёт 409; архивные, подчинённые карточки, материалы, комплекты и кванты автоматически не восстанавливаются и не изменяются. Один артикул с разными цветами/размерами допускается. Не передавайте остатки, цены, клиента или связи с маркетплейсами. Создание не импортирует карточки на маркетплейсы. Штрихкоды передаются строками (цифры, латиница и печатные ASCII-символы), чтобы сохранить ведущие нули. Коды ЧЗ и внутренние этикетки товара не принимаются. Пустые цвет и размер означают обычный товар без варианта. Вес — в граммах, размеры — в миллиметрах. При ошибке BUSY повторите тот же запрос; ITEM_CONFLICT требует проверки карточек через items/get. Метод сериализует свои параллельные запросы для одного клиента; параллельные ручные изменения/импорты этим блокированием не охватываются.

Тело запроса application/json

ПараметрТипОписание
nameОБЯЗАТЕЛЬНОstringПример: "Футболка"
articleОБЯЗАТЕЛЬНОstringПример: "TS-01"
barcodeОБЯЗАТЕЛЬНОstringПример: "04601234567893"
colorопциональноstring По умолчанию "".Пример: "Белый"
sizeопциональноstring По умолчанию "".Пример: "M"
vendorопциональноstring
weightопциональноintegerВес, г
lengthопциональноintegerДлина, мм
widthопциональноintegerШирина, мм
heightопциональноintegerВысота, мм
additional_barcodesопциональноarray of stringДополнительные ШК; не более 1000 символов с разделителями. Повторы и основной ШК исключаются.

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

201 OKКарточка создана; created=true

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
createdbooleanПример: true
itemobject
item.idintegerПример: 123
item.namestringПример: "Футболка"
item.articlestringПример: "TS-01"
item.barcodestringПример: "04601234567893"
item.colorstringПример: "Белый"
item.sizestringПример: "M"
200Карточка с этими данными уже есть: тот же ответ, created=false
400Неверные или неподдерживаемые поля
403Ключ не привязан к клиенту или метод запрещён
405METHOD_NOT_ALLOWED: используйте POST
409ITEM_CONFLICT: совпадение с другой карточкой; BUSY: повторите запрос позже
500INTERNAL_ERROR: создание не завершено, повторите тот же запрос
Попробовать запрос
POST /api/{token}/items/add/
GET/api/{token}/items/get/
Получение списка товаров с фильтрацией

Возвращает список товаров. Поддерживает поиск по части артикула (LIKE), точный поиск (артикул, ID, штрихкод), фильтры по остаткам, цвету и размеру и пагинацию. Параметры id, article, article_prec и barcode принимают как одиночные значения, так и JSON-массивы. Фильтры по остаткам названы так же, как поля ответа (Fbs, FbsVirtual, Fbo, FboVirtual, Count, CountVirtual), и сверяются с кэш-колонками остатков карточки: комплекты и подчинённые карточки под них не попадают, так как их остаток считается по составляющим. Фильтры Color и Size сравнивают значение карточки точно, регистр не важен. Работает через (GET/POST).

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

ПараметрТипОписание
idопциональноstringID товара или JSON-массив ID (например: 123 или [123, 124])
articleопциональноstringЧастичное совпадение артикула (LIKE).
article_precопциональноstringТочное совпадение артикула или JSON-массив артикулов (например: ["SKU1", "SKU2"])
barcodeопциональноstringШтрихкод или JSON-массив штрихкодов (например: ["46000", "46001"])
FbsопциональноstringФильтр по остатку FBS (склад продавца): точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как fbs
FbsVirtualопциональноstringФильтр по виртуальному остатку FBS: точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как fbs_virtual
FboопциональноstringФильтр по остатку FBO (склад маркетплейса): точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как fbo
FboVirtualопциональноstringФильтр по виртуальному остатку FBO: точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как fbo_virtual
CountопциональноstringФильтр по общему остатку (FBS + FBO, с браком): точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как count
CountVirtualопциональноstringФильтр по общему виртуальному остатку: точное значение (0), сравнение (<10, >=5, !=0) или JSON-диапазон включительно ([1, 10]). Принимается и как count_virtual
ColorопциональноstringФильтр по цвету: точное значение (Черный) или JSON-список значений (["Черный", "белый"]). Регистр не важен; для карточек с незаполненным цветом - [""]. Принимается и как color
SizeопциональноstringФильтр по размеру: точное значение (M) или JSON-список значений (["M", "L"]). Регистр не важен, но кириллическая и латинская буквы - разные значения; для карточек с незаполненным размером - [""]. Принимается и как size
pageопциональноintegerНомер страницы (по умолчанию 1) По умолчанию 1.
limitопциональноintegerКоличество элементов на странице (макс. 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок товаров

Поля ответа

ПолеТипОписание
IdintegerID карточки товара в системеПример: 1
NamestringНазвание товараПример: "Товар №1"
FbsintegerОстаток FBS (склад продавца)Пример: 7
FbointegerОстаток FBO (склад маркетплейса)Пример: 3
CountintegerОбщий остатокПример: 10
CountVirtualintegerВиртуальный остатокПример: 5
ArticlestringАртикул товараПример: "SKU-123"
Barcodesarray of stringВсе штрихкоды карточки: основной и дополнительные
ComplectstringСостав комплекта: ID составляющих через запятую (пустая строка — обычный товар)Пример: ""
ParentItemintegerID родительской карточки для подчинённого товара; 0 если связи нетПример: 0
KitComplectstringСостав собираемого комплекта: ID компонентов через запятую; повтор ID означает количество. Пустая строка если состава нетПример: ""
QuantstringСостав кванта: ID единичного товара через запятую с повторением по кратности; пустая строка если кванта нетПример: ""
QuantLocalintegerID локальной карточки для расквантовки; 0 если не заданаПример: 0
CardKindintegerТип карточки: 1 обычный товар, 2 подчинённый, 3 виртуальный комплект, 4 собираемый комплект, 5 квантПример: 1
ColorstringЦвет, текстовое значение; не ID справочникаПример: "Черный"
SizestringРазмер, текстовое значение; не ID справочникаПример: "M"
WeightintegerВес в граммахПример: 100
LengthintegerДлина в миллиметрахПример: 100
WidthintegerШирина в миллиметрахПример: 100
HeightintegerВысота в миллиметрахПример: 100
VolumenumberОбъём в кубических метрах, рассчитан по габаритам карточки и округлён до 6 знаковПример: 0.001
CMarkTotalintegerКодов «Честного знака» загружено на карточку всего (первое число в колонке «Честный знак» в разделе «Товары»)Пример: 130
CMarkFreeintegerКодов «Честного знака» доступно, то есть ещё не отправлено на печать (второе число в колонке «Честный знак» в разделе «Товары»)Пример: 128
CMarkGroupintegerID группы «Честного знака», 0 если карточка не в группе. Если не 0, коды общие для всех карточек группы и CMarkTotal/CMarkFree одинаковы у каждой из нихПример: 0
customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
Попробовать запрос
GET /api/{token}/items/get/

Хранение

Storage
GET/api/{token}/legalfix/get/
Сохранённый срез объёма хранения на дату

Чтение реестра хранения без пересчёта и начислений. Клиент определяется ключом. date — прошедший день в часовом поясе площадки. Объём учитывает правила расчёта хранения, а не только габариты товаров. volume_start — сохранённый начальный объём (из предыдущего доступного среза), volume_end — сохранённый итог дня. Не является текущим остатком. Отсутствующий срез возвращает 404, а сохранённый нулевой — 200. Число паллет и мест метод не вычисляет. Исторические значения могут измениться после штатного пересчёта хранения.

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

ПараметрТипОписание
dateОБЯЗАТЕЛЬНОstringПрошедшая дата YYYY-MM-DD; текущий и будущие дни не принимаются.
warehouse_idопциональноintegerДоступный клиенту склад; по умолчанию стандартный склад клиентского API.

Пример запроса

200 OKСохранённый срез, включая нулевой объём

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobject
data.snapshot_idinteger
data.client_idinteger
data.warehouse_idinteger
data.datestring
data.volume_startnumberПример: 2.5
data.volume_endnumberПример: 2.2999999999999998
data.volume_unitstringПример: "m3"
data.sourcestringПример: "stored_snapshot"
400INVALID_DATE: требуется корректная прошедшая дата YYYY-MM-DD
403CLIENT_KEY_REQUIRED: нужен клиентский ключ; либо метод запрещён для ключа
404SNAPSHOT_NOT_FOUND: срез на дату отсутствует; data=null, это не нулевой объём
Попробовать запрос
GET /api/{token}/legalfix/get/

Приёмки

Incomes
GET/api/{token}/incomes/list/
Список приёмок с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции с привязанными кодами ЧЗ (cis) и дополнительные поля (customfields). Коды из пула карточки товара не включаются. Фильтры ids/status/date, пагинация page/limit (до 30). Приёмки дополнительно возвращают source_type — тип документа-источника WMS (например, Inventory, Transfer, Unloadings, Complectations) и source_id — его ID. Передаются сохранённые значения; также могут встречаться другие типы источника. У приёмки без источника source_type равен пустой строке, source_id — 0. Название и содержимое родительского документа не передаются.

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].source_typestringТолько у приёмок: тип документа-источника (например, Inventory, Transfer, Unloadings, Complectations). Пустая строка у приёмки без источникаПример: "Unloadings"
data[].source_idintegerТолько у приёмок: ID документа-источника в WMS. Используется вместе с source_type; 0, если документ-источник не указанПример: 123
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/incomes/list/
GET/api/{token}/incomes/get/
Получение приёмки по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации. Приёмки дополнительно возвращают source_type — тип документа-источника WMS (например, Inventory, Transfer, Unloadings, Complectations) и source_id — его ID. Передаются сохранённые значения; также могут встречаться другие типы источника. У приёмки без источника source_type равен пустой строке, source_id — 0. Название и содержимое родительского документа не передаются.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].source_typestringТолько у приёмок: тип документа-источника (например, Inventory, Transfer, Unloadings, Complectations). Пустая строка у приёмки без источникаПример: "Unloadings"
data[].source_idintegerТолько у приёмок: ID документа-источника в WMS. Используется вместе с source_type; 0, если документ-источник не указанПример: 123
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/incomes/get/

Разгрузки

Unloadings
GET/api/{token}/unloadings/list/
Получение списка разгрузок

Возвращает подробный список разгрузок с привязкой к заявкам на приемку и самим приемки. Возможны фильтры по диапазону дат, по id, по id заявок и по старусам

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

ПараметрТипОписание
idsопциональноstringмассив ID разгрузок
statusопциональноstringмассив названий статусов (Новая, В работе, Принята и т.д.)
unloading_order_idsопциональноstringмассив ID родительских заявок на поставку
dateопциональноstringмассив диапазона дат [от, до]
pageопциональноinteger По умолчанию 1.
limitопциональноinteger По умолчанию 30.

Пример запроса

200 OKУспешный возврат списка разгрузок

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
codeintegerHTTP-код результата, дублирует статус ответаПример: 200
dataobject (карта)Ключи объекта — это ID разгрузок
data.*.unloading_idintegerID разгрузки, он же её номер в кабинете
data.*.date_timestringДата и время создания разгрузки
data.*.date_time_startstringКогда разгрузку начали Может быть null.
data.*.date_time_endstringКогда разгрузку закончили Может быть null.
data.*.statusstringСтатус разгрузки словами: Новая, В работе, Ожидает закрытия, Закрыта, На проверке, Принята
data.*.unloading_order_idintegerID заявки на приёмку, по которой сделана разгрузка Может быть null.
data.*.externalidstringНомер поставки во внешней системе клиента, если он передавался Может быть null.
data.*.shipmentidintegerID связанной отгрузки, если разгрузка сделана по ней Может быть null.
data.*.customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.userobjectСотрудник, создавший разгрузку
data.*.user.first_namestringИмя сотрудника
data.*.user.last_namestringФамилия сотрудника
data.*.incomesarray of objectПриёмки, сделанные по этой разгрузке
data.*.incomes[].idintegerID приёмки
data.*.incomes[].date_timestringДата создания приемки
data.*.incomes[].close_date_timestringДата проведения приемки
data.*.itemsarray of objectФактически разгруженные товары (суммарно по всем грузоместам)
data.*.items[].item_idintegerID товара
data.*.items[].namestringНазвание товара
data.*.items[].barcodestringШтрихкод
data.*.items[].countintegerКоличество
data.*.items[].cisarray of stringМассив кодов маркировки Честный Знак (КИЗ), отсканированных по этому товару при разгрузке (включая коды, перенесённые на приемку при её проведении)
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/unloadings/list/

Инвентаризации

Inventory
GET/api/{token}/inventory/list/
Список инвентаризаций с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/inventory/list/
GET/api/{token}/inventory/get/
Получение инвентаризации по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/inventory/get/

Перемещения

Transfer
GET/api/{token}/transfer/list/
Список перемещений с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transfer/list/
GET/api/{token}/transfer/get/
Получение перемещения по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transfer/get/

Заявки на перемещение

TransferOrders
GET/api/{token}/transferorders/list/
Список заявок на перемещение с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transferorders/list/
GET/api/{token}/transferorders/get/
Получение заявки на перемещение по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transferorders/get/

Возвратные заявки

ReturnOrders
GET/api/{token}/returnorders/list/
Список заявок на возврат с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnorders/list/
GET/api/{token}/returnorders/get/
Получение заявки на возврат по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnorders/get/

Обработки возвратов

ReturnProcess
GET/api/{token}/returnprocess/list/
Список обработок возвратов с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnprocess/list/
GET/api/{token}/returnprocess/get/
Получение обработки возвратов по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnprocess/get/

Транзит входящий

TransitIn
GET/api/{token}/transitin/list/
Список транзитных приёмок с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitin/list/
GET/api/{token}/transitin/get/
Получение транзитной приёмки по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitin/get/

Заявки: транзит входящий

TransitInOrders
GET/api/{token}/transitinorders/list/
Список заявок на транзит (приём) с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitinorders/list/
GET/api/{token}/transitinorders/get/
Получение заявки на транзит (приём) по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitinorders/get/

Транзит исходящий

TransitOut
GET/api/{token}/transitout/list/
Список транзитных отгрузок с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitout/list/
GET/api/{token}/transitout/get/
Получение транзитной отгрузки по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitout/get/

Заявки: транзит исходящий

TransitOutOrders
GET/api/{token}/transitoutorders/list/
Список заявок на транзит (отгрузку) с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitoutorders/list/
GET/api/{token}/transitoutorders/get/
Получение заявки на транзит (отгрузку) по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].commentstringКомментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringТолько у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitoutorders/get/

Комплектации

Complectations
GET/api/{token}/complectations/list/
Список комплектаций с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется списокПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинетеПример: "Новая"
data[].commentstringКомментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа вместе с кодами маркировки
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectations/list/
GET/api/{token}/complectations/get/
Получение комплектации по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется списокПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинетеПример: "Новая"
data[].commentstringКомментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа вместе с кодами маркировки
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectations/get/

Заявки на комплектацию

ComplectationOrders
GET/api/{token}/complectationorders/list/
Список заявок на комплектацию с фильтрацией

Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).

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

ПараметрТипОписание
idsопциональноstringID документа или JSON-массив ID (например: 123 или [123, 124])
statusопциональноstringЧисловой статус или JSON-массив статусов (например: 0 или [0, 1])
dateопциональноstringДиапазон дат создания JSON-массивом: ["2026-01-01","2026-01-31"]
pageопциональноintegerСтраница (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЗаписей на страницу (по умолчанию и максимум 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок документов

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectНайденные документы, свежие сверху
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется списокПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинетеПример: "Новая"
data[].commentstringКомментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа вместе с кодами маркировки
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectationorders/list/
GET/api/{token}/complectationorders/get/
Получение заявки на комплектацию по ID

Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОstringID документа или JSON-массив ID

Пример запроса

200 OKДокумент (структура как у list)

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataarray of objectДокументы по переданным ID, без пагинации
data[].idintegerID документа, он же его номер в системеПример: 101
data[].date_timestringДата и время создания документаПример: "2026-07-01 12:00:00"
data[].statusintegerЧисловой статус документа, им же фильтруется списокПример: 0
data[].status_textstringНазвание статуса так, как оно показано в кабинетеПример: "Новая"
data[].commentstringКомментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].itemsarray of objectПозиции документа вместе с кодами маркировки
data[].items[].item_idintegerID карточки товара в системеПример: 55
data[].items[].articlestringАртикул товараПример: "SKU-1"
data[].items[].barcodestringОсновной штрихкод товараПример: "4600000000000"
data[].items[].namestringНазвание товараПример: "Товар"
data[].items[].countintegerКоличество товара в позиции документаПример: 2
data[].items[].cisarray of stringКоды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectationorders/get/

Отгрузки ФБО

ShipmentsFBO
GET/api/{token}/shipmentsfbo/list/
Получение списка отгрузок FBO

Возвращает список отгрузок. Поддерживает фильтрацию по статусам и диапазону дат. При указании флага with_packages=1 выгружаются короба. При указании with_packages=1 и with_items=1 внутри коробов выгружается их наполнение.

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

ПараметрТипОписание
statusопциональноstringJSON-массив статусов: ["Новая", "На сборке", "Ожидает отгрузки", "Отгружена", "На проверке клиентом", "Вручена получателю", "Собрана", "Аннулирована", "Принята в СЦ/Складе", "Принята в СЦ c разногласиями", "Отказ приемки в СЦ", "Ожидает приемку товара", "Ожидает поставку товара", "Черновик"]
dateопциональноstringJSON-массив даты [дата от, дата до] (YYYY-MM-DD)
with_packagesопциональноintegerФлаг выгрузки коробов (1 - выгружать, 0 - нет) По умолчанию 0.
with_itemsопциональноintegerФлаг выгрузки наполнения коробов (работает только при сопутствующем параметре with_packages=1) По умолчанию 0.
pageопциональноintegerНомер страницы (по умолчанию 1) По умолчанию 1.
limitопциональноintegerЛимит записей (1-30, по умолчанию 30) По умолчанию 30. Максимум 30.

Пример запроса

200 OKСписок отгрузок FBO

Поля ответа

ПолеТипОписание
statusstringOK при успешном ответе, ERROR при ошибкеПример: "OK"
dataobject (карта)Ключи объекта — это ID отгрузок (shipment_fbo_id)
data.*.shipment_fbo_idintegerID отгрузки FBO в системе, он же её номер в кабинетеПример: 101
data.*.date_timestringДата создания в системеПример: "2026-04-08 15:34:57"
data.*.statusstringТекущий статус отгрузкиПример: "Ожидает отгрузки"
data.*.laststatus_datetimestringВремя последнего изменения статусаПример: "2026-04-08 15:34:57"
data.*.close_datetimestringДата проведения Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipped_datetimestringДата передачи Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipped_targetstringПлощадка назначения Может быть null.Пример: "Маркетплейс Склад"
data.*.external_orderstringВнешний Id заказа Может быть null.Пример: "ORD-9921"
data.*.delivered_date_timestringДата вручения Может быть null.Пример: "2026-04-08 15:34:57"
data.*.dispatch_datestringПланируемая дата отгрузки Может быть null.Пример: "2026-04-08 15:34:57"
data.*.customfieldsobjectДополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.userobjectСотрудник, создавший отгрузку
data.*.user.first_namestringИмя сотрудникаПример: "Иван"
data.*.user.last_namestringФамилия сотрудникаПример: "Иванов"
data.*.packagesobject (карта)Динамический список коробов (появляется при with_packages=1). Ключи — номера коробов. Может быть null.
data.*.packages.*.numberintegerНомер коробаПример: 10
data.*.packages.*.barcodestringБаркод коробаПример: "WB_1234567"
data.*.packages.*.lengthintegerДлина в смПример: 40
data.*.packages.*.widthintegerШирина в смПример: 30
data.*.packages.*.heightintegerВысота в смПример: 20
data.*.packages.*.weightnumberВес в кгПример: 1.5
data.*.packages.*.external_package_idstringВнешний id короба Может быть null.
data.*.packages.*.datetime_print_barcodestringВремя печати баркода короба Может быть null.Пример: "2026-04-08 15:34:57"
data.*.packages.*.pallet_numberstringНомер паллета Может быть null.
data.*.packages.*.is_palletbooleanЯвляется ли паллетомПример: false
data.*.packages.*.itemsarray of objectСписок товаров внутри короба (появляется при with_items=1)
data.*.packages.*.items[].namestringНазвание товараПример: "Товар Кроссовки"
data.*.packages.*.items[].barcodestringШтрихкод товараПример: "4601234567"
data.*.packages.*.items[].countintegerКоличество товара в коробеПример: 1
data.*.packages.*.items[].cisarray of stringМассив кодов маркировки Честный Знак (КИЗ), отсканированных по товару в этом коробе
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/shipmentsfbo/list/

Reports

Reports
POST/itemsfix/mx3create/
МХ-3 FBS: запуск отчёта

Фоновое формирование существующего отчёта МХ-3 FBS по клиенту API-ключа. Период включительно, максимум 31 день. warehouse_id передаётся в query. Один активный отчёт на ключ в выбранном складе; повтор с теми же параметрами возвращает тот же report_id. Только клиентский API-ключ, globalapi не поддерживается.

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

ПараметрТипОписание
warehouse_idопциональноinteger

Тело запроса application/json

ПараметрТипОписание
date_fromОБЯЗАТЕЛЬНОstringПример: "2026-10-01"
date_toОБЯЗАТЕЛЬНОstringПример: "2026-10-23"
formatопциональноstringДопустимо: "pdf_zip", "pdf", "xlsx_zip". По умолчанию "pdf_zip".

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

202Состояние задания
400Некорректные параметры
403Нет доступа
404Чужое или неизвестное задание
409Другой отчёт ключа ещё формируется
410Срок доступа истёк
429Повторите запрос позже
Попробовать запрос
POST /itemsfix/mx3create/
GET/itemsfix/mx3status/
МХ-3 FBS: состояние

Состояния processing, ready, empty, failed. Опрашивайте не чаще раза в 5 секунд. Доступ только тем же действующим ключом и в том же складе. Ключ должен сохранять разрешение itemsfix/mx3create. Срок доступа 7 дней.

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

ПараметрТипОписание
warehouse_idопциональноinteger
report_idОБЯЗАТЕЛЬНОinteger

Пример запроса

200Состояние задания
400Некорректные параметры
403Нет доступа
404Чужое или неизвестное задание
409Другой отчёт ключа ещё формируется
410Срок доступа истёк
429Повторите запрос позже
Попробовать запрос
GET /itemsfix/mx3status/
GET/itemsfix/mx3download/
МХ-3 FBS: скачивание

Скачивание готового PDF или ZIP с PDF/XLSX без браузерной сессии. Требуется тот же действующий клиентский ключ и warehouse_id. Смена/отключение ключа, перенос клиента или снятие права mx3create закрывают доступ. 409: ещё не готово/нет данных; 410: срок 7 дней истёк или файл удалён. Ссылка без API-ключа не выдаётся.

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

ПараметрТипОписание
warehouse_idопциональноinteger
report_idОБЯЗАТЕЛЬНОinteger

Пример запроса

200Бинарный файл
403Нет доступа
404Чужое или неизвестное задание
409Файл ещё не готов или данных нет
410Файл недоступен или срок доступа истёк
Попробовать запрос
GET /itemsfix/mx3download/