Финансы, складские документы и операционная сводка фулфилмента. Только чтение, доступ по складам, клиентам и методам.
Общая информация
API работает поверх HTTPS и возвращает JSON. Каждая площадка Целикома имеет собственный домен, все запросы отправляются на домен вашего инстанса:
https://{clientName}/extapi/v1/…
Токен ключа передаётся в заголовке каждого запроса:
Authorization: Bearer ffapi_…
Операционное API фулфилмента (v1.4)
API для ФФ доступно только на тарифе «Максимальный» и предназначено для собственных интеграций фулфилмента. Доступ и ключи этого API не передаются клиентам фулфилмента.
Отдельно от клиентского API. Только GET: финансовые документы, складские операции и справочники площадки. Ключ выдаётся в Настройки → Внешнее API. Новые операционные методы всегда нужно разрешать явно: пустой список сохраняет только прежние финансовые права.
Услуги и история (v1.4)
Новые разрешения выдаются ключу явно: services-provided/list, document-calculations/get, document-history/list, bills/sources, users/list. Для расчётов добавьте include_calculations=1 к одиночному чтению incomes или shipments-fbo. Для истории нужно также право чтения соответствующего документа. bills/sources добавляет source к строкам счёта без отдельного URL. document-calculations/get — право на дополнительное поле, а не отдельный URL. Прежние ответы без новых прав/параметра сохраняются. Расчёты только сохранённые, запись и перерасчёт через API не поддерживаются. Пустой расчёт: state=empty; повреждённый: state=invalid, sum=null. До 8 МиБ исходных расчётов за запрос, до 4 МиБ/5000 строк на расчёт, превышение — 422.
Границы доступа
У ключа есть разрешённые склады и клиенты (пусто — все). Каждый запрос выполняется в одном активном складе: warehouse_id или склад ключа по умолчанию. Для отчёта по нескольким складам сделайте отдельный запрос по каждому. Смешанная отгрузка FBS, перевозка или задание с чужими клиентами скрывается целиком. С ограничением клиентов перевозки с транзитом/транспортными контейнерами и задания других типов не выдаются. Эти же ограничения действуют в сводке и связанных документах. Финансовые списки также ограничиваются клиентами; справочник контрагентов при ограничении клиентов недоступен.
Остатки, резервы и движения (v1.2)
Для ключа явно разрешите stocks/list, stocks/get, stock-reservations/list и stock-movements/list. Склад выбирается warehouse_id, клиент — client_id в пределах прав ключа. Доступ к товару определяется владельцем карточки, а не клиентом документа. Ключ площадки без ограничения клиентов может получать данные всех клиентов. Материалы не включены.
GET /extapi/v1/stocks/?warehouse_id=1&limit=100 — учётные остатки FBS/FBO. GET /extapi/v1/stocks/123/?warehouse_id=1 — остаток одной карточки. GET /extapi/v1/stock-reservations/?warehouse_id=1&item_id=123 — текущие резервы товара. GET /extapi/v1/stock-movements/?warehouse_id=1&item_id=123&date_from=2026-10-01&date_to=2026-10-15 — движения за период.
В stocks каждая карточка содержит fbs и fbo. physical и reserved относятся к годному товару; rejected_physical и rejected_reserved — отдельно к браку. unreserved = physical − reserved. available исключает замороженные зоны и свободный товар в сборочной таре, frozen показывает заблокированную часть незарезервированного остатка. Это складской свободный остаток, а не итог отправки на конкретный маркетплейс с его настройками и лимитами. Отрицательные учётные значения не скрываются: balance_anomaly сигнализирует о необходимости проверки.
stock_basis=own_register: выдаются собственные учётные записи карточки. Для подчинённой карточки или виртуального комплекта (is_derived=true) остаток родителя/составляющих повторно не вычисляется и не дублируется. Это учётная выгрузка, а не каталог доступности виртуальных товаров для продажи. Списки stocks и stock-reservations обходят каталог по ID товара, включая архивные и нулевые карточки. Каталог общий для складов; ноль означает отсутствие учётного остатка на выбранном складе.
stock-reservations возвращает текущий остаток виртуальных записей, сгруппированный по товару, источнику, партии, месту, FBS/FBO и браку. В data — карточки с вложенным reservations (может быть пустым). Курсор after_id здесь — ID товара; limit ограничивает число карточек, вложенный состав страницы — 5000 срезов. При превышении HTTP 422: уменьшите limit или задайте item_id/stock_type/place. Даты для текущих остатков и резервов не поддерживаются.
stock-movements: after_id — ID записи регистра, quantity_delta — знаковое изменение, is_virtual отличает резерв от физического движения. Фильтры date_from/date_to относятся к дате записи. Регистр может изменяться и очищаться при отмене/перепроведении документов: append_only=false, этот метод не гарантирует полную историю и не подходит для постоянной синхронизации только по максимальному ID. Обновляйте остатки и нужный период движений повторно. Между страницами нет общего снимка; generated_at — время формирования ответа. source_type/source_id — ссылка на источник в WMS, не универсальный URL API. При ограничении клиентов ключа source_id и income_line_id скрываются (null), чтобы не раскрывать ссылки на документы других клиентов общей группы.
Как получить ежедневный отчёт
Разрешите ключу operations/summary и shipments-fbo/list.
GET /extapi/v1/operations/summary/?date=2026-10-14&warehouse_id=1
Сводка включает неаннулированные FBO на выбранную дату и незавершённые FBO за предыдущие даты. В totals planned и overdue — отдельные группы, остальные счётчики относятся ко всей этой совокупности и могут пересекаться. Отгрузки без плановой даты не входят.
Для детализации откройте /extapi/v1/shipments-fbo/{id}/, для перевозки — /extapi/v1/transportations/{id}/ (нужны соответствующие права).
Семантика
progress.unit: pieces — штуки, order_lines — позиции заказов, не уникальные заказы. FBO progress совпадает с «Собрано из … шт.»; переданные в таре товары учитываются штатной логикой. FBS progress — проверенные позиции, picking — подбор, это разные этапы. В orders-fbs каждая запись — позиция WMS; внешний номер заказа может повторяться. Группируйте только по client_id + connection_id + external_order_id.
posted_at — проведение, shipped_at — физическая передача по данным WMS; они не взаимозаменяемы. null означает отсутствие даты/данных, а не доказательство, что событие не происходило. У исторических документов плановый состав может отсутствовать. difference — факт минус план; remaining не бывает отрицательным. Приёмки progress показывает текущую раскладку по штатному счётчику WMS, а не исторический факт размещения каждой штуки.
blockers — информационные признаки (не результат запуска проведения): assembly_incomplete, transportation_not_assigned, driver_not_assigned, car_not_assigned, check_required. Самовывоз тоже может не иметь перевозки; этот признак не запрещает отгрузку. Журнал ошибок API площадок и повторный запуск закрытия этот API не выполняет.
status_changed_at — только смена статуса. Полной ленты любых изменений пока нет: updated_from отклоняется с HTTP 400. Для синхронизации обновляйте выбранный диапазон документов повторно. Имена статусов берутся из WMS. Клиентские настройки/токены, исходные ответы площадок, телефоны и паспортные данные водителей не выдаются.
Пагинация и ошибки
Списки сортируются по Id ASC: limit 1..500, по умолчанию 100; следующий курсор meta.next_after_id, null — конец. Список может быть пустым, одиночное чтение отсутствующего или недоступного документа — 404. Вложенный состав ограничен 5000 строками, сводка — 5000 документами: при превышении HTTP 422, частичный результат не маскируется под полный. Сводка FBO не является единым отчётом по всем разделам: прочие разделы доступны отдельными списками. Даты фильтров YYYY-MM-DD, обе границы включены; время соответствует заголовкам X-Timezone / X-Warehouse-Timezone, как в WMS. Для типов без отдельной плановой даты planned_at равна DateTime. Неподдерживаемый фильтр — 400, неверный ключ — 401, запрет доступа — 403, неизвестный ресурс — 404, запись — 405, превышение частоты — 429. 300 запросов/минуту на ключ. Формат ошибки: {"status":"ERROR","message":"..."}.
Счета
Bills
GET/extapi/v1/bills/
Список счетов
Счета всех клиентов площадки: номер (с учётом нумерации юрлица), даты, суммы выставлено/оплачено. Позиции услуг — в единичном чтении /extapi/v1/bills/{id}/.
Параметры запроса
Параметр
Тип
Описание
after_idопционально
integer
Курсор: записи с Id больше указанного (из meta.next_after_id прошлой страницы)
limitопционально
integer
Записей в ответе (по умолчанию 100, максимум 500) По умолчанию 100. Максимум 500.
idопционально
string
Точечная выборка: ID или список через запятую (1,2,3)
date_fromопционально
string
Дата создания счёта с (ГГГГ-ММ-ДД)
date_toопционально
string
Дата создания счёта по (ГГГГ-ММ-ДД)
client_idопционально
integer
Только счета клиента (id из справочника /clients/)
paidопционально
integer
1 — только оплаченные (оплачено ≥ суммы), 0 — только неоплаченные
Пример запроса
200 OKСписок счетов
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 1632
data[].number
string
Номер счёта с учётом нумерации юрлица ФФПример: "FF-132/1632"
data[].date_time
string
Пример: "2025-01-19 15:50:58"
data[].client_id
integer
Пример: 132
data[].sum
number
Пример: 225280
data[].payed
number
Пример: 80000
meta
object
meta.count
integer
Пример: 2
meta.next_after_id
integer
Может быть null.Пример: 1719
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Попробовать запрос
GET /extapi/v1/bills/
GET/extapi/v1/bills/{id}/
Счёт с позициями услуг
Единичное чтение: шапка счёта + позиции оказанных услуг. final_sum позиции — сумма с учётом скидки; upd_id — номер УПД, если услуга уже закрыта документом.
Параметры запроса
Параметр
Тип
Описание
idОБЯЗАТЕЛЬНО
integer
ID счёта
Пример запроса
200 OKСчёт с позициями
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
data.id
integer
Пример: 1632
data.number
string
Пример: "FF-132/1632"
data.date_time
string
Пример: "2025-01-19 15:50:58"
data.client_id
integer
Пример: 132
data.sum
number
Пример: 225280
data.payed
number
Пример: 80000
data.items
array of object
data.items[].id
integer
Пример: 104592
data.items[].name
string
Пример: "Обработка товара при приемке"
data.items[].count
number
Пример: 72
data.items[].sum
number
Пример: 2880
data.items[].final_sum
number
Сумма со скидкойПример: 2880
data.items[].date_accounting
string
Пример: "2024-12-16"
data.items[].upd_id
integer
0 — услуга ещё не закрыта УПДПример: 568
data.items[].source
mixed
Только при праве bills/sources. null — ручная услуга, отсутствующий, неподдерживаемый или недоступный источник Может быть null.
[] — элемент массива, точка — вложенное поле.
404Счёт не найден
Попробовать запрос
GET /extapi/v1/bills/{id}/
УПД
Upd
GET/extapi/v1/upd/
Список УПД
УПД всех клиентов площадки: номер, дата создания и дата документа, сумма. Содержимое (строки) — в единичном чтении /extapi/v1/upd/{id}/.
Параметры запроса
Параметр
Тип
Описание
after_idопционально
integer
Курсор: записи с Id больше указанного
limitопционально
integer
Записей в ответе (по умолчанию 100, максимум 500) По умолчанию 100. Максимум 500.
idопционально
string
Точечная выборка: ID или список через запятую
date_fromопционально
string
Дата документа с (ГГГГ-ММ-ДД)
date_toопционально
string
Дата документа по (ГГГГ-ММ-ДД)
client_idопционально
integer
Только УПД клиента
Пример запроса
200 OKСписок УПД
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 568
data[].number
string
Пример: "FF-132/568"
data[].date_time
string
Дата созданияПример: "2025-01-19 15:52:01"
data[].date_accounting
string
Дата документаПример: "2024-12-31"
data[].client_id
integer
Пример: 132
data[].sum
number
Пример: 225280
meta
object
meta.count
integer
Пример: 2
meta.next_after_id
integer
Может быть null.Пример: 568
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Пример: "Услуга \"Отгрузка заказа по FBS\" за период с 01.10.2023 г. по 31.10.2023 г."
data.items[].count
number
Пример: 1
data.items[].price
number
Пример: 36921
data.items[].sum
number
Пример: 36921
[] — элемент массива, точка — вложенное поле.
404УПД не найден
Попробовать запрос
GET /extapi/v1/upd/{id}/
Платежи
Payments
GET/extapi/v1/payments/
Список платежей
Реестр платежей площадки: приходы и расходы, наличные и безнал. client_id > 0 — платёж привязан к клиенту, bill_id > 0 — к счёту. category_id (статья ДДС) отдаётся, если на площадке включён финансовый контур.
Параметры запроса
Параметр
Тип
Описание
after_idопционально
integer
Курсор: записи с Id больше указанного
limitопционально
integer
Записей в ответе (по умолчанию 100, максимум 500) По умолчанию 100. Максимум 500.
idопционально
string
Точечная выборка: ID или список через запятую
date_fromопционально
string
Дата учёта с (ГГГГ-ММ-ДД)
date_toопционально
string
Дата учёта по (ГГГГ-ММ-ДД)
client_idопционально
integer
Только платежи клиента
directionопционально
string
in — приходы, out — расходы
innопционально
string
Только платежи контрагента с этим ИНН
Пример запроса
200 OKСписок платежей
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 3
data[].date
string
Дата учётаПример: "2022-08-31"
data[].date_doc
string
Дата документаПример: "2022-08-31"
data[].num
integer
Номер платёжного порученияПример: 48
data[].sum
number
Пример: 1160
data[].direction
string
in — приход, out — расходПример: "in"
data[].pay_type
string
bank — безнал, cash — наличныеПример: "bank"
data[].counterparty
object
data[].counterparty.name
string
Пример: "ИП Розанов Денис Игоревич"
data[].counterparty.inn
string
Пример: "920250250152"
data[].counterparty.kpp
string
Пример: ""
data[].bank
object
data[].bank.name
string
Пример: "АО \"АЛЬФА-БАНК\" г Москва"
data[].bank.bic
string
Пример: "044525593"
data[].bank.account
string
Пример: "30302810500000001134"
data[].descr
string
Пример: "Счёт на оплату услуг №125 от 31.08.2022"
data[].client_id
integer
0 — платёж не привязан к клиентуПример: 132
data[].bill_id
integer
0 — платёж не привязан к счётуПример: 1632
data[].category_id
integer
Статья ДДС (только при включённом финконтуре)Пример: 10
meta
object
meta.count
integer
Пример: 2
meta.next_after_id
integer
Может быть null.Пример: 3
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Попробовать запрос
GET /extapi/v1/payments/
Клиенты
Clients
GET/extapi/v1/clients/
Справочник клиентов
Клиенты площадки (дебет): реквизиты для матчинга в учётной системе. legal_entity_id — юрлицо ФФ, от которого биллится клиент (важно при нескольких юрлицах).
Параметры запроса
Параметр
Тип
Описание
after_idопционально
integer
Курсор: записи с Id больше указанного
limitопционально
integer
Записей в ответе (по умолчанию 100, максимум 500) По умолчанию 100. Максимум 500.
idопционально
string
Точечная выборка: ID или список через запятую
innопционально
string
Поиск по ИНН
Пример запроса
200 OKСписок клиентов
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 1
data[].name
string
Пример: "ИП Иванова А.С."
data[].full_name
string
Пример: "Индивидуальный предприниматель Иванова Алена Сергеевна"
data[].inn
string
Пример: "583518151111"
data[].kpp
string
Пример: ""
data[].ogrn
string
Пример: "319583500016441"
data[].legal_entity_id
integer
Юрлицо ФФ, обслуживающее клиентаПример: 1
data[].agreement_number
string
Номер договора (фигурирует в отчётных документах)Пример: "FF-AGR-1"
data[].agreement_date
string
Дата договора, пусто если не заполненаПример: "2024-03-01"
meta
object
meta.count
integer
Пример: 2
meta.next_after_id
integer
Может быть null.Пример: 2
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Попробовать запрос
GET /extapi/v1/clients/
Контрагенты
Counterparties
GET/extapi/v1/counterparties/
Справочник контрагентов
Контрагенты площадки (кредит): справочник финансового контура, к которому привязываются расходные платежи. Требует включённого финансового контура на площадке (иначе 403).
Параметры запроса
Параметр
Тип
Описание
after_idопционально
integer
Курсор: записи с Id больше указанного
limitопционально
integer
Записей в ответе (по умолчанию 100, максимум 500) По умолчанию 100. Максимум 500.
idопционально
string
Точечная выборка: ID или список через запятую
innопционально
string
Поиск по ИНН
Пример запроса
200 OKСписок контрагентов
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 1
data[].name
string
Пример: "ООО \"Пример\""
data[].inn
string
Пример: "6025090293"
data[].kpp
string
Пример: ""
data[].default_category_id
integer
Статья ДДС по умолчаниюПример: 10
data[].pay_delay_days
integer
Отсрочка оплаты по договору, днейПример: 0
data[].comment
string
Пример: ""
meta
object
meta.count
integer
Пример: 2
meta.next_after_id
integer
Может быть null.Пример: 2
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Финансовый контур на площадке выключен, метод не разрешён для ключа, либо API не входит в тариф
Попробовать запрос
GET /extapi/v1/counterparties/
Аналитика
Аналитика
GET/extapi/v1/work-events/
Выработка за период: стабильный снимок
Нужно право work-events/list и включённый учёт труда. Только факты выбранного склада/клиентов. При ограниченном клиентском доступе общескладские и неизвестные операции не выдаются, ID общих документов скрыты. Старый контекст не восстанавливается по текущим карточкам: неизвестные единицы, зоны и scope явно отмечены. Сторно имеет отрицательные количества и ссылку на оригинал; также сохраняется исходная запись. Новые события несут единицу/контекст там, где они известны операции.
labor_cost возвращается только при include_cost=1 и отдельном разрешении. Расчёт совпадает с текущим отчётом прямого нормативного труда, не с фактически выплаченной зарплатой. Нет ставки — null и rate_known=false. Изменение ставок/нормативов учитывается в новом снимке; выгружайте период повторно.
Пример: GET /extapi/v1/work-events/?warehouse_id=1&date_from=2026-11-01&date_to=2026-11-01&include_cost=1. Затем GET /extapi/v1/work-events/?warehouse_id=1&snapshot_id=...&page=2&include_cost=1.
Первый запрос без snapshot_id создаёт неизменяемый снимок в read-only транзакции. Следующие страницы читаются из него, а не из меняющейся БД. Передавайте snapshot_id и page=meta.next_page, warehouse_id и для стоимости include_cost=1; исходные фильтры повторять нельзя. Завершение — next_page=null. Повтор страницы безопасен. После окончания замените выгружаемый период/снимок целиком, не дописывайте его повторно. При 410 начните заново, не смешивая два снимка.
Снимок действует 30 минут, страницы по 500 строк. До 100000 строк и 32 МиБ на снимок, до 3 активных снимков на ключ и 12 на площадку. Построение синхронное, ограничено по времени: при 422 сузьте период/клиента/товар; при 429 используйте существующий snapshot_id или повторите позже. Неполный снимок не выдаётся.
Доступ проверяется при каждом запросе. Снимок привязан к ключу, складу, методу и правам. Изменение прав делает старый снимок недоступным. Старые ключи не получают эти методы автоматически. Параметры updated_since и after_id в первом этапе не поддерживаются. Временные зоны — по общим правилам API и его заголовкам.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; указывайте одинаково на всех страницах
client_idопционально
integer
Фильтр при создании, в пределах прав ключа
snapshot_idопционально
string
48 hex-символов, полученных в meta первого ответа
pageопционально
integer
1..N, только с snapshot_id
date_fromопционально
string
Обязателен при создании, YYYY-MM-DD
date_toопционально
string
Обязателен при создании, включительно; период до 31 дня
employee_idопционально
integer
Фильтр по сотруднику при создании
include_costопционально
integer
0/1. Для 1 нужно отдельное право work-events/cost, также передавайте на всех страницах
Пример запроса
200 OKГотовая страница
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
data[].occurred_at
string
Дата работы в принятом системой формате; полный период включает обе даты фильтра
data[].warehouse_id
integer
data[].employee_id
integer
data[].operation_id
integer
data[].operation_name
string
data[].service_id
integer
Может быть null.
data[].quantity
number
Количество одной операции; нельзя складывать разные единицы
data[].quantity_unit
string
piece, code, container, kit, object или единица ручной работы; null если не зафиксирована Может быть null.
data[].norm_minutes
number
data[].client_id
integer
Может быть null.
data[].work_scope
string
client, warehouse или unknown. Отсутствие клиента не доказывает общескладскую работу
data[].item_id
integer
Может быть null.
data[].source
object
data[].source.type
string
data[].source.id
integer
ID документа; null при ограничении клиентов ключа Может быть null.
data[].work_order_id
integer
null при ограничении клиентов ключа Может быть null.
data[].status
integer
0 авто, 1 ручное/наряд, 2 оспорено, 3 сторно
data[].storno_of
integer
Может быть null.
data[].from_place
mixed
Может быть null.
data[].to_place
mixed
Может быть null.
data[].context_captured_at
string
Может быть null.
data[].labor_cost
object
data[].labor_cost.basis
string
current_report_for_event_date: стоимость по текущей истории ставок на дату события; не снимок фактической выплаты
data[].labor_cost.rate_date
string
data[].labor_cost.scheme_id
integer
Может быть null.
data[].labor_cost.hour_rate
number
Может быть null.
data[].labor_cost.amount
number
Нормо-минуты × часовая учётная ставка / 60, округление до 4 знаков Может быть null.
data[].labor_cost.currency
string
RUB
data[].labor_cost.rate_known
boolean
meta
object
meta.snapshot_id
string
meta.as_of
string
Момент начала согласованного снимка; один склад на снимок
meta.expires_at
string
meta.warehouse_id
integer
meta.count
integer
meta.total_count
integer
meta.page
integer
meta.page_size
integer
500
meta.next_page
integer
Может быть null.
meta.filters
object
meta.complete
boolean
true: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incremental
boolean
false: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
400Некорректные/неподдерживаемые параметры
401Нет действующего ключа
403Нет разрешения на метод, стоимость, клиента или склад
404Снимок недоступен ключу или его текущим правам
410Снимок истёк
422Превышен объём/время экспорта, сузьте фильтры
429Лимит запросов/снимков или занято построение
Попробовать запрос
GET /extapi/v1/work-events/
GET/extapi/v1/stock-by-place/
Остатки по местам: стабильный снимок
Нужно отдельное право stock-by-place/list. Строка — товар + место + FBS/FBO + признак и тип брака. Собственные записи регистра; остатки главной карточки не копируются на подчинённые/виртуальные комплекты. physical — физический остаток, reserved — минус сумма виртуальных движений, unreserved=physical-reserved. available/frozen — годный свободный остаток по месту с учётом заморозки и сборочной тары; для брака оба нулевые. Отрицательные аномалии не скрываются. При аномалиях сумма available по местам может отличаться от товарного агрегата старого stocks.
Размеры — миллиметры, объём — м³. Неизвестные габариты/вместимость — null. Объём относится к физическому остатку и не является тарифицируемым хранением. Вместимость места повторяется у товаров на нём: считать один раз по уникальному месту, не складывать родительские и дочерние места. placed_at пока null; last_movement_at — последнее движение, не дата размещения текущего остатка.
Пример: GET /extapi/v1/stock-by-place/?warehouse_id=1&client_id=10. Затем GET /extapi/v1/stock-by-place/?warehouse_id=1&snapshot_id=...&page=2.
Первый запрос без snapshot_id создаёт неизменяемый снимок в read-only транзакции. Следующие страницы читаются из него, а не из меняющейся БД. Передавайте snapshot_id и page=meta.next_page, warehouse_id и для стоимости include_cost=1; исходные фильтры повторять нельзя. Завершение — next_page=null. Повтор страницы безопасен. После окончания замените выгружаемый период/снимок целиком, не дописывайте его повторно. При 410 начните заново, не смешивая два снимка.
Снимок действует 30 минут, страницы по 500 строк. До 100000 строк и 32 МиБ на снимок, до 3 активных снимков на ключ и 12 на площадку. Построение синхронное, ограничено по времени: при 422 сузьте период/клиента/товар; при 429 используйте существующий snapshot_id или повторите позже. Неполный снимок не выдаётся.
Доступ проверяется при каждом запросе. Снимок привязан к ключу, складу, методу и правам. Изменение прав делает старый снимок недоступным. Старые ключи не получают эти методы автоматически. Параметры updated_since и after_id в первом этапе не поддерживаются. Временные зоны — по общим правилам API и его заголовкам.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; указывайте одинаково на всех страницах
client_idопционально
integer
Фильтр при создании, в пределах прав ключа
snapshot_idопционально
string
48 hex-символов, полученных в meta первого ответа
pageопционально
integer
1..N, только с snapshot_id
item_idопционально
integer
Фильтр по товару при создании
Пример запроса
200 OKГотовая страница
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].row_id
integer
Номер строки только внутри снимка
data[].warehouse_id
integer
data[].client_id
integer
data[].item_id
integer
data[].name
string
data[].article
string
data[].barcode
string
data[].stock_basis
string
own_register: только собственные записи карточки
data[].is_derived
boolean
data[].place
object
data[].place.code
string
data[].place.type
string
rows, cols, shelfs, boxes, container, picking_container, unassigned или unknown
data[].place.name
string
Может быть null.
data[].place.zone
mixed
Может быть null.
data[].place.capacity_volume_m3
number
Вместимость самого места; не суммировать повторно по строкам товаров/родителям Может быть null.
data[].place.dimensions
mixed
Может быть null.
data[].place.metadata_known
boolean
data[].place.picking_container
boolean
data[].stock_type
string
fbs или fbo
data[].is_reject
boolean
data[].reject_type
integer
data[].physical
number
data[].reserved
number
data[].unreserved
number
data[].available
number
data[].frozen
number
data[].is_frozen
boolean
data[].balance_anomaly
boolean
data[].item_dimensions
object
data[].item_dimensions.length_mm
number
Может быть null.
data[].item_dimensions.width_mm
number
Может быть null.
data[].item_dimensions.height_mm
number
Может быть null.
data[].item_dimensions.volume_m3
number
Геометрический объём; null при неполных размерах Может быть null.
data[].item_dimensions.complete
boolean
data[].physical_volume_m3
number
Геометрический объём физического остатка; не расчёт оплачиваемого хранения Может быть null.
data[].last_movement_at
string
Последнее движение регистра, включая резервы; не возраст оставшегося товара Может быть null.
data[].placed_at
string
В первом этапе всегда null: точную дату размещения остатка не восстанавливаем по движениям Может быть null.
data[].placement_date_known
boolean
В первом этапе false
meta
object
meta.snapshot_id
string
meta.as_of
string
Момент начала согласованного снимка; один склад на снимок
meta.expires_at
string
meta.warehouse_id
integer
meta.count
integer
meta.total_count
integer
meta.page
integer
meta.page_size
integer
500
meta.next_page
integer
Может быть null.
meta.filters
object
meta.complete
boolean
true: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incremental
boolean
false: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
400Некорректные/неподдерживаемые параметры
401Нет действующего ключа
403Нет разрешения на метод, стоимость, клиента или склад
404Снимок недоступен ключу или его текущим правам
410Снимок истёк
422Превышен объём/время экспорта, сузьте фильтры
429Лимит запросов/снимков или занято построение
Попробовать запрос
GET /extapi/v1/stock-by-place/
GET/extapi/v1/storage-places/
Все места хранения и их занятость
Требуется отдельное право storage-places/list. Метод доступен только ключам без ограничения по клиентам. В настройках ключа поле «Разрешённые клиенты» должно быть пустым — это означает доступ ко всем клиентам разрешённых складов. Если выбраны отдельные клиенты, метод недоступен. Ограничения ключа по складам сохраняются. Одна строка на полку или ячейку, включая пустые. Ряды и секции входят в полный адрес, тара учитывается как причина занятости, а не отдельное стационарное место. parent_code у ячейки — исходная ссылка на полку (в том числе отсутствующую, например shelfs_0), у полки null. Некорректные места тоже входят в реестр: HTTP 200, state=check_required, причины в anomalies. Адрес содержит только известные части; родитель и адрес автоматически не исправляются. anomalies — массив объектов code/message/related_code, пустой при отсутствии обнаруженных аномалий. missing_shelf, missing_section, missing_row означают отсутствие соответствующего родителя на выбранном складе (в том числе ссылку на другой склад); related_code содержит исходную проблемную ссылку. Аномалии секции/ряда повторяются у её полок и ячеек. negative_balance означает отрицательные учётные остатки или предразмещение в месте либо размещённой таре; related_code — код этого места. Состояние относится к самому адресу, без суммирования дочерних ячеек; полку с ячейками нельзя считать дополнительным свободным местом. state: free — свободно, occupied — есть физический товар, складская тара (включая пустую) или размещённые грузоместа; preplacement — только предразмещение; subdivided — полка разбита на ячейки; check_required — есть аномалии структуры или остатков. occupancy рассчитывается по учётным привязкам даже при повреждённой структуре; такое место не помечается свободным. Предразмещение не является физическим размещением. direct_item_quantity — физическое количество непосредственно на адресе, без товара в таре; storage_containers включает вложенную тару. Товарные резервы не вычитаются. Свободно означает отсутствие учтённых размещений; вместимость и возможность положить конкретный товар не рассчитываются. Товарный состав доступен отдельно в stock-by-place. GET /extapi/v1/storage-places/?warehouse_id=1 создаёт стабильный снимок. Диагностика аномалий применяется при создании нового снимка; ранее созданные снимки остаются неизменными. Следующие страницы: warehouse_id=1&snapshot_id=<из meta>&page=<meta.next_page>. Завершение — next_page=null. Страницы по 500 строк, срок 30 минут, повтор страницы безопасен. Лимиты общие с другими аналитическими снимками: 100000 строк/32 МиБ, 3 активных снимка на ключ/12 на площадку; при 410 начать выгрузку заново. Поддерживаются только warehouse_id, snapshot_id, page; фильтров по клиенту/товару нет.
Пояснение для человека; для обработки используйте code.
data[].anomalies[].related_code
string
Проблемная ссылка структуры; для negative_balance — код самого места.
data[].occupancy
object
data[].occupancy.direct_item_quantity
number
Товар без тары, шт.
data[].occupancy.preplaced_quantity
number
Предразмещение, включая тару, шт.
data[].occupancy.storage_containers
integer
Складская тара, включая вложенную
data[].occupancy.unloading_packages
integer
Непринятые ГМ разгрузок
data[].occupancy.fbo_packages
integer
Размещённые ГМ FBO
data[].occupancy.transit_packages
integer
Размещённые транзитные ГМ
data[].occupancy.transport_containers
integer
Размещённые транспортные контейнеры
meta
object
meta.snapshot_id
string
meta.as_of
string
Момент начала согласованного снимка; один склад на снимок
meta.expires_at
string
meta.warehouse_id
integer
meta.count
integer
meta.total_count
integer
meta.page
integer
meta.page_size
integer
500
meta.next_page
integer
Может быть null.
meta.filters
object
meta.complete
boolean
true: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incremental
boolean
false: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
400Некорректные или неподдерживаемые параметры
401Нет действующего ключа
403Нет права на метод/склад или ключ ограничен клиентами
404Снимок недоступен ключу или его текущим правам
410Срок снимка истёк
422Превышен объём или время экспорта
429Лимит запросов/снимков или занято построение
Попробовать запрос
GET /extapi/v1/storage-places/
Складские операции
Складские операции
GET/extapi/v1/services-provided/
Оказанные услуги за период
Нужно явное право services-provided/list. Услуги до выставления счёта также включены. Одна запись — начисление регистра; calculation.items — сохранённый состав, не перерасчёт по текущим тарифам. quantity начисления применяется отдельно от количества услуги в расчёте. sum/final_sum берутся непосредственно из начисления; их нельзя заменять суммой снимка. source возвращает доступный родительский документ, а не товарную строку. null — ручная услуга, неизвестная/удалённая/недоступная связь. Период можно выгружать курсором; регистр изменяемый, это не неизменяемый снимок и не лента изменений. После корректировок заменяйте выгрузку периода целиком. Пример: /extapi/v1/services-provided/?date_from=2026-10-01&date_to=2026-10-31&client_id=10&bill_id=0.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад
client_idопционально
integer
Клиент в пределах прав ключа
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500; по умолчанию 100
date_fromОБЯЗАТЕЛЬНО
string
Обязательно, YYYY-MM-DD по DateTimeAccounting
date_toОБЯЗАТЕЛЬНО
string
Обязательно, включительно; до 93 календарных дней
bill_idопционально
integer
Необязательно; 0 — ещё без счёта
Пример запроса
200 OKСтраница результатов
Поля ответа
Поле
Тип
Описание
status
string
data
array of object
data[].id
integer
data[].date_accounting
string
Может быть null.
data[].client_id
integer
data[].name
string
data[].quantity
number
Количество начисления; не путать с количеством каждой услуги внутри расчёта
data[].price
number
data[].sum
number
Сохранённая сумма начисления до скидки/наценки
data[].final_sum
number
Фактическая сохранённая сумма с коэффициентом скидки/наценки
data[].bill_id
integer
0 — ещё не включено в счёт
data[].upd_id
integer
data[].source
mixed
Может быть null.
data[].calculation
object
data[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data[].calculation.items
array of object
data[].calculation.items[].service_id
integer
data[].calculation.items[].name
string
data[].calculation.items[].quantity
number
data[].calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_price
boolean
data[].calculation.items[].is_discount
boolean
data[].calculation.items[].material
mixed
Может быть null.
data[].calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный запрос
401Нет действующего ключа
403Нет разрешения
404Документ недоступен
422Превышен размер ответа; сузьте фильтр или limit
Попробовать запрос
GET /extapi/v1/services-provided/
GET/extapi/v1/document-history/
История документа
Нужны document-history/list и право <resource>/get. Только существующая история самого документа из интерфейса (не история дочерних строк). Время, текст действия без HTML, пользователь и сохранённое имя. Пустой список означает отсутствие сохранённых записей, а не отсутствие действий. Недоступный документ даёт 404. Пример: /extapi/v1/document-history/?resource=incomes&document_id=123.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад
client_idопционально
integer
Клиент в пределах прав ключа
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500; по умолчанию 100
resourceОБЯЗАТЕЛЬНО
string
Обязательно: incomes, shipments-fbo или unloadings
document_idОБЯЗАТЕЛЬНО
integer
Обязательный ID документа
Пример запроса
200 OKСтраница результатов
Поля ответа
Поле
Тип
Описание
status
string
data
array of object
data[].id
integer
data[].date_time
string
Может быть null.
data[].action
string
Текст существующей истории документа без HTML, не машинный код события
data[].user_id
integer
Может быть null.
data[].user_name
string
Имя, сохранённое на момент действия
data[].type
integer
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный запрос
401Нет действующего ключа
403Нет разрешения
404Документ недоступен
422Превышен размер ответа; сузьте фильтр или limit
Попробовать запрос
GET /extapi/v1/document-history/
GET/extapi/v1/users/
Имена исполнителей
Нужно users/list и хотя бы одно право чтения складских документов. Только id/name сотрудников, указанных как worker_id в документах доступных ресурсов, клиентов и выбранного склада. Это не полный каталог пользователей; сотрудник без доступных документов отсутствует. Заблокированные сотрудники с историческими документами могут присутствовать. Логины, пароли, почта, телефоны и права не выдаются. Пример: /extapi/v1/users/?warehouse_id=1&client_id=10.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад
client_idопционально
integer
Клиент в пределах прав ключа
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500; по умолчанию 100
Пример запроса
200 OKСтраница результатов
Поля ответа
Поле
Тип
Описание
status
string
data
array of object
data[].id
integer
data[].name
string
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный запрос
401Нет действующего ключа
403Нет разрешения
404Документ недоступен
422Превышен размер ответа; сузьте фильтр или limit
Попробовать запрос
GET /extapi/v1/users/
GET/extapi/v1/shipments-fbo/
Отгрузки FBO: список
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DispatchDate: с YYYY-MM-DD, включительно
planned_toопционально
string
DispatchDate: по YYYY-MM-DD, включительно
status_changed_fromопционально
string
LastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопционально
string
LastStatusDateTime: по YYYY-MM-DD, включительно
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].calculation
object
data[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data[].calculation.items
array of object
data[].calculation.items[].service_id
integer
data[].calculation.items[].name
string
data[].calculation.items[].quantity
number
data[].calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_price
boolean
data[].calculation.items[].is_discount
boolean
data[].calculation.items[].material
mixed
Может быть null.
data[].calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].marketplace
string
Площадка
data[].destination
string
Направление
data[].external_order_id
string
Номер на внешней площадке
data[].progress
object
data[].progress.unit
string
pieces либо order_lines
data[].progress.total
number
data[].progress.done
number
data[].progress.remaining
number
data[].progress.difference
number
Есть у FBO и заявок на поставку
data[].package_count
integer
Грузомест FBO
data[].comment
string
Сохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data[].dispatch_order
object
Заявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data[].dispatch_order.id
integer
data[].dispatch_order.number
string
Пример: "зОГ-123"
data[].volume_m3
number
Штатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data[].pallet_count
integer
Количество паллетомест из поля Pallets; отдельно от общего количества грузомест
data[].transportations
array of object
Перевозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data[].packages
array of object
Короба FBO: id, number, barcode, items
data[].packages[].calculation
object
data[].packages[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data[].packages[].calculation.items
array of object
data[].packages[].calculation.items[].service_id
integer
data[].packages[].calculation.items[].name
string
data[].packages[].calculation.items[].quantity
number
data[].packages[].calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].packages[].calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].packages[].id
integer
data[].packages[].number
string
data[].packages[].barcode
string
data[].packages[].items
array of object
data[].packages[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].packages[].items[].calculations.fbs
object
data[].packages[].items[].calculations.income
object
data[].packages[].items[].calculations.services
object
data[].packages[].items[].id
integer
data[].packages[].items[].item_id
integer
ID карточки WMS Может быть null.
data[].packages[].items[].article
string
Артикул Может быть null.
data[].packages[].items[].name
string
Товар Может быть null.
data[].packages[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].packages[].items[].quantity
number
data[].expected_items
array of object
Плановый состав FBO
data[].expected_items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].expected_items[].calculations.fbs
object
data[].expected_items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data[].expected_items[].calculations.fbs.items
array of object
data[].expected_items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].expected_items[].calculations.income
object
data[].expected_items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data[].expected_items[].calculations.income.items
array of object
data[].expected_items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].expected_items[].id
integer
data[].expected_items[].item_id
integer
ID карточки WMS Может быть null.
data[].expected_items[].article
string
Артикул Может быть null.
data[].expected_items[].name
string
Товар Может быть null.
data[].expected_items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].expected_items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/shipments-fbo/
GET/extapi/v1/shipments-fbo/{id}/
Отгрузки FBO: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
include_calculationsопционально
integer
0/1. При 1 нужно отдельное право document-calculations/get; сохранённые расчёты документа, коробов FBO и товаров. Ничего не пересчитывает.
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.calculation
object
data.calculation.state
string
Допустимо: "empty", "saved", "invalid".
data.calculation.items
array of object
data.calculation.items[].service_id
integer
data.calculation.items[].name
string
data.calculation.items[].quantity
number
data.calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.calculation.items[].manual_price
boolean
data.calculation.items[].is_discount
boolean
data.calculation.items[].material
mixed
Может быть null.
data.calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.marketplace
string
Площадка
data.destination
string
Направление
data.external_order_id
string
Номер на внешней площадке
data.progress
object
data.progress.unit
string
pieces либо order_lines
data.progress.total
number
data.progress.done
number
data.progress.remaining
number
data.progress.difference
number
Есть у FBO и заявок на поставку
data.package_count
integer
Грузомест FBO
data.comment
string
Сохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data.dispatch_order
object
Заявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data.dispatch_order.id
integer
data.dispatch_order.number
string
Пример: "зОГ-123"
data.volume_m3
number
Штатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data.pallet_count
integer
Количество паллетомест из поля Pallets; отдельно от общего количества грузомест
data.transportations
array of object
Перевозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data.packages
array of object
Короба FBO: id, number, barcode, items
data.packages[].calculation
object
data.packages[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data.packages[].calculation.items
array of object
data.packages[].calculation.items[].service_id
integer
data.packages[].calculation.items[].name
string
data.packages[].calculation.items[].quantity
number
data.packages[].calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.packages[].calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.packages[].calculation.items[].manual_price
boolean
data.packages[].calculation.items[].is_discount
boolean
data.packages[].calculation.items[].material
mixed
Может быть null.
data.packages[].calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.packages[].id
integer
data.packages[].number
string
data.packages[].barcode
string
data.packages[].items
array of object
data.packages[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.packages[].items[].calculations.fbs
object
data.packages[].items[].calculations.income
object
data.packages[].items[].calculations.services
object
data.packages[].items[].id
integer
data.packages[].items[].item_id
integer
ID карточки WMS Может быть null.
data.packages[].items[].article
string
Артикул Может быть null.
data.packages[].items[].name
string
Товар Может быть null.
data.packages[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data.packages[].items[].quantity
number
data.expected_items
array of object
Плановый состав FBO
data.expected_items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.expected_items[].calculations.fbs
object
data.expected_items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.fbs.items
array of object
data.expected_items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].calculations.income
object
data.expected_items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.income.items
array of object
data.expected_items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].calculations.services
object
data.expected_items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.services.items
array of object
data.expected_items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].id
integer
data.expected_items[].item_id
integer
ID карточки WMS Может быть null.
data.expected_items[].article
string
Артикул Может быть null.
data.expected_items[].name
string
Товар Может быть null.
data.expected_items[].barcode
string
Основной штрихкод карточки Может быть null.
data.expected_items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/shipments-fbo/{id}/
GET/extapi/v1/shipments-fbs/
Отгрузки FBS: список
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTime: по YYYY-MM-DD, включительно
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].marketplace
string
Площадка
data[].progress
object
data[].progress.unit
string
pieces либо order_lines
data[].progress.total
number
data[].progress.done
number
data[].progress.remaining
number
data[].progress.difference
number
Есть у FBO и заявок на поставку
data[].picking
object
Подбор позиций FBS
data[].picking.done
integer
Пример: 8
data[].picking.partial
integer
Пример: 1
data[].picking.total
integer
Пример: 10
data[].deadline
string
Самая ранняя DateTimeShip среди позиций FBS Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/shipments-fbs/
GET/extapi/v1/shipments-fbs/{id}/
Отгрузки FBS: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.marketplace
string
Площадка
data.progress
object
data.progress.unit
string
pieces либо order_lines
data.progress.total
number
data.progress.done
number
data.progress.remaining
number
data.progress.difference
number
Есть у FBO и заявок на поставку
data.picking
object
Подбор позиций FBS
data.picking.done
integer
Пример: 8
data.picking.partial
integer
Пример: 1
data.picking.total
integer
Пример: 10
data.deadline
string
Самая ранняя DateTimeShip среди позиций FBS Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/shipments-fbs/{id}/
GET/extapi/v1/orders-fbs/
Позиции заказов FBS: список
Только чтение. См. общие правила доступа и семантику полей в начале документации. Запись — позиция WMS, не сгруппированный внешний заказ.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTimeShip: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTimeShip: по YYYY-MM-DD, включительно
status_changed_fromопционально
string
LastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопционально
string
LastStatusDateTime: по YYYY-MM-DD, включительно
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].external_order_id
string
Номер на внешней площадке
data[].connection_id
integer
Подключение площадки
data[].marketplace
string
Площадка
data[].quantity
number
Штук в позиции FBS
data[].collected
boolean
Позиция подобрана
data[].check_state
integer
Штатное состояние IsChecked, отрицательное — требуется проверка
data[].started_at
string
Начало работы, когда фиксируется Может быть null.
data[].finished_at
string
Окончание работы Может быть null.
data[].marketplace_shipped_at
string
Отгрузка/приёмка по данным площадки Может быть null.
data[].items
array of object
Состав при одиночном чтении
data[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbs
object
data[].items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.items
array of object
data[].items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.income
object
data[].items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.items
array of object
data[].items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.services
object
data[].items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.items
array of object
data[].items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].id
integer
data[].items[].item_id
integer
ID карточки WMS Может быть null.
data[].items[].article
string
Артикул Может быть null.
data[].items[].name
string
Товар Может быть null.
data[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/orders-fbs/
GET/extapi/v1/orders-fbs/{id}/
Позиции заказов FBS: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации. Запись — позиция WMS, не сгруппированный внешний заказ.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.external_order_id
string
Номер на внешней площадке
data.connection_id
integer
Подключение площадки
data.marketplace
string
Площадка
data.quantity
number
Штук в позиции FBS
data.collected
boolean
Позиция подобрана
data.check_state
integer
Штатное состояние IsChecked, отрицательное — требуется проверка
data.started_at
string
Начало работы, когда фиксируется Может быть null.
data.finished_at
string
Окончание работы Может быть null.
data.marketplace_shipped_at
string
Отгрузка/приёмка по данным площадки Может быть null.
data.items
array of object
Состав при одиночном чтении
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/orders-fbs/{id}/
GET/extapi/v1/transportations/
Перевозки: список
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTime: по YYYY-MM-DD, включительно
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].driver
string
Имя водителя без телефона и паспорта
data[].car
string
Автомобиль
data[].destination
string
Направление
data[].arrived_at
string
Прибытие машины Может быть null.
data[].handed_over_at
string
Передано на МП Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/transportations/
GET/extapi/v1/transportations/{id}/
Перевозки: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.driver
string
Имя водителя без телефона и паспорта
data.car
string
Автомобиль
data.destination
string
Направление
data.arrived_at
string
Прибытие машины Может быть null.
data.handed_over_at
string
Передано на МП Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/transportations/{id}/
GET/extapi/v1/assembly-tasks/
Задания подбора: список
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTime: по YYYY-MM-DD, включительно
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].source
string
Тип задания
data[].progress_text
string
Штатная строка прогресса подбора
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/assembly-tasks/
GET/extapi/v1/assembly-tasks/{id}/
Задания подбора: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.source
string
Тип задания
data.progress_text
string
Штатная строка прогресса подбора
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/assembly-tasks/{id}/
GET/extapi/v1/unloading-orders/
Заявки на поставку: список
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DatePlan: с YYYY-MM-DD, включительно
planned_toопционально
string
DatePlan: по YYYY-MM-DD, включительно
status_changed_fromопционально
string
LastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопционально
string
LastStatusDateTime: по YYYY-MM-DD, включительно
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].progress
object
data[].progress.unit
string
pieces либо order_lines
data[].progress.total
number
data[].progress.done
number
data[].progress.remaining
number
data[].progress.difference
number
Есть у FBO и заявок на поставку
data[].slot_id
integer
Слот поставки Может быть null.
data[].items
array of object
Состав при одиночном чтении
data[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbs
object
data[].items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.items
array of object
data[].items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.income
object
data[].items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.items
array of object
data[].items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.services
object
data[].items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.items
array of object
data[].items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].id
integer
data[].items[].item_id
integer
ID карточки WMS Может быть null.
data[].items[].article
string
Артикул Может быть null.
data[].items[].name
string
Товар Может быть null.
data[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloading-orders/
GET/extapi/v1/unloading-orders/{id}/
Заявки на поставку: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.progress
object
data.progress.unit
string
pieces либо order_lines
data.progress.total
number
data.progress.done
number
data.progress.remaining
number
data.progress.difference
number
Есть у FBO и заявок на поставку
data.slot_id
integer
Слот поставки Может быть null.
data.items
array of object
Состав при одиночном чтении
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloading-orders/{id}/
GET/extapi/v1/unloadings/
Разгрузки: список
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTimePlan: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTimePlan: по YYYY-MM-DD, включительно
status_changed_fromопционально
string
LastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопционально
string
LastStatusDateTime: по YYYY-MM-DD, включительно
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].started_at
string
Начало работы, когда фиксируется Может быть null.
data[].finished_at
string
Окончание работы Может быть null.
data[].received_quantity
number
Принято штук в разгрузке
data[].items
array of object
Состав при одиночном чтении
data[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbs
object
data[].items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.items
array of object
data[].items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.income
object
data[].items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.items
array of object
data[].items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.services
object
data[].items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.items
array of object
data[].items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].id
integer
data[].items[].item_id
integer
ID карточки WMS Может быть null.
data[].items[].article
string
Артикул Может быть null.
data[].items[].name
string
Товар Может быть null.
data[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloadings/
GET/extapi/v1/unloadings/{id}/
Разгрузки: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.started_at
string
Начало работы, когда фиксируется Может быть null.
data.finished_at
string
Окончание работы Может быть null.
data.received_quantity
number
Принято штук в разгрузке
data.items
array of object
Состав при одиночном чтении
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloadings/{id}/
GET/extapi/v1/incomes/
Приёмки: список
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
planned_toопционально
string
DateTime: по YYYY-MM-DD, включительно
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].calculation
object
data[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data[].calculation.items
array of object
data[].calculation.items[].service_id
integer
data[].calculation.items[].name
string
data[].calculation.items[].quantity
number
data[].calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_price
boolean
data[].calculation.items[].is_discount
boolean
data[].calculation.items[].material
mixed
Может быть null.
data[].calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].id
integer
ID записи WMS
data[].number
string
Номер документа или внешний номер позиции FBS
data[].url
string
Относительная ссылка в кабинет; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
null у общих документов Может быть null.
data[].client_name
string
Имя клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Штатное название
data[].date_time
string
Дата документа; у перевозки — плановая погрузка
data[].planned_at
string
Плановая дата Может быть null.
data[].status_changed_at
string
Только смена статуса Может быть null.
data[].posted_at
string
Проведение Может быть null.
data[].shipped_at
string
Физическая передача Может быть null.
data[].worker_id
integer
ID исполнителя Может быть null.
data[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data[].relations
array of object
Доступные связанные документы; resource + id
data[].relations[].resource
string
data[].relations[].id
integer
data[].progress
object
data[].progress.unit
string
pieces либо order_lines
data[].progress.total
number
data[].progress.done
number
data[].progress.remaining
number
data[].progress.difference
number
Есть у FBO и заявок на поставку
data[].rejected_quantity
number
Брак в приёмке
data[].items
array of object
Состав при одиночном чтении
data[].items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbs
object
data[].items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.items
array of object
data[].items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.income
object
data[].items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.items
array of object
data[].items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.services
object
data[].items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.items
array of object
data[].items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].id
integer
data[].items[].item_id
integer
ID карточки WMS Может быть null.
data[].items[].article
string
Артикул Может быть null.
data[].items[].name
string
Товар Может быть null.
data[].items[].barcode
string
Основной штрихкод карточки Может быть null.
data[].items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/incomes/
GET/extapi/v1/incomes/{id}/
Приёмки: чтение
Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.
Параметры запроса
Параметр
Тип
Описание
include_calculationsопционально
integer
0/1. При 1 нужно отдельное право document-calculations/get; сохранённые расчёты документа, коробов FBO и товаров. Ничего не пересчитывает.
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Поля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.calculation
object
data.calculation.state
string
Допустимо: "empty", "saved", "invalid".
data.calculation.items
array of object
data.calculation.items[].service_id
integer
data.calculation.items[].name
string
data.calculation.items[].quantity
number
data.calculation.items[].price
number
Сохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.calculation.items[].sum
number
Сумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.calculation.items[].manual_price
boolean
data.calculation.items[].is_discount
boolean
data.calculation.items[].material
mixed
Может быть null.
data.calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.id
integer
ID записи WMS
data.number
string
Номер документа или внешний номер позиции FBS
data.url
string
Относительная ссылка в кабинет; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
null у общих документов Может быть null.
data.client_name
string
Имя клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Штатное название
data.date_time
string
Дата документа; у перевозки — плановая погрузка
data.planned_at
string
Плановая дата Может быть null.
data.status_changed_at
string
Только смена статуса Может быть null.
data.posted_at
string
Проведение Может быть null.
data.shipped_at
string
Физическая передача Может быть null.
data.worker_id
integer
ID исполнителя Может быть null.
data.blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.relations
array of object
Доступные связанные документы; resource + id
data.relations[].resource
string
data.relations[].id
integer
data.progress
object
data.progress.unit
string
pieces либо order_lines
data.progress.total
number
data.progress.done
number
data.progress.remaining
number
data.progress.difference
number
Есть у FBO и заявок на поставку
data.rejected_quantity
number
Брак в приёмке
data.items
array of object
Состав при одиночном чтении
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/incomes/{id}/
GET/extapi/v1/warehouses/
Разрешённые активные склады
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
Пример: 1
data[].name
string
Пример: "Основной склад"
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /extapi/v1/warehouses/
GET/extapi/v1/operations/summary/
Ежедневная сводка FBO и просроченных отгрузок
Требует два разрешения: operations/summary и shipments-fbo/list. Сводка до 5000 документов, иначе HTTP 422; план выбранного дня плюс незавершённые предыдущих дней. Не атомарный снимок: документы могут измениться во время чтения.
Параметры запроса
Параметр
Тип
Описание
dateопционально
string
День отчёта YYYY-MM-DD; по умолчанию сегодня в WMS
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.shipments_fbo[].id
integer
ID записи WMS
data.shipments_fbo[].number
string
Номер документа или внешний номер позиции FBS
data.shipments_fbo[].url
string
Относительная ссылка в кабинет; требует обычного входа
data.shipments_fbo[].warehouse_id
integer
Склад фулфилмента
data.shipments_fbo[].client_id
integer
null у общих документов Может быть null.
data.shipments_fbo[].client_name
string
Имя клиента Может быть null.
data.shipments_fbo[].status
integer
Штатный числовой статус WMS
data.shipments_fbo[].status_name
string
Штатное название
data.shipments_fbo[].date_time
string
Дата документа; у перевозки — плановая погрузка
data.shipments_fbo[].planned_at
string
Плановая дата Может быть null.
data.shipments_fbo[].status_changed_at
string
Только смена статуса Может быть null.
data.shipments_fbo[].posted_at
string
Проведение Может быть null.
data.shipments_fbo[].shipped_at
string
Физическая передача Может быть null.
data.shipments_fbo[].worker_id
integer
ID исполнителя Может быть null.
data.shipments_fbo[].blockers
array of string
Информационные признаки, не исчерпывающая проверка закрытия
data.shipments_fbo[].relations
array of object
Доступные связанные документы; resource + id
data.shipments_fbo[].relations[].resource
string
data.shipments_fbo[].relations[].id
integer
data.shipments_fbo[].marketplace
string
Площадка
data.shipments_fbo[].destination
string
Направление
data.shipments_fbo[].external_order_id
string
Номер на внешней площадке
data.shipments_fbo[].progress
object
data.shipments_fbo[].progress.unit
string
pieces либо order_lines
data.shipments_fbo[].progress.total
number
data.shipments_fbo[].progress.done
number
data.shipments_fbo[].progress.remaining
number
data.shipments_fbo[].progress.difference
number
Есть у FBO и заявок на поставку
data.shipments_fbo[].package_count
integer
Грузомест FBO
data.shipments_fbo[].comment
string
Сохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data.shipments_fbo[].dispatch_order
object
Заявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data.shipments_fbo[].dispatch_order.id
integer
data.shipments_fbo[].dispatch_order.number
string
Пример: "зОГ-123"
data.shipments_fbo[].volume_m3
number
Штатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data.shipments_fbo[].pallet_count
integer
Количество паллетомест из поля Pallets; отдельно от общего количества грузомест
data.shipments_fbo[].transportations
array of object
Перевозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data.shipments_fbo[].packages
array of object
Короба FBO: id, number, barcode, items
data.shipments_fbo[].packages[].calculation
object
data.shipments_fbo[].packages[].calculation.state
string
Допустимо: "empty", "saved", "invalid".
data.shipments_fbo[].packages[].calculation.items
array of object
data.shipments_fbo[].packages[].calculation.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
Нужно право transfers/list. Шапки документов без items; состав доступен по ID. Фильтры planned_from/to относятся к DateTime; status_changed_from/to не поддерживаются.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент в пределах прав ключа
after_idопционально
integer
Курсор meta.next_after_id
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
Алиас date_from: отдельной плановой даты нет
planned_toопционально
string
Алиас date_to: отдельной плановой даты нет
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKСписок шапок
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID документа WMS
data[].number
string
Номер ПЕ или зПЕ
data[].url
string
Ссылка на документ в WMS; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
Клиент — владелец документа Может быть null.
data[].client_name
string
Название клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Название статуса WMS
data[].date_time
string
Дата документа
data[].planned_at
string
Совпадает с date_time; отдельной плановой даты нет Может быть null.
data[].status_changed_at
string
Всегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data[].posted_at
string
Дата проведения, если предусмотрена моделью документа Может быть null.
data[].shipped_at
string
Дата физической передачи, если предусмотрена моделью документа Может быть null.
data[].worker_id
integer
ID исполнителя, если указан в документе Может быть null.
data[].blockers
array of string
Информационные признаки; для перемещений список пуст
data[].relations
array of object
У ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data[].relations[].resource
string
data[].relations[].id
integer
data[].comment
string
Сохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный или неподдерживаемый фильтр
403Нет доступа к методу, складу или клиенту
Попробовать запрос
GET /extapi/v1/transfers/
GET/extapi/v1/transfers/{id}/
Перемещение: чтение
Нужно право transfers/get. Шапка, ссылка на заявку зПЕ и её товарный состав. Заявка должна принадлежать тому же клиенту и складу и входить в клиентские ограничения ключа; иначе 422 без частичного состава.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент в пределах прав ключа
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKПеремещение с составом заявки
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Перемещение ПЕ или заявка зПЕ. Список содержит шапки; items выдаётся только по ID. Состав ПЕ берётся из его заявки, и не является отдельным снимком факта. planned_at совпадает с date_time: отдельной плановой даты нет. status_changed_at равен null. У заявки ограничения ключа по клиентам проверяются и для получателя товара TargetLegal. Межскладские WarehouseTransfers в эти ресурсы не входят.
data.id
integer
ID документа WMS
data.number
string
Номер ПЕ или зПЕ
data.url
string
Ссылка на документ в WMS; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
Клиент — владелец документа Может быть null.
data.client_name
string
Название клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Название статуса WMS
data.date_time
string
Дата документа
data.planned_at
string
Совпадает с date_time; отдельной плановой даты нет Может быть null.
data.status_changed_at
string
Всегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data.posted_at
string
Дата проведения, если предусмотрена моделью документа Может быть null.
data.shipped_at
string
Дата физической передачи, если предусмотрена моделью документа Может быть null.
data.worker_id
integer
ID исполнителя, если указан в документе Может быть null.
data.blockers
array of string
Информационные признаки; для перемещений список пуст
data.relations
array of object
У ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data.relations[].resource
string
data.relations[].id
integer
data.comment
string
Сохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
data.items
array of object
Товарный состав заявки; у ПЕ читается из связанной зПЕ. Только при чтении по ID.
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа к методу, складу или клиенту
404Перемещение не найдено в доступной выборке
422Нет доступной заявки или состав превышает 5000 строк
Попробовать запрос
GET /extapi/v1/transfers/{id}/
GET/extapi/v1/transfer-orders/
Заявки на перемещение: список
Нужно право transfer-orders/list. Шапки документов без items; состав доступен по ID. Фильтры planned_from/to относятся к DateTime; status_changed_from/to не поддерживаются.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент в пределах прав ключа
after_idопционально
integer
Курсор meta.next_after_id
limitопционально
integer
1..500, по умолчанию 100
date_fromопционально
string
DateTime: с YYYY-MM-DD, включительно
date_toопционально
string
DateTime: по YYYY-MM-DD, включительно
planned_fromопционально
string
Алиас date_from: отдельной плановой даты нет
planned_toопционально
string
Алиас date_to: отдельной плановой даты нет
statusопционально
integer
Числовой статус WMS
Пример запроса
200 OKСписок шапок
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID документа WMS
data[].number
string
Номер ПЕ или зПЕ
data[].url
string
Ссылка на документ в WMS; требует обычного входа
data[].warehouse_id
integer
Склад фулфилмента
data[].client_id
integer
Клиент — владелец документа Может быть null.
data[].client_name
string
Название клиента Может быть null.
data[].status
integer
Штатный числовой статус WMS
data[].status_name
string
Название статуса WMS
data[].date_time
string
Дата документа
data[].planned_at
string
Совпадает с date_time; отдельной плановой даты нет Может быть null.
data[].status_changed_at
string
Всегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data[].posted_at
string
Дата проведения, если предусмотрена моделью документа Может быть null.
data[].shipped_at
string
Дата физической передачи, если предусмотрена моделью документа Может быть null.
data[].worker_id
integer
ID исполнителя, если указан в документе Может быть null.
data[].blockers
array of string
Информационные признаки; для перемещений список пуст
data[].relations
array of object
У ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data[].relations[].resource
string
data[].relations[].id
integer
data[].comment
string
Сохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный или неподдерживаемый фильтр
403Нет доступа к методу, складу или клиенту
Попробовать запрос
GET /extapi/v1/transfer-orders/
GET/extapi/v1/transfer-orders/{id}/
Заявка на перемещение: чтение
Нужно право transfer-orders/get. Шапка заявки зПЕ и товарный состав.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Клиент в пределах прав ключа
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKЗаявка с составом
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
Перемещение ПЕ или заявка зПЕ. Список содержит шапки; items выдаётся только по ID. Состав ПЕ берётся из его заявки, и не является отдельным снимком факта. planned_at совпадает с date_time: отдельной плановой даты нет. status_changed_at равен null. У заявки ограничения ключа по клиентам проверяются и для получателя товара TargetLegal. Межскладские WarehouseTransfers в эти ресурсы не входят.
data.id
integer
ID документа WMS
data.number
string
Номер ПЕ или зПЕ
data.url
string
Ссылка на документ в WMS; требует обычного входа
data.warehouse_id
integer
Склад фулфилмента
data.client_id
integer
Клиент — владелец документа Может быть null.
data.client_name
string
Название клиента Может быть null.
data.status
integer
Штатный числовой статус WMS
data.status_name
string
Название статуса WMS
data.date_time
string
Дата документа
data.planned_at
string
Совпадает с date_time; отдельной плановой даты нет Может быть null.
data.status_changed_at
string
Всегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data.posted_at
string
Дата проведения, если предусмотрена моделью документа Может быть null.
data.shipped_at
string
Дата физической передачи, если предусмотрена моделью документа Может быть null.
data.worker_id
integer
ID исполнителя, если указан в документе Может быть null.
data.blockers
array of string
Информационные признаки; для перемещений список пуст
data.relations
array of object
У ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data.relations[].resource
string
data.relations[].id
integer
data.comment
string
Сохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
data.items
array of object
Товарный состав заявки; у ПЕ читается из связанной зПЕ. Только при чтении по ID.
data.items[].calculations
object
Только include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbs
object
data.items[].calculations.fbs.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.items
array of object
data.items[].calculations.fbs.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.income
object
data.items[].calculations.income.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.income.items
array of object
data.items[].calculations.income.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.services
object
data.items[].calculations.services.state
string
Допустимо: "empty", "saved", "invalid".
data.items[].calculations.services.items
array of object
data.items[].calculations.services.sum
number
Сумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].id
integer
data.items[].item_id
integer
ID карточки WMS Может быть null.
data.items[].article
string
Артикул Может быть null.
data.items[].name
string
Товар Может быть null.
data.items[].barcode
string
Основной штрихкод карточки Может быть null.
data.items[].quantity
number
meta
object
meta.count
integer
meta.next_after_id
integer
null — последняя страница Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа к методу, складу или клиенту
404Заявка не найдена в доступной выборке
422Состав превышает 5000 строк
Попробовать запрос
GET /extapi/v1/transfer-orders/{id}/
Остатки и движения
Остатки и движения
GET/extapi/v1/stocks/
Учётные остатки FBS/FBO
Собственные записи регистра по каждой карточке, без дублирования родительских товаров и виртуальных комплектов. after_id — ID товара.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Владелец карточки, в пределах прав ключа
item_idопционально
integer
ID карточки товара
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
data[].client_id
integer
Владелец карточки товара
data[].article
string
data[].name
string
data[].barcode
string
data[].is_derived
boolean
Подчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data[].archived
boolean
data[].fbs
object
data[].fbs.physical
number
Физический годный остаток
data[].fbs.reserved
number
Текущий резерв годного товара
data[].fbs.unreserved
number
physical − reserved; отрицательное значение сохраняется
data[].fbs.available
number
Свободно с учётом замороженных зон и сборочной тары; не меньше нуля
data[].fbs.frozen
number
Незарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data[].fbs.rejected_physical
number
Физический брак; не включён в physical
data[].fbs.rejected_reserved
number
Резерв брака; не включён в reserved
data[].fbs.balance_anomaly
boolean
Отрицательный физический остаток/резерв либо резерв превышает физический остаток
data[].fbo
object
data[].fbo.physical
number
Физический годный остаток
data[].fbo.reserved
number
Текущий резерв годного товара
data[].fbo.unreserved
number
physical − reserved; отрицательное значение сохраняется
data[].fbo.available
number
Свободно с учётом замороженных зон и сборочной тары; не меньше нуля
data[].fbo.frozen
number
Незарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data[].fbo.rejected_physical
number
Физический брак; не включён в physical
data[].fbo.rejected_reserved
number
Резерв брака; не включён в reserved
data[].fbo.balance_anomaly
boolean
Отрицательный физический остаток/резерв либо резерв превышает физический остаток
meta
object
meta.count
integer
Число элементов data; для одиночного чтения 1
meta.next_after_id
integer
Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
meta.stock_basis
string
Допустимо: "own_register".
meta.record_type
string
Допустимо: "goods".
meta.cursor_basis
string
item_id у резервов, register_id у движений
meta.append_only
boolean
Для движений всегда false: журнал не является неизменяемой лентой
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
401Нет авторизации
403Нет доступа к методу/складу/клиенту
404Ресурс не найден
422Слишком большой состав резервов
429Лимит запросов
Попробовать запрос
GET /extapi/v1/stocks/
GET/extapi/v1/stocks/{id}/
Учётный остаток товара
Недоступная карточка возвращает 404. Состав fbs/fbo совпадает со списком stocks.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Владелец карточки, в пределах прав ключа
idОБЯЗАТЕЛЬНО
integer
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
object
data.id
integer
data.client_id
integer
Владелец карточки товара
data.article
string
data.name
string
data.barcode
string
data.is_derived
boolean
Подчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data.archived
boolean
data.fbs
object
data.fbs.physical
number
Физический годный остаток
data.fbs.reserved
number
Текущий резерв годного товара
data.fbs.unreserved
number
physical − reserved; отрицательное значение сохраняется
data.fbs.available
number
Свободно с учётом замороженных зон и сборочной тары; не меньше нуля
data.fbs.frozen
number
Незарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data.fbs.rejected_physical
number
Физический брак; не включён в physical
data.fbs.rejected_reserved
number
Резерв брака; не включён в reserved
data.fbs.balance_anomaly
boolean
Отрицательный физический остаток/резерв либо резерв превышает физический остаток
data.fbo
object
data.fbo.physical
number
Физический годный остаток
data.fbo.reserved
number
Текущий резерв годного товара
data.fbo.unreserved
number
physical − reserved; отрицательное значение сохраняется
data.fbo.available
number
Свободно с учётом замороженных зон и сборочной тары; не меньше нуля
data.fbo.frozen
number
Незарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data.fbo.rejected_physical
number
Физический брак; не включён в physical
data.fbo.rejected_reserved
number
Резерв брака; не включён в reserved
data.fbo.balance_anomaly
boolean
Отрицательный физический остаток/резерв либо резерв превышает физический остаток
meta
object
meta.count
integer
Число элементов data; для одиночного чтения 1
meta.next_after_id
integer
Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
meta.stock_basis
string
Допустимо: "own_register".
meta.record_type
string
Допустимо: "goods".
meta.cursor_basis
string
item_id у резервов, register_id у движений
meta.append_only
boolean
Для движений всегда false: журнал не является неизменяемой лентой
400Некорректный фильтр
401Нет авторизации
403Нет доступа к методу/складу/клиенту
404Ресурс не найден
422Слишком большой состав резервов
429Лимит запросов
Попробовать запрос
GET /extapi/v1/stocks/{id}/
GET/extapi/v1/stock-reservations/
Текущие резервы товаров
Пагинация по ID товара, пустой reservations допустим. Максимум 5000 срезов на страницу; не исторический резерв на дату.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Владелец карточки, в пределах прав ключа
item_idопционально
integer
ID карточки товара
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
stock_typeопционально
string
fbs или fbo
is_rejectопционально
integer
0 — годный, 1 — брак
placeопционально
string
Точное место хранения; допускается пустое
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
data[].client_id
integer
Владелец карточки товара
data[].article
string
data[].name
string
data[].barcode
string
data[].is_derived
boolean
Подчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data[].archived
boolean
data[].reservations
array of object
data[].reservations[].stock_type
string
Допустимо: "fbs", "fbo".
data[].reservations[].is_reject
boolean
data[].reservations[].reject_type_id
integer
data[].reservations[].place
string
data[].reservations[].income_line_id
integer
ID строки приёмки; null при ограничении клиентов ключа Может быть null.
data[].reservations[].source_type
string
Тип источника записи WMS
data[].reservations[].source_id
integer
ID источника; null при ограничении клиентов ключа Может быть null.
data[].reservations[].reserved_quantity
number
Минус сумма виртуальных движений в этом срезе. При отрицательном значении есть аномалия регистра
data[].reservations[].balance_anomaly
boolean
meta
object
meta.count
integer
Число элементов data; для одиночного чтения 1
meta.next_after_id
integer
Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
meta.stock_basis
string
Допустимо: "own_register".
meta.record_type
string
Допустимо: "goods".
meta.cursor_basis
string
item_id у резервов, register_id у движений
meta.append_only
boolean
Для движений всегда false: журнал не является неизменяемой лентой
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
401Нет авторизации
403Нет доступа к методу/складу/клиенту
404Ресурс не найден
422Слишком большой состав резервов
429Лимит запросов
Попробовать запрос
GET /extapi/v1/stock-reservations/
GET/extapi/v1/stock-movements/
Движения товаров
after_id — ID записи регистра. Журнал может изменяться при перепроведении; не является неизменяемой лентой событий.
Параметры запроса
Параметр
Тип
Описание
warehouse_idопционально
integer
Разрешённый склад; иначе склад ключа
client_idопционально
integer
Владелец карточки, в пределах прав ключа
item_idопционально
integer
ID карточки товара
after_idопционально
integer
Курсор предыдущей страницы
limitопционально
integer
1..500, по умолчанию 100
stock_typeопционально
string
fbs или fbo
is_rejectопционально
integer
0 — годный, 1 — брак
placeопционально
string
Точное место хранения; допускается пустое
is_virtualопционально
integer
0 — физические движения, 1 — виртуальные
date_fromопционально
string
YYYY-MM-DD, включительно
date_toопционально
string
YYYY-MM-DD, включительно
Пример запроса
200 OKРезультат
Поля ответа
Поле
Тип
Описание
status
string
Пример: "OK"
data
array of object
data[].id
integer
ID записи регистра
data[].item_id
integer
data[].client_id
integer
Владелец карточки
data[].article
string
data[].name
string
data[].barcode
string
data[].date_time
string
Может быть null.
data[].is_virtual
boolean
false — физическое движение; true — резерв
data[].quantity_delta
number
Знаковое количество в регистре. В виртуальном слое минус означает резервирование, плюс — снятие резерва
data[].stock_type
string
Допустимо: "fbs", "fbo".
data[].is_reject
boolean
data[].reject_type_id
integer
data[].place
string
data[].income_line_id
integer
ID строки приёмки; null при ограничении клиентов ключа Может быть null.
data[].source_type
string
Тип источника записи WMS
data[].source_id
integer
ID источника; null при ограничении клиентов ключа Может быть null.
meta
object
meta.count
integer
Число элементов data; для одиночного чтения 1
meta.next_after_id
integer
Может быть null.
meta.warehouse_id
integer
meta.generated_at
string
meta.stock_basis
string
Допустимо: "own_register".
meta.record_type
string
Допустимо: "goods".
meta.cursor_basis
string
item_id у резервов, register_id у движений
meta.append_only
boolean
Для движений всегда false: журнал не является неизменяемой лентой