Интеграция складской системы Целиком с внешними сервисами: создание и чтение документов, заказы 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 — обязательно.
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
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
id
integer
ID созданной заявки на отгрузку, он же её номер в кабинетеПример: 12345
delivery_info
object
Реквизиты доставки так, как их принял выбранный перевозчик. Состав полей зависит от перевозчика и тарифа
delivery_info.tariff_code
object
Код тарифа перевозчика
delivery_info.tariff_code.value
string
Значение реквизита
delivery_info.city
object
Город доставки в справочнике перевозчика
delivery_info.city.value
string
Значение реквизита
delivery_info.delivery_point
object
Код пункта выдачи, если тариф требует ПВЗ
delivery_info.delivery_point.value
string
Значение реквизита
Попробовать запрос
POST /api/{token}/dispatchorders/add/
POST/api/{token}/dispatchorders/addfile/
Добавление файла к существующей заявке на отгрузку
Метод прикладывает файлы (этикетки, документы) к уже созданной заявке. Файлы попадают в блок «Фотографии/документы» заявки - то же место, куда их кладут вручную в кабинете и откуда их берёт кладовщик.
Запрос отправляется только как multipart/form-data. Файлы добавляются к уже приложенным, ничего не затирая; одноимённый файл сохраняется под уникальным именем. Имя файла транслитерируется, расширение сохраняется.
Прикладывать файлы можно на любом этапе, кроме аннулированной заявки. Если файл нужно приложить сразу при создании, используйте file[] в методе dispatchorders/add.
Тело запроса multipart/form-data
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID заявки на отгрузку, он же её номер в кабинетеПример: 12345
file[]ОБЯЗАТЕЛЬНО
array of string
Массив файлов. Можно передать и один файл полем file
Пример запроса
200 OKРезультат обработки запроса
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
order_id
integer
ID заявки, к которой приложены файлыПример: 12345
files
array of string
Имена сохранённых файлов
Попробовать запрос
POST /api/{token}/dispatchorders/addfile/
POST/api/{token}/dispatchorders/send/
Отправка заявки на сборку
Метод подтверждает заявку и переводит её в статус сборки. При вызове создается запись об отгрузке (Shipment) и проверяется заполнение обязательных интеграционных полей.
Тело запроса application/json
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID заявки на отгрузкуПример: 12345
Примеры запроса
200 OKУспешная отправка на сборку
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
message
string
Пояснение к результатуПример: "Order successfully sent for processing"
order_id
integer
ID заявки, которую отправили на сборкуПример: 12345
shipment_id
integer
ID созданной отгрузкиПример: 6789
400Ошибка валидации или прав доступа
Попробовать запрос
POST /api/{token}/dispatchorders/send/
POST/api/{token}/dispatchorders/delete/
Удаление заявки на отгрузку
Полностью удаляет заявку из системы. При удалении все товары, зарезервированные в заказе, автоматически возвращаются на остатки склада (инвентаризируются обратно).
OK при успешном ответе, ERROR при ошибкеПример: "OK"
message
string
Пояснение к результату с номером удалённой заявкиПример: "Order with ID 12345 has been deleted"
400Ошибка при удалении (не найден или нет прав)
Попробовать запрос
POST /api/{token}/dispatchorders/delete/
GET/api/{token}/dispatchorders/get
Получение заявки на отгрузку
Возвращает заявку с детализацией по товарам, внешним ID и кодам маркировки (CIS).
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
Id заявки.
Пример запроса
200 OKУспешный ответ
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Заявки по переданным ID
data[].dispatch_date
string
Текущая планируемая дата отгрузки Может быть null.
data[].dispatch_date_change
object
Последний перенос после включения журнала: id, changed_at (время сервера), user_id, user_name, old_date, new_date (null при очистке), source (manual/system), reason_code, reason, comment. Начальная установка даты не является переносом; старые переносы задним числом не восстанавливаются Может быть null.
data[].dispatch_date_change.id
integer
ID события
data[].dispatch_date_change.changed_at
string
Время сервера, YYYY-MM-DD HH:mm:ss
data[].dispatch_date_change.user_id
integer
Автор; -1 для системного пользователя
data[].dispatch_date_change.user_name
string
Имя автора на момент переноса
data[].dispatch_date_change.old_date
string
data[].dispatch_date_change.new_date
string
Может быть null.
data[].dispatch_date_change.source
string
Ручное изменение в форме либо программное обновление Допустимо: "manual", "system".
data[].dispatch_date_change.reason_code
string
Код причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data[].dispatch_date_change.reason
string
Название причины на момент переноса
data[].dispatch_date_change.comment
string
data[].dispatch_date_history
array of object
История переносов, от новых к старым. Поля элементов такие же, как dispatch_date_change. Причина сохраняется на момент изменения, независимо от последующего редактирования справочника
data[].dispatch_date_history[].id
integer
ID события
data[].dispatch_date_history[].changed_at
string
Время сервера, YYYY-MM-DD HH:mm:ss
data[].dispatch_date_history[].user_id
integer
Автор; -1 для системного пользователя
data[].dispatch_date_history[].user_name
string
Имя автора на момент переноса
data[].dispatch_date_history[].old_date
string
data[].dispatch_date_history[].new_date
string
Может быть null.
data[].dispatch_date_history[].source
string
Ручное изменение в форме либо программное обновление Допустимо: "manual", "system".
data[].dispatch_date_history[].reason_code
string
Код причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data[].dispatch_date_history[].reason
string
Название причины на момент переноса
data[].dispatch_date_history[].comment
string
data[].orderid
integer
ID заявки на отгрузку в системеПример: 101
data[].externalid
string
Номер заявки во внешней системе клиента, если он передавался при созданииПример: "12345678"
data[].shipmentid
integer
ID отгрузки, созданной по заявке. 0, если заявка ещё не отправлена на сборкуПример: 550
data[].comment
string
Комментарий к заявке
data[].warehouse
string
Склад отгрузки маркетплейса. При транзите - склад сдачи, конечный склад в directionПример: "ДОМОДЕДОВО_РФЦ_КРОССДОКИНГ"
data[].direction
string
Направление (при транзите) из заявки: склад или кластер маркетплейса, куда товар едет дальше, если он сдаётся транзитом или кросс-докингом через склад из warehouse. Заполняется по поставке маркетплейса или вручную в заявке. Пустая строка, если направления нетПример: "Невинномысск"
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
data[].items
array of object
Состав заявки
data[].items[].article
string
Артикул товараПример: "SKU-99"
data[].items[].count
integer
Количество товара в заявкеПример: 2
data[].items[].cis
array of string
Массив кодов маркировки Честный Знак (КИЗ), отсканированных по товару при сборке (FBO-поставка и комплектация). Поле присутствует, только если сканы есть
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/dispatchorders/get
GET/api/{token}/dispatchorders/list/
Получение списка заявок на отгрузку (Dispatch)
Возвращает список заявок из системы отгрузок. Поддерживает фильтрацию по внутренним ID (ids), английским статусам заявки и диапазону дат. Данные сгруппированы по ID заявки.
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
JSON-массив внутренних ID заявок (например: [101, 102])
Лимит записей (1-30, по умолчанию 30) По умолчанию 30. Максимум 30.
Пример запроса
200 OKСписок заявок, сгруппированный по ID заявки
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
object (карта)
Ключи объекта — это ID заявок (orderid)
data.*.dispatch_date
string
Текущая планируемая дата отгрузки Может быть null.
data.*.dispatch_date_change
object
Последний перенос после включения журнала: id, changed_at (время сервера), user_id, user_name, old_date, new_date (null при очистке), source (manual/system), reason_code, reason, comment. Начальная установка даты не является переносом; старые переносы задним числом не восстанавливаются Может быть null.
data.*.dispatch_date_change.id
integer
ID события
data.*.dispatch_date_change.changed_at
string
Время сервера, YYYY-MM-DD HH:mm:ss
data.*.dispatch_date_change.user_id
integer
Автор; -1 для системного пользователя
data.*.dispatch_date_change.user_name
string
Имя автора на момент переноса
data.*.dispatch_date_change.old_date
string
data.*.dispatch_date_change.new_date
string
Может быть null.
data.*.dispatch_date_change.source
string
Ручное изменение в форме либо программное обновление Допустимо: "manual", "system".
data.*.dispatch_date_change.reason_code
string
Код причины; пустая строка, если причина не указана. Код пользовательской причины зависит от её текста
data.*.dispatch_date_change.reason
string
Название причины на момент переноса
data.*.dispatch_date_change.comment
string
data.*.orderid
integer
ID заявки на отгрузку в системеПример: 101
data.*.date_time
string
Дата создания заявки в системеПример: "2026-04-08 15:34:57"
data.*.externalid
string
ID в курьерской службе (Яндекс/СДЭК) Может быть null.
data.*.shipmentid
string
Id связанной отгрузки
data.*.status
string
Английский статус самой заявкиПример: "waitingdelivery"
data.*.comment
string
Комментарий к заявке
data.*.last_status_date_time
string
Время смены статусаПример: "2026-04-08 15:34:57"
data.*.addit_info
object
Дополнительная информация по отгрузке Может быть null.
data.*.customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.warehouse
string
Склад отгрузки маркетплейса. При транзите - склад сдачи, конечный склад в directionПример: "ДОМОДЕДОВО_РФЦ_КРОССДОКИНГ"
data.*.direction
string
Направление (при транзите) из заявки: склад или кластер маркетплейса, куда товар едет дальше, если он сдаётся транзитом или кросс-докингом через склад из warehouse. Заполняется по поставке маркетплейса или вручную в заявке. Пустая строка, если направления нетПример: "Невинномысск"
data.*.shipment_create_date
string
Дата создания отгрузки FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipment_status
string
Статус связанной отгрузки: Новая, На сборке, Ожидает отгрузки, Отгружена, На проверке клиентом, Вручена получателю, Собрана, Аннулирована, Принята в СЦ/Складе, Принята в СЦ c разногласиями, Отказ приемки в СЦ, Ожидает приемку товара, Ожидает поставку товара, Черновик Может быть null.Пример: "Ожидает отгрузки"
data.*.shipment_laststatus_datetime
string
Время последнего изменения статуса FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipment_shipped_datetime
string
Дата фактической передачи FBO Может быть null.Пример: "2026-04-08 15:34:57"
data.*.user
object
Сотрудник, создавший заявку
data.*.user.first_name
string
Имя сотрудникаПример: "Иван"
data.*.user.last_name
string
Фамилия сотрудникаПример: "Петров"
data.*.items
array of object
Состав заявки
data.*.items[].id
integer
ID товара
data.*.items[].article
string
Артикул товараПример: "MS-00123"
data.*.items[].name
string
Название товараПример: "Наименование товара"
data.*.items[].barcode
string
Основной штрихкод товараПример: "4601234567890"
data.*.items[].count
integer
Количество товара в заявкеПример: 1
data.*.items[].cis
array of string
Массив кодов маркировки Честный Знак (КИЗ), отсканированных по товару при сборке (FBO-поставка и комплектация)
data.*.items[].tz
array of string
Техническое задание
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/dispatchorders/list/
Заявки на приёмку
UnloadingOrders
GET/api/{token}/unloadingorders/list/
Получение списка заявок на приемку
Возвращает список заявок на приемку. Поддерживает фильтрацию по ID, статусам и диапазону дат. Содержит информацию по заявке на приемку и минимум информации по связанной приемке.
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
JSON-массив внутренних ID заявок
statusопционально
string
JSON-массив названий статусов
dateопционально
string
JSON-массив диапазона дат [от, до]
pageопционально
integer
Номер страницы (для пагинации) По умолчанию 1.
limitопционально
integer
Количество записей на страницу (max 30) По умолчанию 30.
Пример запроса
200 OKУспешный ответ со списком заявок
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
code
integer
HTTP-код результата, дублирует статус ответаПример: 200
data
object (карта)
Объект заявок, где ключом является ID заявки
data.*.unloading_order_id
integer
Номер
data.*.create_date_time
string
Дата создания
data.*.delivery_date_time
string
Дата поставки
data.*.status
string
Статус
data.*.comment
string
Комментарий к заявке
data.*.acceptance_sent_date
string
Дата отправки на приемку Может быть null.
data.*.confirm_date_time
string
Дата подтверждения состава Может быть null.
data.*.check_date
string
Дата проверки Может быть null.
data.*.additional_info
object
Дополнительная информация Может быть null.
data.*.customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.unloading_id
integer
ID разгрузки Может быть null.
data.*.unloading_status
string
Статус разгрузки Может быть null.
data.*.unloading_create_date
string
Дата создания разгрузки Может быть null.
data.*.unloading_time_start
string
Дата начала разгрузки Может быть null.
data.*.unloading_time_end
string
Дата окончания разгрузки Может быть null.
data.*.unloading_close_date
string
Дата закрытия Может быть null.
data.*.items
array of object
Список товаров в заявке
data.*.items[].item_id
integer
ID товара
data.*.items[].name
string
Название товара
data.*.items[].barcode
string
Баркод
data.*.items[].count
integer
Количество
data.*.items[].comment
string
Комментарий
data.*.items[].cis
array of string
Массив кодов маркировки Честный Знак (КИЗ), отсканированных по этому товару при разгрузке (включая коды, перенесённые на приемку при её проведении)
data.*.items[].tz
array of object
Техническое задание (детализация позиций, услуг и материалов)
data.*.items[].tz[].item
object
Может быть null.
data.*.items[].tz[].item.Price
number
Цена товара
data.*.items[].tz[].item.Count
integer
Количество
data.*.items[].tz[].item.MaterialsCount
integer
Количество материалов
data.*.items[].tz[].service
object
Может быть null.
data.*.items[].tz[].service.Name
string
Название услуги
data.*.items[].tz[].service.Price
number
Цена услуги
data.*.items[].tz[].material
object
Может быть null.
data.*.items[].tz[].material.Article
string
Артикул материала
data.*.items[].tz[].material.Name
string
Название материала
data.*.items[].tz[].material.Barcode
string
Штрихкод материала
* — ключ карты (обычно 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опционально
string
JSON-массив товаров (barcode или article + count). Обязателен при allow_itemless_acceptance = 0; при 1 и 2 может быть пустымПример: "[{\"barcode\":\"564637383243\",\"count\":1}]"
storage_typeопционально
string
Тип хранения: FBO (склад маркетплейса) или FBS (склад продавца) Допустимо: "FBO", "FBS". По умолчанию "FBO".
allow_itemless_acceptanceопционально
integer
0: Состав указан, 1: Принимать по факту, 2: Заполню позже Допустимо: 0, 1, 2. По умолчанию 0.
commentопционально
string
Комментарий к заявкеПример: "Заказ через API"
additinfoопционально
string
Дополнительная информация в формате JSONПример: "{\"external_id\": 12345}"
slot_idопционально
integer
Окно приёмки из метода slots/. Резервирует окно за черновиком; если зарезервировать не вышло, заявка всё равно создаётся, причина возвращается в поле slotПример: 34
customfieldsопционально
string
JSON-строка с дополнительными полями фулфилмента {системное_имя: значение}
fileопционально
array of string
Прикрепляемые файлы (картинки/документы)
Пример запроса
200 OKЗаявка успешно создана
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
unloading_order_id
integer
ID созданной заявки на приёмку, он же её номер в кабинетеПример: 3260
delivery_info
object
Декодированные данные из 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Список свободных окон
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
slots_enabled
integer
1 - склад принимает по окнам в этом периоде, 0 - окон нет, дата свободнаяПример: 1
unit
string
Единица ёмкости окнаПример: "заявок"
data
array of object
data[].slot_id
integer
Пример: 34
data[].date
string
Пример: "2026-08-21"
data[].time_start
string
Пример: "13:00"
data[].time_end
string
Пример: "15:00"
data[].free
number
Свободная ёмкость окнаПример: 2
data[].capacity
number
Всего ёмкости в окнеПример: 3
data[].whole_free
integer
1 - окно свободно целиком (годится для заявки без состава)Пример: 0
data[].book_until
string
Момент закрытия записи в окноПример: "2026-08-21 13:00:00"
data[].comment
string
Комментарий склада к окнуПример: "приём паллет"
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/unloadingorders/slots/
POST/api/{token}/unloadingorders/send/
Отправка заявки в работу
Переводит созданную заявку из черновика в очередь на приёмку: склад начинает её ждать. До вызова этого метода заявка складом не обрабатывается. В строгом режиме укажите slot_id (или забронируйте окно ещё в методе add). Без строгого режима можно отправить заявку без окна с указанными датой и временем поставки.
Тело запроса multipart/form-data
Параметр
Тип
Описание
unloading_order_idОБЯЗАТЕЛЬНО
integer
ID заявки на приёмкуПример: 3260
slot_idопционально
integer
Окно приёмки. Обязательно, если склад принимает по окнам, а окно ещё не забронированоПример: 34
Пример запроса
200 OKЗаявка отправлена в работу
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
unloading_order_id
integer
Пример: 3260
unloading_id
integer
ID созданной разгрузкиПример: 5006
slot
object
Забронированное окно, если склад принимает по окнам
400Ошибка: неподходящий статус, пустой состав, блокировка по балансу или недоступное окно
Попробовать запрос
POST /api/{token}/unloadingorders/send/
POST/api/{token}/unloadingorders/delete/
Удаление заявки на приемку
Удаляет заявку и все её позиции. Удаление возможно только для заявок в статусе 'Новая', при отсутствии привязанных разгрузок и активных резервов в заказах на отгрузку (Dispatch Orders).
Пример запроса
200 OKЗаявка успешно удалена
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
message
string
Пояснение к результату с номером удалённой заявкиПример: "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опционально
integer
ID склада 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.
Поля ответа
Поле
Тип
Описание
status
string
Persistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
delivery
integer
Тип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_id
string
Номер заказа интернет-магазина
provider
string
Допустимо: "ozon_delivery", "yandexgo", "cdek".
order_number
string
Внутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_ids
array of integer
ID товарных строк Orders; одна строка на единицу товара
stage
string
Этап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_number
string
Номер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmed
boolean
Подтверждены ли фактические вес и размеры
last_error
string
Сохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/add/
POST/api/{token}/orders/parcels/
Подтвердить посылки заказа магазина
До начала оформления у перевозчика. Передайте полный набор посылок с прежними request_id и составом. Сохраняет размеры и вес, само отправление не создаёт.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада 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.
Поля ответа
Поле
Тип
Описание
status
string
Persistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
delivery
integer
Тип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_id
string
Номер заказа интернет-магазина
provider
string
Допустимо: "ozon_delivery", "yandexgo", "cdek".
order_number
string
Внутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_ids
array of integer
ID товарных строк Orders; одна строка на единицу товара
stage
string
Этап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_number
string
Номер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmed
boolean
Подтверждены ли фактические вес и размеры
last_error
string
Сохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/parcels/
POST/api/{token}/orders/delivery/
Получить состояние доставки заказа магазина
По умолчанию читает журнал WMS. refresh=1 запрашивает статус перевозчика; отправление и этикетки не создаёт. Складские статусы доступны в orders/get и orders/list.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада 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.
Поля ответа
Поле
Тип
Описание
status
string
Persistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
delivery
integer
Тип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_id
string
Номер заказа интернет-магазина
provider
string
Допустимо: "ozon_delivery", "yandexgo", "cdek".
order_number
string
Внутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_ids
array of integer
ID товарных строк Orders; одна строка на единицу товара
stage
string
Этап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_number
string
Номер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmed
boolean
Подтверждены ли фактические вес и размеры
last_error
string
Сохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/delivery/
POST/api/{token}/orders/canceldelivery/
Запросить отмену отправления заказа магазина
Отменяет всё отправление у перевозчика, асинхронно. После запроса проверяйте orders/delivery с refresh=1 до stage=canceled. Не отменяет строки Orders и не возвращает товар на остатки. До оформления у перевозчика отменяйте заказ штатным действием WMS.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада 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.
Поля ответа
Поле
Тип
Описание
status
string
Persistent request and carrier exchange for shop FBS orders (CDEK / YandexGo). Допустимо: "OK".
delivery
integer
Тип доставки как в dispatchorders/add: 1 — CDEK, 4 — YandexGo, 5 — Ozon Delivery Допустимо: 1, 4, 5.
external_id
string
Номер заказа интернет-магазина
provider
string
Допустимо: "ozon_delivery", "yandexgo", "cdek".
order_number
string
Внутренний номер заказа WMS. Передавайте как orderId в orders/get; номер магазина хранится в external_id.
order_row_ids
array of integer
ID товарных строк Orders; одна строка на единицу товара
stage
string
Этап доставки: warehouse, creating, created, forming, ready, failed, cancel_pending, canceled, returned, delivered. Не статус складской сборки.
delivery_number
string
Номер отправления перевозчика; до оформления null. Для Ozon это номер заказа получателя. Может быть null.
parcels_confirmed
boolean
Подтверждены ли фактические вес и размеры
last_error
string
Сохранённая ошибка обмена или пустая строка
Попробовать запрос
POST /api/{token}/orders/canceldelivery/
GET/api/{token}/orders/get
Получение информации о заказе
Возвращает детали заказа по его OrderId с проверкой прав доступа юридического лица
Параметры запроса
Параметр
Тип
Описание
orderIdОБЯЗАТЕЛЬНО
string
Идентификатор заказа
Пример запроса
200 OKУспешный ответ
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Заказы по переданному номеру
data[].orderid
string
Номер заказа на площадке (тот же, что передавался в запросе)Пример: "12345"
data[].items
array of object
Состав заказа
data[].items[].article
string
Артикул товараПример: "A100"
data[].items[].count
integer
Количество товара в заказеПример: 2
data[].items[].cis
array of string
Коды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции при сборке: по одному на единицу товара. Пустой массив, если кодов нет. Разделитель GS передаётся символом \u001d
data[].items[].sticker
string
Номер этикетки/отправления как в колонке «Этикетка/доп инфо», без номера поставки. Для WB — видимый номер этикетки, а не закодированный barcode. null, если номер недоступен. Может быть null.Пример: "58972371585"
data[].items[].supply_id
string
Номер поставки маркетплейса из колонки «Этикетка/доп инфо» (для WB — WB-GI-...). null, если коннектор его не возвращает. Не является номером отгрузки WMS. Может быть null.Пример: "WB-GI-292835702"
data[].items[].shipment_id
integer
Номер отгрузки WMS, в которую входит позиция. null, если позиция ещё не в отгрузке. Может быть null.Пример: 1520
data[].items[].datetime_assembled
string
Дата окончания сборки позиции. null, если позиция ещё не собрана. Может быть null.Пример: "2026-04-09 10:15:00"
data[].status
string
Статус заказа. Коды: new (Новый), processing (На сборке), ondelivery (На отгрузке), ondeliverybylogistic (Принят в МП), return (Возврат из МП), canceled (Отменён), delivered (Вручён получателю), refused (Отказ получателя, возврат), ondeliverymp (На доставке, ожидает приёмку на МП), canceledafterpack (Отменён площадкой после сборки: собран, площадка просит не передавать), reshipment (Требуется повторная отгрузка) Допустимо: "new", "processing", "ondelivery", "ondeliverybylogistic", "return", "canceled", "delivered", "refused", "ondeliverymp", "canceledafterpack", "reshipment".Пример: "processing"
data[].marketplace
string
Площадка заказа, как в колонке «Площадка» в WMS (например, Ozon, Wildberries). Может быть null.Пример: "Ozon"
data[].marketplace_status
object
Последний сохранённый статус МП, как в колонке «Статус МП». Не заменяет status WMS. null, если наблюдения нет или строки сгруппированного заказа относятся к разным подключениям. Поддерживаются WB, Ozon и Яндекс Маркет. Не вызывает опрос МП. Фильтры status и status_date относятся к статусу WMS, а не к этому блоку. Может быть null.
data[].marketplace_status.code
string
Код статуса МП; подстатус Ozon/Яндекса, если есть, через ' / '.Пример: "sorted"
data[].marketplace_status.text
string
Название статуса, как в таблице WMS.Пример: "Принят WB (сортировка)"
data[].marketplace_status.observed_at
string
Когда WMS впервые получила текущий статус, UTC. Не точное время события на МП. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data[].marketplace_status.sorted_at
string
Первое получение sorted у WB, UTC; иначе null. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data[].zone
string
Зона отгрузки: зона из настроек подключения к площадке, через которое пришёл заказ. null, если зона не задана. Может быть null.Пример: "Склад Север"
data[].shipment_id
integer
Номер отгрузки WMS (колонка «№ отгрузки»). null, если заказ ещё не в отгрузке или его позиции в разных отгрузках: тогда номер смотрите в items[].shipment_id. Может быть null.Пример: 1520
data[].datetime_assembled
string
Дата окончания сборки заказа: когда собрана последняя позиция. 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опционально
string
JSON-массив строковых или числовых ID заказов (например: ["ЗАКАЗ-1", "ЗАКАЗ-2"]). Если передан, пагинация игнорируется.
statusопционально
string
JSON-массив статусов. Коды: 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Успешный ответ со списком заказов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
object (карта)
Ключи объекта — это внешние/внутренние ID заказов (orderid)
data.*.orderid
string
ID заказаПример: "12345"
data.*.datetime
string
Дата создания заказа в системеПример: "2026-04-08 15:34:57"
data.*.datetime_shipped
string
Дата отгрузки заказа Может быть null.Пример: "2026-04-09 11:20:00"
data.*.status
string
Текущий статус заказа. Коды: new (Новый), processing (На сборке), ondelivery (На отгрузке), ondeliverybylogistic (Принят в МП), return (Возврат из МП), canceled (Отменён), delivered (Вручён получателю), refused (Отказ получателя, возврат), ondeliverymp (На доставке, ожидает приёмку на МП), canceledafterpack (Отменён площадкой после сборки: собран, площадка просит не передавать), reshipment (Требуется повторная отгрузка)Пример: "processing"
data.*.last_status_date_time
string
Дата последней смены статусаПример: "2026-04-08 16:00:15"
data.*.marketplace
string
Площадка заказа, как в колонке «Площадка» в WMS (например, Ozon, Wildberries). Может быть null.Пример: "Ozon"
data.*.marketplace_status
object
Последний сохранённый статус МП, как в колонке «Статус МП». Не заменяет status WMS. null, если наблюдения нет или строки сгруппированного заказа относятся к разным подключениям. Поддерживаются WB, Ozon и Яндекс Маркет. Не вызывает опрос МП. Фильтры status и status_date относятся к статусу WMS, а не к этому блоку. Может быть null.
data.*.marketplace_status.code
string
Код статуса МП; подстатус Ozon/Яндекса, если есть, через ' / '.Пример: "sorted"
data.*.marketplace_status.text
string
Название статуса, как в таблице WMS.Пример: "Принят WB (сортировка)"
data.*.marketplace_status.observed_at
string
Когда WMS впервые получила текущий статус, UTC. Не точное время события на МП. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data.*.marketplace_status.sorted_at
string
Первое получение sorted у WB, UTC; иначе null. Может быть null.Пример: "2026-11-01T10:00:00.000000Z"
data.*.zone
string
Зона отгрузки: зона из настроек подключения к площадке, через которое пришёл заказ. null, если зона не задана. Может быть null.Пример: "Склад Север"
data.*.shipment_id
integer
Номер отгрузки WMS (колонка «№ отгрузки»). null, если заказ ещё не в отгрузке или его позиции в разных отгрузках: тогда номер смотрите в items[].shipment_id. Может быть null.Пример: 1520
data.*.datetime_assembled
string
Дата окончания сборки заказа: когда собрана последняя позиция. null, пока собраны не все позиции. Это не дата передачи на площадку. Не путать с datetime_shipped. Может быть null.Пример: "2026-04-09 10:15:00"
data.*.items
array of object
data.*.items[].id
integer
ID товарной позиции
data.*.items[].article
string
Артикул товараПример: "ART-772"
data.*.items[].name
string
Наименование товараПример: "Футболка белая XL"
data.*.items[].barcode
string
Штрихкод товараПример: "4601234567890"
data.*.items[].count
integer
Количество единицПример: 1
data.*.items[].cis
array of string
Коды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции при сборке: по одному на единицу товара. Пустой массив, если кодов нет. Разделитель GS передаётся символом \u001d
data.*.items[].sticker
string
Номер этикетки/отправления как в колонке «Этикетка/доп инфо», без номера поставки. Для WB — видимый номер этикетки, а не закодированный barcode. null, если номер недоступен. Может быть null.Пример: "58972371585"
data.*.items[].supply_id
string
Номер поставки маркетплейса из колонки «Этикетка/доп инфо» (для WB — WB-GI-...). null, если коннектор его не возвращает. Не является номером отгрузки WMS. Может быть null.Пример: "WB-GI-292835702"
data.*.items[].shipment_id
integer
Номер отгрузки WMS, в которую входит позиция. null, если позиция ещё не в отгрузке. Может быть null.Пример: 1520
data.*.items[].datetime_assembled
string
Дата окончания сборки позиции. 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опционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
api_idОБЯЗАТЕЛЬНО
integer
ID подключения 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.
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
id
integer
ID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_id
string
Номер, переданный клиентом при addПример: "shop-order-1001"
workflow
string
Допустимо: "fbo", "fbs".
dispatch_order_id
integer
ID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_number
string
Внутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_number
string
Номер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stage
string
Этап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postings
array of object
Отправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_id
integer
postings[].posting_number
string
Номер отправления Ozon
postings[].posting_external_id
string
posting_statuses
array of object
Последние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_number
string
posting_statuses[].status
string
Статус перевозчика, например ready_for_shipping, delivered, canceled
last_error
string
Сохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/add/
POST/api/{token}/ozondeliveryorders/parcels/
Подтвердить фактические размеры посылок FBS
Только workflow=fbs, до первой попытки создания у Ozon. Передайте полный массив посылок с прежними request_id: можно уточнить вес, размеры, стоимость и описание; добавлять/удалять посылки или менять состав нельзя. Подтверждение сохраняется в WMS; метод сам не создаёт и не подтверждает отправление у перевозчика.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID 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.
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
id
integer
ID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_id
string
Номер, переданный клиентом при addПример: "shop-order-1001"
workflow
string
Допустимо: "fbo", "fbs".
dispatch_order_id
integer
ID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_number
string
Внутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_number
string
Номер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stage
string
Этап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postings
array of object
Отправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_id
integer
postings[].posting_number
string
Номер отправления Ozon
postings[].posting_external_id
string
posting_statuses
array of object
Последние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_number
string
posting_statuses[].status
string
Статус перевозчика, например ready_for_shipping, delivered, canceled
last_error
string
Сохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/parcels/
POST/api/{token}/ozondeliveryorders/get/
Состояние заказа Ozon Delivery в WMS
Читает сохранённое состояние текущего клиента и склада без обращения к Ozon. Пустые postings и ozon_order_number=null означают, что номер отправления ещё не получен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501
Примеры запроса
200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
id
integer
ID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_id
string
Номер, переданный клиентом при addПример: "shop-order-1001"
workflow
string
Допустимо: "fbo", "fbs".
dispatch_order_id
integer
ID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_number
string
Внутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_number
string
Номер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stage
string
Этап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postings
array of object
Отправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_id
integer
postings[].posting_number
string
Номер отправления Ozon
postings[].posting_external_id
string
posting_statuses
array of object
Последние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_number
string
posting_statuses[].status
string
Статус перевозчика, например ready_for_shipping, delivered, canceled
last_error
string
Сохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/get/
POST/api/{token}/ozondeliveryorders/checkout/
Предварительный расчёт Ozon Delivery
Обращается к Ozon для проверки получателя и расчёта. Не создаёт документы, резервы или заказ перевозчика. Наш метод принимает полный адрес courier, как add; в запрос расчёта к Ozon передаёт только координаты. shipment_method_id берётся из подключения api_id.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
api_idОБЯЗАТЕЛЬНО
integer
ID подключения 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
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
data
object
Ответ /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опционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
api_idОБЯЗАТЕЛЬНО
integer
ID подключения Ozon Delivery текущего клиента и складаПример: 123
cursorопционально
string
next_cursor предыдущего ответа; для первой страницы пропустить или передать пустую строку — WMS не передаст курсор в Ozon По умолчанию "".
Примеры запроса
200 OKСтраница ПВЗ Ozon либо ошибка обработки WMS
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
delivery_points
array of object
Объекты ПВЗ из /v1/delivery-point/info Ozon, без изменения их структуры
next_cursor
string
Курсор продолжения; пустая строка означает конец списка
Попробовать запрос
POST /api/{token}/ozondeliveryorders/points/
POST/api/{token}/ozondeliveryorders/refresh/
Обновить статусы Ozon Delivery
Запрашивает статусы уже известных отправлений и сохраняет их в журнал WMS. Не создаёт заказ, не скачивает этикетки и не меняет остатки; без известных отправлений возвращает текущее состояние. Статусы складских документов обновляются штатными обработчиками склада.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501
Примеры запроса
200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
id
integer
ID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_id
string
Номер, переданный клиентом при addПример: "shop-order-1001"
workflow
string
Допустимо: "fbo", "fbs".
dispatch_order_id
integer
ID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_number
string
Внутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_number
string
Номер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stage
string
Этап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postings
array of object
Отправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_id
integer
postings[].posting_number
string
Номер отправления Ozon
postings[].posting_external_id
string
posting_statuses
array of object
Последние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_number
string
posting_statuses[].status
string
Статус перевозчика, например ready_for_shipping, delivered, canceled
last_error
string
Сохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
POST /api/{token}/ozondeliveryorders/refresh/
POST/api/{token}/ozondeliveryorders/cancel/
Запросить отмену заказа у Ozon Delivery
Только для уже созданных у Ozon отправлений. Асинхронно: cancel_pending означает запрос отмены; проверяйте refresh до canceled у всех посылок. Доставленное отправление отменить нельзя. При неопределённом результате создания сначала требуется восстановить его с сохранённым ключом. До создания в Ozon отменяйте складской документ штатным способом. Метод не отменяет складские документы и не возвращает товар на остатки.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
ID склада WMS. Рекомендуется указывать явно: иначе используется склад клиента по умолчанию. Подключение api_id и запрашиваемый заказ должны принадлежать этому складу.
Тело запроса application/json
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID OzonDeliveryOrders из поля id ответа ozondeliveryorders/add, не dispatch_order_idПример: 501
Примеры запроса
200 OKРезультат WMS; проверяйте status в JSON. Наличие id не означает создание отправления в Ozon.
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK".
id
integer
ID журнала OzonDeliveryOrders в WMS. Передавать в get/parcels/refresh/cancel; НЕ в dispatchorders/send.Пример: 501
external_id
string
Номер, переданный клиентом при addПример: "shop-order-1001"
workflow
string
Допустимо: "fbo", "fbs".
dispatch_order_id
integer
ID заявки DispatchOrders для workflow=fbo; передать как id в dispatchorders/send. Для FBS равен 0.Пример: 0
wms_order_number
string
Внутренний номер OD-UUID. Для FBS это OrderId строк штатной модели Orders; не числовой ID строки.Пример: "OD-123e4567-e89b-42d3-a456-426614174000"
ozon_order_number
string
Номер заказа у Ozon. До оформления у перевозчика равен null. Может быть null.
stage
string
Этап обмена, не статус складской сборки: warehouse, creating, created, forming, ready, cancel_pending, canceled, delivered. ready означает готовность и сохранение этикеток.Пример: "warehouse"
postings
array of object
Отправления, полученные при создании у Ozon. До создания пустой массив; сопоставлять по request_id.
postings[].request_id
integer
postings[].posting_number
string
Номер отправления Ozon
postings[].posting_external_id
string
posting_statuses
array of object
Последние ответы Ozon по отправлениям. Могут содержать дополнительные поля перевозчика; сопоставлять по posting_number.
posting_statuses[].posting_number
string
posting_statuses[].status
string
Статус перевозчика, например ready_for_shipping, delivered, canceled
last_error
string
Сохранённая ошибка обмена; пустая строка, если ошибки нет
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
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ОБЯЗАТЕЛЬНО
integer
ID карточки из items/get
codesОБЯЗАТЕЛЬНО
array of string
Примеры запроса
200 OKРезультат импорта, включая пропуски и ошибки отдельных кодов
Поля ответа
Поле
Тип
Описание
status
string
Допустимо: "OK", "PARTIAL".
item_id
integer
import_id
integer
Номер загрузки в истории импорта ЧЗ
total
integer
added
integer
exists
integer
invalid
integer
results
array of object
results[].index
integer
Индекс исходного кода с нуля
results[].status
string
Допустимо: "added", "exists", "invalid".
results[].message
string
Причина отклонения, для 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
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
created
boolean
Пример: true
item
object
item.id
integer
Пример: 123
item.name
string
Пример: "Футболка"
item.article
string
Пример: "TS-01"
item.barcode
string
Пример: "04601234567893"
item.color
string
Пример: "Белый"
item.size
string
Пример: "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опционально
string
ID товара или 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Список товаров
Поля ответа
Поле
Тип
Описание
Id
integer
ID карточки товара в системеПример: 1
Name
string
Название товараПример: "Товар №1"
Fbs
integer
Остаток FBS (склад продавца)Пример: 7
Fbo
integer
Остаток FBO (склад маркетплейса)Пример: 3
Count
integer
Общий остатокПример: 10
CountVirtual
integer
Виртуальный остатокПример: 5
Article
string
Артикул товараПример: "SKU-123"
Barcodes
array of string
Все штрихкоды карточки: основной и дополнительные
Complect
string
Состав комплекта: ID составляющих через запятую (пустая строка — обычный товар)Пример: ""
ParentItem
integer
ID родительской карточки для подчинённого товара; 0 если связи нетПример: 0
KitComplect
string
Состав собираемого комплекта: ID компонентов через запятую; повтор ID означает количество. Пустая строка если состава нетПример: ""
Quant
string
Состав кванта: ID единичного товара через запятую с повторением по кратности; пустая строка если кванта нетПример: ""
QuantLocal
integer
ID локальной карточки для расквантовки; 0 если не заданаПример: 0
Цвет, текстовое значение; не ID справочникаПример: "Черный"
Size
string
Размер, текстовое значение; не ID справочникаПример: "M"
Weight
integer
Вес в граммахПример: 100
Length
integer
Длина в миллиметрахПример: 100
Width
integer
Ширина в миллиметрахПример: 100
Height
integer
Высота в миллиметрахПример: 100
Volume
number
Объём в кубических метрах, рассчитан по габаритам карточки и округлён до 6 знаковПример: 0.001
CMarkTotal
integer
Кодов «Честного знака» загружено на карточку всего (первое число в колонке «Честный знак» в разделе «Товары»)Пример: 130
CMarkFree
integer
Кодов «Честного знака» доступно, то есть ещё не отправлено на печать (второе число в колонке «Честный знак» в разделе «Товары»)Пример: 128
CMarkGroup
integer
ID группы «Честного знака», 0 если карточка не в группе. Если не 0, коды общие для всех карточек группы и CMarkTotal/CMarkFree одинаковы у каждой из нихПример: 0
customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
Попробовать запрос
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Сохранённый срез, включая нулевой объём
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
data.snapshot_id
integer
data.client_id
integer
data.warehouse_id
integer
data.date
string
data.volume_start
number
Пример: 2.5
data.volume_end
number
Пример: 2.2999999999999998
data.volume_unit
string
Пример: "m3"
data.source
string
Пример: "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опционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].source_type
string
Только у приёмок: тип документа-источника (например, Inventory, Transfer, Unloadings, Complectations). Пустая строка у приёмки без источникаПример: "Unloadings"
data[].source_id
integer
Только у приёмок: ID документа-источника в WMS. Используется вместе с source_type; 0, если документ-источник не указанПример: 123
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array 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ОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].source_type
string
Только у приёмок: тип документа-источника (например, Inventory, Transfer, Unloadings, Complectations). Пустая строка у приёмки без источникаПример: "Unloadings"
data[].source_id
integer
Только у приёмок: ID документа-источника в WMS. Используется вместе с source_type; 0, если документ-источник не указанПример: 123
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array 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Успешный возврат списка разгрузок
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
code
integer
HTTP-код результата, дублирует статус ответаПример: 200
data
object (карта)
Ключи объекта — это ID разгрузок
data.*.unloading_id
integer
ID разгрузки, он же её номер в кабинете
data.*.date_time
string
Дата и время создания разгрузки
data.*.date_time_start
string
Когда разгрузку начали Может быть null.
data.*.date_time_end
string
Когда разгрузку закончили Может быть null.
data.*.status
string
Статус разгрузки словами: Новая, В работе, Ожидает закрытия, Закрыта, На проверке, Принята
data.*.unloading_order_id
integer
ID заявки на приёмку, по которой сделана разгрузка Может быть null.
data.*.externalid
string
Номер поставки во внешней системе клиента, если он передавался Может быть null.
data.*.shipmentid
integer
ID связанной отгрузки, если разгрузка сделана по ней Может быть null.
data.*.customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.user
object
Сотрудник, создавший разгрузку
data.*.user.first_name
string
Имя сотрудника
data.*.user.last_name
string
Фамилия сотрудника
data.*.incomes
array of object
Приёмки, сделанные по этой разгрузке
data.*.incomes[].id
integer
ID приёмки
data.*.incomes[].date_time
string
Дата создания приемки
data.*.incomes[].close_date_time
string
Дата проведения приемки
data.*.items
array of object
Фактически разгруженные товары (суммарно по всем грузоместам)
data.*.items[].item_id
integer
ID товара
data.*.items[].name
string
Название товара
data.*.items[].barcode
string
Штрихкод
data.*.items[].count
integer
Количество
data.*.items[].cis
array of string
Массив кодов маркировки Честный Знак (КИЗ), отсканированных по этому товару при разгрузке (включая коды, перенесённые на приемку при её проведении)
* — ключ карты (обычно ID документа), [] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/unloadings/list/
Инвентаризации
Inventory
GET/api/{token}/inventory/list/
Список инвентаризаций с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/inventory/list/
GET/api/{token}/inventory/get/
Получение инвентаризации по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/inventory/get/
Перемещения
Transfer
GET/api/{token}/transfer/list/
Список перемещений с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transfer/list/
GET/api/{token}/transfer/get/
Получение перемещения по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transfer/get/
Заявки на перемещение
TransferOrders
GET/api/{token}/transferorders/list/
Список заявок на перемещение с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transferorders/list/
GET/api/{token}/transferorders/get/
Получение заявки на перемещение по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transferorders/get/
Возвратные заявки
ReturnOrders
GET/api/{token}/returnorders/list/
Список заявок на возврат с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnorders/list/
GET/api/{token}/returnorders/get/
Получение заявки на возврат по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnorders/get/
Обработки возвратов
ReturnProcess
GET/api/{token}/returnprocess/list/
Список обработок возвратов с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnprocess/list/
GET/api/{token}/returnprocess/get/
Получение обработки возвратов по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/returnprocess/get/
Транзит входящий
TransitIn
GET/api/{token}/transitin/list/
Список транзитных приёмок с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitin/list/
GET/api/{token}/transitin/get/
Получение транзитной приёмки по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitin/get/
Заявки: транзит входящий
TransitInOrders
GET/api/{token}/transitinorders/list/
Список заявок на транзит (приём) с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitinorders/list/
GET/api/{token}/transitinorders/get/
Получение заявки на транзит (приём) по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitinorders/get/
Транзит исходящий
TransitOut
GET/api/{token}/transitout/list/
Список транзитных отгрузок с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitout/list/
GET/api/{token}/transitout/get/
Получение транзитной отгрузки по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitout/get/
Заявки: транзит исходящий
TransitOutOrders
GET/api/{token}/transitoutorders/list/
Список заявок на транзит (отгрузку) с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitoutorders/list/
GET/api/{token}/transitoutorders/get/
Получение заявки на транзит (отгрузку) по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется список. У инвентаризаций статуса нет, поэтому поле не отдаётсяПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинете. Отдаётся вместе со statusПример: "Новая"
data[].comment
string
Комментарий к документу. Отдаётся только у тех типов документов, где это поле есть (заявки на комплектацию, возврат, перемещение, транзит, инвентаризации)Пример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа. У типов документов без подтаблицы позиций (обработка возвратов, транзитные документы) список всегда пустой
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Только у приёмок: коды ЧЗ, привязанные к строке приёмки, без кодов из пула карточки товара. Разделитель GS передаётся символом \u001d. Если привязанных кодов нет, возвращается пустой массив
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/transitoutorders/get/
Комплектации
Complectations
GET/api/{token}/complectations/list/
Список комплектаций с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется списокПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинетеПример: "Новая"
data[].comment
string
Комментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа вместе с кодами маркировки
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Коды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectations/list/
GET/api/{token}/complectations/get/
Получение комплектации по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется списокПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинетеПример: "Новая"
data[].comment
string
Комментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа вместе с кодами маркировки
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Коды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectations/get/
Заявки на комплектацию
ComplectationOrders
GET/api/{token}/complectationorders/list/
Список заявок на комплектацию с фильтрацией
Возвращает список документов клиента: шапка (id, дата, статус), позиции и дополнительные поля (customfields). Фильтры ids/status/date, пагинация page/limit (до 30).
Параметры запроса
Параметр
Тип
Описание
idsопционально
string
ID документа или 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Список документов
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Найденные документы, свежие сверху
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется списокПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинетеПример: "Новая"
data[].comment
string
Комментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа вместе с кодами маркировки
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array of string
Коды маркировки «Честный знак» (КИЗ), отсканированные по этой позиции. Разделитель GS передаётся символом \u001d. Пустой массив, если по позиции коды не сканировали
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /api/{token}/complectationorders/list/
GET/api/{token}/complectationorders/get/
Получение заявки на комплектацию по ID
Возвращает документ(ы) по ID. Структура ответа как у списка (list), без пагинации.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
string
ID документа или JSON-массив ID
Пример запроса
200 OKДокумент (структура как у list)
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
array of object
Документы по переданным ID, без пагинации
data[].id
integer
ID документа, он же его номер в системеПример: 101
data[].date_time
string
Дата и время создания документаПример: "2026-07-01 12:00:00"
data[].status
integer
Числовой статус документа, им же фильтруется списокПример: 0
data[].status_text
string
Название статуса так, как оно показано в кабинетеПример: "Новая"
data[].comment
string
Комментарий к документу. Есть у заявки на комплектацию, у самой комплектации поля нетПример: ""
data[].customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}. Отдаются только поля, помеченные для выгрузки в API
data[].items
array of object
Позиции документа вместе с кодами маркировки
data[].items[].item_id
integer
ID карточки товара в системеПример: 55
data[].items[].article
string
Артикул товараПример: "SKU-1"
data[].items[].barcode
string
Основной штрихкод товараПример: "4600000000000"
data[].items[].name
string
Название товараПример: "Товар"
data[].items[].count
integer
Количество товара в позиции документаПример: 2
data[].items[].cis
array 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опционально
string
JSON-массив статусов: ["Новая", "На сборке", "Ожидает отгрузки", "Отгружена", "На проверке клиентом", "Вручена получателю", "Собрана", "Аннулирована", "Принята в СЦ/Складе", "Принята в СЦ c разногласиями", "Отказ приемки в СЦ", "Ожидает приемку товара", "Ожидает поставку товара", "Черновик"]
dateопционально
string
JSON-массив даты [дата от, дата до] (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
Поля ответа
Поле
Тип
Описание
status
string
OK при успешном ответе, ERROR при ошибкеПример: "OK"
data
object (карта)
Ключи объекта — это ID отгрузок (shipment_fbo_id)
data.*.shipment_fbo_id
integer
ID отгрузки FBO в системе, он же её номер в кабинетеПример: 101
data.*.date_time
string
Дата создания в системеПример: "2026-04-08 15:34:57"
data.*.status
string
Текущий статус отгрузкиПример: "Ожидает отгрузки"
data.*.laststatus_datetime
string
Время последнего изменения статусаПример: "2026-04-08 15:34:57"
data.*.close_datetime
string
Дата проведения Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipped_datetime
string
Дата передачи Может быть null.Пример: "2026-04-08 15:34:57"
data.*.shipped_target
string
Площадка назначения Может быть null.Пример: "Маркетплейс Склад"
data.*.external_order
string
Внешний Id заказа Может быть null.Пример: "ORD-9921"
data.*.delivered_date_time
string
Дата вручения Может быть null.Пример: "2026-04-08 15:34:57"
data.*.dispatch_date
string
Планируемая дата отгрузки Может быть null.Пример: "2026-04-08 15:34:57"
data.*.customfields
object
Дополнительные поля, настроенные фулфилментом {системное_имя: значение}
data.*.user
object
Сотрудник, создавший отгрузку
data.*.user.first_name
string
Имя сотрудникаПример: "Иван"
data.*.user.last_name
string
Фамилия сотрудникаПример: "Иванов"
data.*.packages
object (карта)
Динамический список коробов (появляется при with_packages=1). Ключи — номера коробов. Может быть null.
data.*.packages.*.number
integer
Номер коробаПример: 10
data.*.packages.*.barcode
string
Баркод коробаПример: "WB_1234567"
data.*.packages.*.length
integer
Длина в смПример: 40
data.*.packages.*.width
integer
Ширина в смПример: 30
data.*.packages.*.height
integer
Высота в смПример: 20
data.*.packages.*.weight
number
Вес в кгПример: 1.5
data.*.packages.*.external_package_id
string
Внешний id короба Может быть null.
data.*.packages.*.datetime_print_barcode
string
Время печати баркода короба Может быть null.Пример: "2026-04-08 15:34:57"
data.*.packages.*.pallet_number
string
Номер паллета Может быть null.
data.*.packages.*.is_pallet
boolean
Является ли паллетомПример: false
data.*.packages.*.items
array of object
Список товаров внутри короба (появляется при with_items=1)
data.*.packages.*.items[].name
string
Название товараПример: "Товар Кроссовки"
data.*.packages.*.items[].barcode
string
Штрихкод товараПример: "4601234567"
data.*.packages.*.items[].count
integer
Количество товара в коробеПример: 1
data.*.packages.*.items[].cis
array 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-ключа не выдаётся.