v1.4.0 · обновлено 18.11.2026
MCP Клиентский API extapi.yaml

API Целиком для учётных систем

Финансы, складские документы и операционная сводка фулфилмента. Только чтение, доступ по складам, клиентам и методам.

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

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опциональноinteger1 — только оплаченные (оплачено ≥ суммы), 0 — только неоплаченные

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

200 OKСписок счетов

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 1632
data[].numberstringНомер счёта с учётом нумерации юрлица ФФПример: "FF-132/1632"
data[].date_timestringПример: "2025-01-19 15:50:58"
data[].client_idintegerПример: 132
data[].sumnumberПример: 225280
data[].payednumberПример: 80000
metaobject
meta.countintegerПример: 2
meta.next_after_idintegerМожет быть null.Пример: 1719
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Попробовать запрос
GET /extapi/v1/bills/
GET/extapi/v1/bills/{id}/
Счёт с позициями услуг

Единичное чтение: шапка счёта + позиции оказанных услуг. final_sum позиции — сумма с учётом скидки; upd_id — номер УПД, если услуга уже закрыта документом.

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID счёта

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

200 OKСчёт с позициями

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobject
data.idintegerПример: 1632
data.numberstringПример: "FF-132/1632"
data.date_timestringПример: "2025-01-19 15:50:58"
data.client_idintegerПример: 132
data.sumnumberПример: 225280
data.payednumberПример: 80000
data.itemsarray of object
data.items[].idintegerПример: 104592
data.items[].namestringПример: "Обработка товара при приемке"
data.items[].countnumberПример: 72
data.items[].sumnumberПример: 2880
data.items[].final_sumnumberСумма со скидкойПример: 2880
data.items[].date_accountingstringПример: "2024-12-16"
data.items[].upd_idinteger0 — услуга ещё не закрыта УПДПример: 568
data.items[].sourcemixedТолько при праве 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Список УПД

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 568
data[].numberstringПример: "FF-132/568"
data[].date_timestringДата созданияПример: "2025-01-19 15:52:01"
data[].date_accountingstringДата документаПример: "2024-12-31"
data[].client_idintegerПример: 132
data[].sumnumberПример: 225280
metaobject
meta.countintegerПример: 2
meta.next_after_idintegerМожет быть null.Пример: 568
[] — элемент массива, точка — вложенное поле.
401Нет заголовка Authorization или токен неверный/отключён
403Метод не разрешён для этого ключа, либо API не входит в тариф площадки
Попробовать запрос
GET /extapi/v1/upd/
GET/extapi/v1/upd/{id}/
УПД с содержимым

Единичное чтение: шапка УПД + строки документа (наименование, количество, цена, сумма).

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

ПараметрТипОписание
idОБЯЗАТЕЛЬНОintegerID УПД

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

200 OKУПД со строками

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobject
data.idintegerПример: 1
data.numberstringПример: "FF-6/1"
data.date_timestringПример: "2024-01-08 16:29:11"
data.date_accountingstringПример: "2023-10-31"
data.client_idintegerПример: 6
data.sumnumberПример: 38378
data.itemsarray of object
data.items[].namestringПример: "Услуга \"Отгрузка заказа по FBS\" за период с 01.10.2023 г. по 31.10.2023 г."
data.items[].countnumberПример: 1
data.items[].pricenumberПример: 36921
data.items[].sumnumberПример: 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опциональноstringin — приходы, out — расходы
innопциональноstringТолько платежи контрагента с этим ИНН

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

200 OKСписок платежей

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 3
data[].datestringДата учётаПример: "2022-08-31"
data[].date_docstringДата документаПример: "2022-08-31"
data[].numintegerНомер платёжного порученияПример: 48
data[].sumnumberПример: 1160
data[].directionstringin — приход, out — расходПример: "in"
data[].pay_typestringbank — безнал, cash — наличныеПример: "bank"
data[].counterpartyobject
data[].counterparty.namestringПример: "ИП Розанов Денис Игоревич"
data[].counterparty.innstringПример: "920250250152"
data[].counterparty.kppstringПример: ""
data[].bankobject
data[].bank.namestringПример: "АО \"АЛЬФА-БАНК\" г Москва"
data[].bank.bicstringПример: "044525593"
data[].bank.accountstringПример: "30302810500000001134"
data[].descrstringПример: "Счёт на оплату услуг №125 от 31.08.2022"
data[].client_idinteger0 — платёж не привязан к клиентуПример: 132
data[].bill_idinteger0 — платёж не привязан к счётуПример: 1632
data[].category_idintegerСтатья ДДС (только при включённом финконтуре)Пример: 10
metaobject
meta.countintegerПример: 2
meta.next_after_idintegerМожет быть 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Список клиентов

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 1
data[].namestringПример: "ИП Иванова А.С."
data[].full_namestringПример: "Индивидуальный предприниматель Иванова Алена Сергеевна"
data[].innstringПример: "583518151111"
data[].kppstringПример: ""
data[].ogrnstringПример: "319583500016441"
data[].legal_entity_idintegerЮрлицо ФФ, обслуживающее клиентаПример: 1
data[].agreement_numberstringНомер договора (фигурирует в отчётных документах)Пример: "FF-AGR-1"
data[].agreement_datestringДата договора, пусто если не заполненаПример: "2024-03-01"
metaobject
meta.countintegerПример: 2
meta.next_after_idintegerМожет быть 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Список контрагентов

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 1
data[].namestringПример: "ООО \"Пример\""
data[].innstringПример: "6025090293"
data[].kppstringПример: ""
data[].default_category_idintegerСтатья ДДС по умолчаниюПример: 10
data[].pay_delay_daysintegerОтсрочка оплаты по договору, днейПример: 0
data[].commentstringПример: ""
metaobject
meta.countintegerПример: 2
meta.next_after_idintegerМожет быть 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опциональноstring48 hex-символов, полученных в meta первого ответа
pageопциональноinteger1..N, только с snapshot_id
date_fromопциональноstringОбязателен при создании, YYYY-MM-DD
date_toопциональноstringОбязателен при создании, включительно; период до 31 дня
employee_idопциональноintegerФильтр по сотруднику при создании
include_costопциональноinteger0/1. Для 1 нужно отдельное право work-events/cost, также передавайте на всех страницах

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

200 OKГотовая страница

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idinteger
data[].occurred_atstringДата работы в принятом системой формате; полный период включает обе даты фильтра
data[].warehouse_idinteger
data[].employee_idinteger
data[].operation_idinteger
data[].operation_namestring
data[].service_idintegerМожет быть null.
data[].quantitynumberКоличество одной операции; нельзя складывать разные единицы
data[].quantity_unitstringpiece, code, container, kit, object или единица ручной работы; null если не зафиксирована Может быть null.
data[].norm_minutesnumber
data[].client_idintegerМожет быть null.
data[].work_scopestringclient, warehouse или unknown. Отсутствие клиента не доказывает общескладскую работу
data[].item_idintegerМожет быть null.
data[].sourceobject
data[].source.typestring
data[].source.idintegerID документа; null при ограничении клиентов ключа Может быть null.
data[].work_order_idintegernull при ограничении клиентов ключа Может быть null.
data[].statusinteger0 авто, 1 ручное/наряд, 2 оспорено, 3 сторно
data[].storno_ofintegerМожет быть null.
data[].from_placemixedМожет быть null.
data[].to_placemixedМожет быть null.
data[].context_captured_atstringМожет быть null.
data[].labor_costobject
data[].labor_cost.basisstringcurrent_report_for_event_date: стоимость по текущей истории ставок на дату события; не снимок фактической выплаты
data[].labor_cost.rate_datestring
data[].labor_cost.scheme_idintegerМожет быть null.
data[].labor_cost.hour_ratenumberМожет быть null.
data[].labor_cost.amountnumberНормо-минуты × часовая учётная ставка / 60, округление до 4 знаков Может быть null.
data[].labor_cost.currencystringRUB
data[].labor_cost.rate_knownboolean
metaobject
meta.snapshot_idstring
meta.as_ofstringМомент начала согласованного снимка; один склад на снимок
meta.expires_atstring
meta.warehouse_idinteger
meta.countinteger
meta.total_countinteger
meta.pageinteger
meta.page_sizeinteger500
meta.next_pageintegerМожет быть null.
meta.filtersobject
meta.completebooleantrue: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incrementalbooleanfalse: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
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опциональноstring48 hex-символов, полученных в meta первого ответа
pageопциональноinteger1..N, только с snapshot_id
item_idопциональноintegerФильтр по товару при создании

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

200 OKГотовая страница

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].row_idintegerНомер строки только внутри снимка
data[].warehouse_idinteger
data[].client_idinteger
data[].item_idinteger
data[].namestring
data[].articlestring
data[].barcodestring
data[].stock_basisstringown_register: только собственные записи карточки
data[].is_derivedboolean
data[].placeobject
data[].place.codestring
data[].place.typestringrows, cols, shelfs, boxes, container, picking_container, unassigned или unknown
data[].place.namestringМожет быть null.
data[].place.zonemixedМожет быть null.
data[].place.capacity_volume_m3numberВместимость самого места; не суммировать повторно по строкам товаров/родителям Может быть null.
data[].place.dimensionsmixedМожет быть null.
data[].place.metadata_knownboolean
data[].place.picking_containerboolean
data[].stock_typestringfbs или fbo
data[].is_rejectboolean
data[].reject_typeinteger
data[].physicalnumber
data[].reservednumber
data[].unreservednumber
data[].availablenumber
data[].frozennumber
data[].is_frozenboolean
data[].balance_anomalyboolean
data[].item_dimensionsobject
data[].item_dimensions.length_mmnumberМожет быть null.
data[].item_dimensions.width_mmnumberМожет быть null.
data[].item_dimensions.height_mmnumberМожет быть null.
data[].item_dimensions.volume_m3numberГеометрический объём; null при неполных размерах Может быть null.
data[].item_dimensions.completeboolean
data[].physical_volume_m3numberГеометрический объём физического остатка; не расчёт оплачиваемого хранения Может быть null.
data[].last_movement_atstringПоследнее движение регистра, включая резервы; не возраст оставшегося товара Может быть null.
data[].placed_atstringВ первом этапе всегда null: точную дату размещения остатка не восстанавливаем по движениям Может быть null.
data[].placement_date_knownbooleanВ первом этапе false
metaobject
meta.snapshot_idstring
meta.as_ofstringМомент начала согласованного снимка; один склад на снимок
meta.expires_atstring
meta.warehouse_idinteger
meta.countinteger
meta.total_countinteger
meta.pageinteger
meta.page_sizeinteger500
meta.next_pageintegerМожет быть null.
meta.filtersobject
meta.completebooleantrue: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incrementalbooleanfalse: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
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; фильтров по клиенту/товару нет.

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

ПараметрТипОписание
warehouse_idопциональноintegerРазрешённый склад; одинаковый на всех страницах
snapshot_idопциональноstring48 hex-символов из первого ответа
pageопциональноintegerНомер страницы; только вместе с snapshot_id

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

200 OKСвободная ячейка, последняя страница снимка

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].warehouse_idintegerПример: 1
data[].codestringПример: "boxes_123"
data[].typestringДопустимо: "shelf", "box".
data[].addressstringПример: "А → 1 → 2 → 3"
data[].parent_codestringМожет быть null.Пример: "shelfs_12"
data[].statestringДопустимо: "free", "occupied", "preplacement", "subdivided", "check_required".
data[].anomaliesarray of objectОбнаруженные аномалии структуры и остатков; пустой массив для корректного места.
data[].anomalies[].codestringДопустимо: "missing_shelf", "missing_section", "missing_row", "negative_balance".
data[].anomalies[].messagestringПояснение для человека; для обработки используйте code.
data[].anomalies[].related_codestringПроблемная ссылка структуры; для negative_balance — код самого места.
data[].occupancyobject
data[].occupancy.direct_item_quantitynumberТовар без тары, шт.
data[].occupancy.preplaced_quantitynumberПредразмещение, включая тару, шт.
data[].occupancy.storage_containersintegerСкладская тара, включая вложенную
data[].occupancy.unloading_packagesintegerНепринятые ГМ разгрузок
data[].occupancy.fbo_packagesintegerРазмещённые ГМ FBO
data[].occupancy.transit_packagesintegerРазмещённые транзитные ГМ
data[].occupancy.transport_containersintegerРазмещённые транспортные контейнеры
metaobject
meta.snapshot_idstring
meta.as_ofstringМомент начала согласованного снимка; один склад на снимок
meta.expires_atstring
meta.warehouse_idinteger
meta.countinteger
meta.total_countinteger
meta.pageinteger
meta.page_sizeinteger500
meta.next_pageintegerМожет быть null.
meta.filtersobject
meta.completebooleantrue: снимок построен полностью, до последней страницы нужно дойти по next_page
meta.incrementalbooleanfalse: замена периода/снимка целиком
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500; по умолчанию 100
date_fromОБЯЗАТЕЛЬНОstringОбязательно, YYYY-MM-DD по DateTimeAccounting
date_toОБЯЗАТЕЛЬНОstringОбязательно, включительно; до 93 календарных дней
bill_idопциональноintegerНеобязательно; 0 — ещё без счёта

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

200 OKСтраница результатов

Поля ответа

ПолеТипОписание
statusstring
dataarray of object
data[].idinteger
data[].date_accountingstringМожет быть null.
data[].client_idinteger
data[].namestring
data[].quantitynumberКоличество начисления; не путать с количеством каждой услуги внутри расчёта
data[].pricenumber
data[].sumnumberСохранённая сумма начисления до скидки/наценки
data[].final_sumnumberФактическая сохранённая сумма с коэффициентом скидки/наценки
data[].bill_idinteger0 — ещё не включено в счёт
data[].upd_idinteger
data[].sourcemixedМожет быть null.
data[].calculationobject
data[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data[].calculation.itemsarray of object
data[].calculation.items[].service_idinteger
data[].calculation.items[].namestring
data[].calculation.items[].quantitynumber
data[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_priceboolean
data[].calculation.items[].is_discountboolean
data[].calculation.items[].materialmixedМожет быть null.
data[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500; по умолчанию 100
resourceОБЯЗАТЕЛЬНОstringОбязательно: incomes, shipments-fbo или unloadings
document_idОБЯЗАТЕЛЬНОintegerОбязательный ID документа

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

200 OKСтраница результатов

Поля ответа

ПолеТипОписание
statusstring
dataarray of object
data[].idinteger
data[].date_timestringМожет быть null.
data[].actionstringТекст существующей истории документа без HTML, не машинный код события
data[].user_idintegerМожет быть null.
data[].user_namestringИмя, сохранённое на момент действия
data[].typeinteger
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500; по умолчанию 100

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

200 OKСтраница результатов

Поля ответа

ПолеТипОписание
statusstring
dataarray of object
data[].idinteger
data[].namestring
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDispatchDate: с YYYY-MM-DD, включительно
planned_toопциональноstringDispatchDate: по YYYY-MM-DD, включительно
status_changed_fromопциональноstringLastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопциональноstringLastStatusDateTime: по YYYY-MM-DD, включительно
statusопциональноintegerЧисловой статус WMS

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].calculationobject
data[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data[].calculation.itemsarray of object
data[].calculation.items[].service_idinteger
data[].calculation.items[].namestring
data[].calculation.items[].quantitynumber
data[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_priceboolean
data[].calculation.items[].is_discountboolean
data[].calculation.items[].materialmixedМожет быть null.
data[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].marketplacestringПлощадка
data[].destinationstringНаправление
data[].external_order_idstringНомер на внешней площадке
data[].progressobject
data[].progress.unitstringpieces либо order_lines
data[].progress.totalnumber
data[].progress.donenumber
data[].progress.remainingnumber
data[].progress.differencenumberЕсть у FBO и заявок на поставку
data[].package_countintegerГрузомест FBO
data[].commentstringСохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data[].dispatch_orderobjectЗаявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data[].dispatch_order.idinteger
data[].dispatch_order.numberstringПример: "зОГ-123"
data[].volume_m3numberШтатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data[].pallet_countintegerКоличество паллетомест из поля Pallets; отдельно от общего количества грузомест
data[].transportationsarray of objectПеревозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data[].packagesarray of objectКороба FBO: id, number, barcode, items
data[].packages[].calculationobject
data[].packages[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data[].packages[].calculation.itemsarray of object
data[].packages[].calculation.items[].service_idinteger
data[].packages[].calculation.items[].namestring
data[].packages[].calculation.items[].quantitynumber
data[].packages[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].packages[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].packages[].calculation.items[].manual_priceboolean
data[].packages[].calculation.items[].is_discountboolean
data[].packages[].calculation.items[].materialmixedМожет быть null.
data[].packages[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].packages[].idinteger
data[].packages[].numberstring
data[].packages[].barcodestring
data[].packages[].itemsarray of object
data[].packages[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].packages[].items[].calculations.fbsobject
data[].packages[].items[].calculations.incomeobject
data[].packages[].items[].calculations.servicesobject
data[].packages[].items[].idinteger
data[].packages[].items[].item_idintegerID карточки WMS Может быть null.
data[].packages[].items[].articlestringАртикул Может быть null.
data[].packages[].items[].namestringТовар Может быть null.
data[].packages[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].packages[].items[].quantitynumber
data[].expected_itemsarray of objectПлановый состав FBO
data[].expected_items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].expected_items[].calculations.fbsobject
data[].expected_items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data[].expected_items[].calculations.fbs.itemsarray of object
data[].expected_items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].expected_items[].calculations.incomeobject
data[].expected_items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data[].expected_items[].calculations.income.itemsarray of object
data[].expected_items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].expected_items[].calculations.servicesobject
data[].expected_items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data[].expected_items[].calculations.services.itemsarray of object
data[].expected_items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].expected_items[].idinteger
data[].expected_items[].item_idintegerID карточки WMS Может быть null.
data[].expected_items[].articlestringАртикул Может быть null.
data[].expected_items[].namestringТовар Может быть null.
data[].expected_items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].expected_items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/shipments-fbo/
GET/extapi/v1/shipments-fbo/{id}/
Отгрузки FBO: чтение

Только чтение. См. общие правила доступа и семантику полей в начале документации.

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

ПараметрТипОписание
include_calculationsопциональноinteger0/1. При 1 нужно отдельное право document-calculations/get; сохранённые расчёты документа, коробов FBO и товаров. Ничего не пересчитывает.
warehouse_idопциональноintegerРазрешённый склад; иначе склад ключа
client_idопциональноintegerКлиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНОinteger

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.calculationobject
data.calculation.statestringДопустимо: "empty", "saved", "invalid".
data.calculation.itemsarray of object
data.calculation.items[].service_idinteger
data.calculation.items[].namestring
data.calculation.items[].quantitynumber
data.calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.calculation.items[].manual_priceboolean
data.calculation.items[].is_discountboolean
data.calculation.items[].materialmixedМожет быть null.
data.calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.marketplacestringПлощадка
data.destinationstringНаправление
data.external_order_idstringНомер на внешней площадке
data.progressobject
data.progress.unitstringpieces либо order_lines
data.progress.totalnumber
data.progress.donenumber
data.progress.remainingnumber
data.progress.differencenumberЕсть у FBO и заявок на поставку
data.package_countintegerГрузомест FBO
data.commentstringСохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data.dispatch_orderobjectЗаявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data.dispatch_order.idinteger
data.dispatch_order.numberstringПример: "зОГ-123"
data.volume_m3numberШтатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data.pallet_countintegerКоличество паллетомест из поля Pallets; отдельно от общего количества грузомест
data.transportationsarray of objectПеревозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data.packagesarray of objectКороба FBO: id, number, barcode, items
data.packages[].calculationobject
data.packages[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data.packages[].calculation.itemsarray of object
data.packages[].calculation.items[].service_idinteger
data.packages[].calculation.items[].namestring
data.packages[].calculation.items[].quantitynumber
data.packages[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.packages[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.packages[].calculation.items[].manual_priceboolean
data.packages[].calculation.items[].is_discountboolean
data.packages[].calculation.items[].materialmixedМожет быть null.
data.packages[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.packages[].idinteger
data.packages[].numberstring
data.packages[].barcodestring
data.packages[].itemsarray of object
data.packages[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.packages[].items[].calculations.fbsobject
data.packages[].items[].calculations.incomeobject
data.packages[].items[].calculations.servicesobject
data.packages[].items[].idinteger
data.packages[].items[].item_idintegerID карточки WMS Может быть null.
data.packages[].items[].articlestringАртикул Может быть null.
data.packages[].items[].namestringТовар Может быть null.
data.packages[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data.packages[].items[].quantitynumber
data.expected_itemsarray of objectПлановый состав FBO
data.expected_items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.expected_items[].calculations.fbsobject
data.expected_items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.fbs.itemsarray of object
data.expected_items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].calculations.incomeobject
data.expected_items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.income.itemsarray of object
data.expected_items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].calculations.servicesobject
data.expected_items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.expected_items[].calculations.services.itemsarray of object
data.expected_items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.expected_items[].idinteger
data.expected_items[].item_idintegerID карточки WMS Может быть null.
data.expected_items[].articlestringАртикул Может быть null.
data.expected_items[].namestringТовар Может быть null.
data.expected_items[].barcodestringОсновной штрихкод карточки Может быть null.
data.expected_items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTime: по YYYY-MM-DD, включительно

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].marketplacestringПлощадка
data[].progressobject
data[].progress.unitstringpieces либо order_lines
data[].progress.totalnumber
data[].progress.donenumber
data[].progress.remainingnumber
data[].progress.differencenumberЕсть у FBO и заявок на поставку
data[].pickingobjectПодбор позиций FBS
data[].picking.doneintegerПример: 8
data[].picking.partialintegerПример: 1
data[].picking.totalintegerПример: 10
data[].deadlinestringСамая ранняя DateTimeShip среди позиций FBS Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.marketplacestringПлощадка
data.progressobject
data.progress.unitstringpieces либо order_lines
data.progress.totalnumber
data.progress.donenumber
data.progress.remainingnumber
data.progress.differencenumberЕсть у FBO и заявок на поставку
data.pickingobjectПодбор позиций FBS
data.picking.doneintegerПример: 8
data.picking.partialintegerПример: 1
data.picking.totalintegerПример: 10
data.deadlinestringСамая ранняя DateTimeShip среди позиций FBS Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTimeShip: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTimeShip: по YYYY-MM-DD, включительно
status_changed_fromопциональноstringLastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопциональноstringLastStatusDateTime: по YYYY-MM-DD, включительно
statusопциональноintegerЧисловой статус WMS

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].external_order_idstringНомер на внешней площадке
data[].connection_idintegerПодключение площадки
data[].marketplacestringПлощадка
data[].quantitynumberШтук в позиции FBS
data[].collectedbooleanПозиция подобрана
data[].check_stateintegerШтатное состояние IsChecked, отрицательное — требуется проверка
data[].started_atstringНачало работы, когда фиксируется Может быть null.
data[].finished_atstringОкончание работы Может быть null.
data[].marketplace_shipped_atstringОтгрузка/приёмка по данным площадки Может быть null.
data[].itemsarray of objectСостав при одиночном чтении
data[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbsobject
data[].items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.itemsarray of object
data[].items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.incomeobject
data[].items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.itemsarray of object
data[].items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.servicesobject
data[].items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.itemsarray of object
data[].items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].idinteger
data[].items[].item_idintegerID карточки WMS Может быть null.
data[].items[].articlestringАртикул Может быть null.
data[].items[].namestringТовар Может быть null.
data[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.external_order_idstringНомер на внешней площадке
data.connection_idintegerПодключение площадки
data.marketplacestringПлощадка
data.quantitynumberШтук в позиции FBS
data.collectedbooleanПозиция подобрана
data.check_stateintegerШтатное состояние IsChecked, отрицательное — требуется проверка
data.started_atstringНачало работы, когда фиксируется Может быть null.
data.finished_atstringОкончание работы Может быть null.
data.marketplace_shipped_atstringОтгрузка/приёмка по данным площадки Может быть null.
data.itemsarray of objectСостав при одиночном чтении
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTime: по YYYY-MM-DD, включительно

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].driverstringИмя водителя без телефона и паспорта
data[].carstringАвтомобиль
data[].destinationstringНаправление
data[].arrived_atstringПрибытие машины Может быть null.
data[].handed_over_atstringПередано на МП Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.driverstringИмя водителя без телефона и паспорта
data.carstringАвтомобиль
data.destinationstringНаправление
data.arrived_atstringПрибытие машины Может быть null.
data.handed_over_atstringПередано на МП Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTime: по YYYY-MM-DD, включительно
statusопциональноintegerЧисловой статус WMS

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].sourcestringТип задания
data[].progress_textstringШтатная строка прогресса подбора
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.sourcestringТип задания
data.progress_textstringШтатная строка прогресса подбора
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDatePlan: с YYYY-MM-DD, включительно
planned_toопциональноstringDatePlan: по YYYY-MM-DD, включительно
status_changed_fromопциональноstringLastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопциональноstringLastStatusDateTime: по YYYY-MM-DD, включительно
statusопциональноintegerЧисловой статус WMS

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].progressobject
data[].progress.unitstringpieces либо order_lines
data[].progress.totalnumber
data[].progress.donenumber
data[].progress.remainingnumber
data[].progress.differencenumberЕсть у FBO и заявок на поставку
data[].slot_idintegerСлот поставки Может быть null.
data[].itemsarray of objectСостав при одиночном чтении
data[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbsobject
data[].items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.itemsarray of object
data[].items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.incomeobject
data[].items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.itemsarray of object
data[].items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.servicesobject
data[].items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.itemsarray of object
data[].items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].idinteger
data[].items[].item_idintegerID карточки WMS Может быть null.
data[].items[].articlestringАртикул Может быть null.
data[].items[].namestringТовар Может быть null.
data[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.progressobject
data.progress.unitstringpieces либо order_lines
data.progress.totalnumber
data.progress.donenumber
data.progress.remainingnumber
data.progress.differencenumberЕсть у FBO и заявок на поставку
data.slot_idintegerСлот поставки Может быть null.
data.itemsarray of objectСостав при одиночном чтении
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloading-orders/{id}/
GET/extapi/v1/unloadings/
Разгрузки: список

Только чтение. См. общие правила доступа и семантику полей в начале документации.

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

ПараметрТипОписание
warehouse_idопциональноintegerРазрешённый склад; иначе склад ключа
client_idопциональноintegerКлиент. Общие документы доступны только когда весь их состав входит в выборку
after_idопциональноintegerКурсор предыдущей страницы
limitопциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTimePlan: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTimePlan: по YYYY-MM-DD, включительно
status_changed_fromопциональноstringLastStatusDateTime: с YYYY-MM-DD, включительно
status_changed_toопциональноstringLastStatusDateTime: по YYYY-MM-DD, включительно
statusопциональноintegerЧисловой статус WMS

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].started_atstringНачало работы, когда фиксируется Может быть null.
data[].finished_atstringОкончание работы Может быть null.
data[].received_quantitynumberПринято штук в разгрузке
data[].itemsarray of objectСостав при одиночном чтении
data[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbsobject
data[].items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.itemsarray of object
data[].items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.incomeobject
data[].items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.itemsarray of object
data[].items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.servicesobject
data[].items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.itemsarray of object
data[].items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].idinteger
data[].items[].item_idintegerID карточки WMS Может быть null.
data[].items[].articlestringАртикул Может быть null.
data[].items[].namestringТовар Может быть null.
data[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/unloadings/
GET/extapi/v1/unloadings/{id}/
Разгрузки: чтение

Только чтение. См. общие правила доступа и семантику полей в начале документации.

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

ПараметрТипОписание
warehouse_idопциональноintegerРазрешённый склад; иначе склад ключа
client_idопциональноintegerКлиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНОinteger

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.started_atstringНачало работы, когда фиксируется Может быть null.
data.finished_atstringОкончание работы Может быть null.
data.received_quantitynumberПринято штук в разгрузке
data.itemsarray of objectСостав при одиночном чтении
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
planned_toопциональноstringDateTime: по YYYY-MM-DD, включительно

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].calculationobject
data[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data[].calculation.itemsarray of object
data[].calculation.items[].service_idinteger
data[].calculation.items[].namestring
data[].calculation.items[].quantitynumber
data[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data[].calculation.items[].manual_priceboolean
data[].calculation.items[].is_discountboolean
data[].calculation.items[].materialmixedМожет быть null.
data[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].idintegerID записи WMS
data[].numberstringНомер документа или внешний номер позиции FBS
data[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegernull у общих документов Может быть null.
data[].client_namestringИмя клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringШтатное название
data[].date_timestringДата документа; у перевозки — плановая погрузка
data[].planned_atstringПлановая дата Может быть null.
data[].status_changed_atstringТолько смена статуса Может быть null.
data[].posted_atstringПроведение Может быть null.
data[].shipped_atstringФизическая передача Может быть null.
data[].worker_idintegerID исполнителя Может быть null.
data[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data[].relationsarray of objectДоступные связанные документы; resource + id
data[].relations[].resourcestring
data[].relations[].idinteger
data[].progressobject
data[].progress.unitstringpieces либо order_lines
data[].progress.totalnumber
data[].progress.donenumber
data[].progress.remainingnumber
data[].progress.differencenumberЕсть у FBO и заявок на поставку
data[].rejected_quantitynumberБрак в приёмке
data[].itemsarray of objectСостав при одиночном чтении
data[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data[].items[].calculations.fbsobject
data[].items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.fbs.itemsarray of object
data[].items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.incomeobject
data[].items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.income.itemsarray of object
data[].items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].calculations.servicesobject
data[].items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data[].items[].calculations.services.itemsarray of object
data[].items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data[].items[].idinteger
data[].items[].item_idintegerID карточки WMS Может быть null.
data[].items[].articlestringАртикул Может быть null.
data[].items[].namestringТовар Может быть null.
data[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data[].items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/incomes/
GET/extapi/v1/incomes/{id}/
Приёмки: чтение

Только чтение. См. общие правила доступа и семантику полей в начале документации. Фильтр status_changed_from/to для этого раздела недоступен.

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

ПараметрТипОписание
include_calculationsопциональноinteger0/1. При 1 нужно отдельное право document-calculations/get; сохранённые расчёты документа, коробов FBO и товаров. Ничего не пересчитывает.
warehouse_idопциональноintegerРазрешённый склад; иначе склад ключа
client_idопциональноintegerКлиент. Общие документы доступны только когда весь их состав входит в выборку
idОБЯЗАТЕЛЬНОinteger

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПоля состава (items, packages, expected_items) выдаются только при чтении по ID. Необязательные поля зависят от раздела.
data.calculationobject
data.calculation.statestringДопустимо: "empty", "saved", "invalid".
data.calculation.itemsarray of object
data.calculation.items[].service_idinteger
data.calculation.items[].namestring
data.calculation.items[].quantitynumber
data.calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.calculation.items[].manual_priceboolean
data.calculation.items[].is_discountboolean
data.calculation.items[].materialmixedМожет быть null.
data.calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.idintegerID записи WMS
data.numberstringНомер документа или внешний номер позиции FBS
data.urlstringОтносительная ссылка в кабинет; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegernull у общих документов Может быть null.
data.client_namestringИмя клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringШтатное название
data.date_timestringДата документа; у перевозки — плановая погрузка
data.planned_atstringПлановая дата Может быть null.
data.status_changed_atstringТолько смена статуса Может быть null.
data.posted_atstringПроведение Может быть null.
data.shipped_atstringФизическая передача Может быть null.
data.worker_idintegerID исполнителя Может быть null.
data.blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.relationsarray of objectДоступные связанные документы; resource + id
data.relations[].resourcestring
data.relations[].idinteger
data.progressobject
data.progress.unitstringpieces либо order_lines
data.progress.totalnumber
data.progress.donenumber
data.progress.remainingnumber
data.progress.differencenumberЕсть у FBO и заявок на поставку
data.rejected_quantitynumberБрак в приёмке
data.itemsarray of objectСостав при одиночном чтении
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
403Нет доступа
404Документ не найден
422Слишком большой состав
Попробовать запрос
GET /extapi/v1/incomes/{id}/
GET/extapi/v1/warehouses/
Разрешённые активные склады

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerПример: 1
data[].namestringПример: "Основной склад"
[] — элемент массива, точка — вложенное поле.
Попробовать запрос
GET /extapi/v1/warehouses/
GET/extapi/v1/operations/summary/
Ежедневная сводка FBO и просроченных отгрузок

Требует два разрешения: operations/summary и shipments-fbo/list. Сводка до 5000 документов, иначе HTTP 422; план выбранного дня плюс незавершённые предыдущих дней. Не атомарный снимок: документы могут измениться во время чтения.

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

ПараметрТипОписание
dateопциональноstringДень отчёта YYYY-MM-DD; по умолчанию сегодня в WMS
warehouse_idопциональноintegerСклад
client_idопциональноintegerКлиент

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobject
data.datestring
data.totalsobject
data.totals.plannedintegerПример: 12
data.totals.overdueintegerПример: 3
data.totals.assembledintegerПример: 8
data.totals.postedintegerПример: 6
data.totals.shippedintegerПример: 4
data.totals.assembly_incompleteintegerПример: 7
data.totals.without_transportationintegerПример: 2
data.totals.without_driverintegerПример: 1
data.totals.without_carintegerПример: 1
data.shipments_fboarray of objectВ каждой записи также overdue
data.shipments_fbo[].calculationobject
data.shipments_fbo[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data.shipments_fbo[].calculation.itemsarray of object
data.shipments_fbo[].calculation.items[].service_idinteger
data.shipments_fbo[].calculation.items[].namestring
data.shipments_fbo[].calculation.items[].quantitynumber
data.shipments_fbo[].calculation.items[].pricenumberСохранённая цена услуги без материала, либо ручная цена, уже включающая материал
data.shipments_fbo[].calculation.items[].sumnumberСумма строки сохранённого расчёта с материалом и знаком скидки; без коэффициента начисления
data.shipments_fbo[].calculation.items[].manual_priceboolean
data.shipments_fbo[].calculation.items[].is_discountboolean
data.shipments_fbo[].calculation.items[].materialmixedМожет быть null.
data.shipments_fbo[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.shipments_fbo[].idintegerID записи WMS
data.shipments_fbo[].numberstringНомер документа или внешний номер позиции FBS
data.shipments_fbo[].urlstringОтносительная ссылка в кабинет; требует обычного входа
data.shipments_fbo[].warehouse_idintegerСклад фулфилмента
data.shipments_fbo[].client_idintegernull у общих документов Может быть null.
data.shipments_fbo[].client_namestringИмя клиента Может быть null.
data.shipments_fbo[].statusintegerШтатный числовой статус WMS
data.shipments_fbo[].status_namestringШтатное название
data.shipments_fbo[].date_timestringДата документа; у перевозки — плановая погрузка
data.shipments_fbo[].planned_atstringПлановая дата Может быть null.
data.shipments_fbo[].status_changed_atstringТолько смена статуса Может быть null.
data.shipments_fbo[].posted_atstringПроведение Может быть null.
data.shipments_fbo[].shipped_atstringФизическая передача Может быть null.
data.shipments_fbo[].worker_idintegerID исполнителя Может быть null.
data.shipments_fbo[].blockersarray of stringИнформационные признаки, не исчерпывающая проверка закрытия
data.shipments_fbo[].relationsarray of objectДоступные связанные документы; resource + id
data.shipments_fbo[].relations[].resourcestring
data.shipments_fbo[].relations[].idinteger
data.shipments_fbo[].marketplacestringПлощадка
data.shipments_fbo[].destinationstringНаправление
data.shipments_fbo[].external_order_idstringНомер на внешней площадке
data.shipments_fbo[].progressobject
data.shipments_fbo[].progress.unitstringpieces либо order_lines
data.shipments_fbo[].progress.totalnumber
data.shipments_fbo[].progress.donenumber
data.shipments_fbo[].progress.remainingnumber
data.shipments_fbo[].progress.differencenumberЕсть у FBO и заявок на поставку
data.shipments_fbo[].package_countintegerГрузомест FBO
data.shipments_fbo[].commentstringСохранённый комментарий заявки зОГ без динамических предупреждений и дополнительных полей коннектора; null, если заявка отсутствует или принадлежит другому клиенту/складу Может быть null.
data.shipments_fbo[].dispatch_orderobjectЗаявка зОГ; null, если отсутствует или принадлежит другому клиенту/складу Может быть null.
data.shipments_fbo[].dispatch_order.idinteger
data.shipments_fbo[].dispatch_order.numberstringПример: "зОГ-123"
data.shipments_fbo[].volume_m3numberШтатный объём ОГ в м³: объём грузомест и складской тары; без грузомест — плановый объём заявки. null, если нет грузомест и доступной заявки Может быть null.
data.shipments_fbo[].pallet_countintegerКоличество паллетомест из поля Pallets; отдельно от общего количества грузомест
data.shipments_fbo[].transportationsarray of objectПеревозки FBO: id, driver, car с учётом индивидуальных данных отгрузки
data.shipments_fbo[].packagesarray of objectКороба FBO: id, number, barcode, items
data.shipments_fbo[].packages[].calculationobject
data.shipments_fbo[].packages[].calculation.statestringДопустимо: "empty", "saved", "invalid".
data.shipments_fbo[].packages[].calculation.itemsarray of object
data.shipments_fbo[].packages[].calculation.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.shipments_fbo[].packages[].idinteger
data.shipments_fbo[].packages[].numberstring
data.shipments_fbo[].packages[].barcodestring
data.shipments_fbo[].packages[].itemsarray of object
data.shipments_fbo[].packages[].items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.shipments_fbo[].packages[].items[].idinteger
data.shipments_fbo[].packages[].items[].item_idintegerID карточки WMS Может быть null.
data.shipments_fbo[].packages[].items[].articlestringАртикул Может быть null.
data.shipments_fbo[].packages[].items[].namestringТовар Может быть null.
data.shipments_fbo[].packages[].items[].barcodestringОсновной штрихкод карточки Может быть null.
data.shipments_fbo[].packages[].items[].quantitynumber
data.shipments_fbo[].expected_itemsarray of objectПлановый состав FBO
data.shipments_fbo[].expected_items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.shipments_fbo[].expected_items[].calculations.fbsobject
data.shipments_fbo[].expected_items[].calculations.incomeobject
data.shipments_fbo[].expected_items[].calculations.servicesobject
data.shipments_fbo[].expected_items[].idinteger
data.shipments_fbo[].expected_items[].item_idintegerID карточки WMS Может быть null.
data.shipments_fbo[].expected_items[].articlestringАртикул Может быть null.
data.shipments_fbo[].expected_items[].namestringТовар Может быть null.
data.shipments_fbo[].expected_items[].barcodestringОсновной штрихкод карточки Может быть null.
data.shipments_fbo[].expected_items[].quantitynumber
metaobjectcount, warehouse_id, generated_at, complete=true
[] — элемент массива, точка — вложенное поле.
403Не хватает прав
422Слишком много документов; уточните клиента
Попробовать запрос
GET /extapi/v1/operations/summary/
GET/extapi/v1/transfers/
Перемещения: список

Нужно право 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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringАлиас date_from: отдельной плановой даты нет
planned_toопциональноstringАлиас date_to: отдельной плановой даты нет
statusопциональноintegerЧисловой статус WMS

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

200 OKСписок шапок

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID документа WMS
data[].numberstringНомер ПЕ или зПЕ
data[].urlstringСсылка на документ в WMS; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegerКлиент — владелец документа Может быть null.
data[].client_namestringНазвание клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringНазвание статуса WMS
data[].date_timestringДата документа
data[].planned_atstringСовпадает с date_time; отдельной плановой даты нет Может быть null.
data[].status_changed_atstringВсегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data[].posted_atstringДата проведения, если предусмотрена моделью документа Может быть null.
data[].shipped_atstringДата физической передачи, если предусмотрена моделью документа Может быть null.
data[].worker_idintegerID исполнителя, если указан в документе Может быть null.
data[].blockersarray of stringИнформационные признаки; для перемещений список пуст
data[].relationsarray of objectУ ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data[].relations[].resourcestring
data[].relations[].idinteger
data[].commentstringСохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
400Некорректный или неподдерживаемый фильтр
403Нет доступа к методу, складу или клиенту
Попробовать запрос
GET /extapi/v1/transfers/
GET/extapi/v1/transfers/{id}/
Перемещение: чтение

Нужно право transfers/get. Шапка, ссылка на заявку зПЕ и её товарный состав. Заявка должна принадлежать тому же клиенту и складу и входить в клиентские ограничения ключа; иначе 422 без частичного состава.

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

ПараметрТипОписание
warehouse_idопциональноintegerРазрешённый склад; иначе склад ключа
client_idопциональноintegerКлиент в пределах прав ключа
idОБЯЗАТЕЛЬНОinteger

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

200 OKПеремещение с составом заявки

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПеремещение ПЕ или заявка зПЕ. Список содержит шапки; items выдаётся только по ID. Состав ПЕ берётся из его заявки, и не является отдельным снимком факта. planned_at совпадает с date_time: отдельной плановой даты нет. status_changed_at равен null. У заявки ограничения ключа по клиентам проверяются и для получателя товара TargetLegal. Межскладские WarehouseTransfers в эти ресурсы не входят.
data.idintegerID документа WMS
data.numberstringНомер ПЕ или зПЕ
data.urlstringСсылка на документ в WMS; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegerКлиент — владелец документа Может быть null.
data.client_namestringНазвание клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringНазвание статуса WMS
data.date_timestringДата документа
data.planned_atstringСовпадает с date_time; отдельной плановой даты нет Может быть null.
data.status_changed_atstringВсегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data.posted_atstringДата проведения, если предусмотрена моделью документа Может быть null.
data.shipped_atstringДата физической передачи, если предусмотрена моделью документа Может быть null.
data.worker_idintegerID исполнителя, если указан в документе Может быть null.
data.blockersarray of stringИнформационные признаки; для перемещений список пуст
data.relationsarray of objectУ ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data.relations[].resourcestring
data.relations[].idinteger
data.commentstringСохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
data.itemsarray of objectТоварный состав заявки; у ПЕ читается из связанной зПЕ. Только при чтении по ID.
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноinteger1..500, по умолчанию 100
date_fromопциональноstringDateTime: с YYYY-MM-DD, включительно
date_toопциональноstringDateTime: по YYYY-MM-DD, включительно
planned_fromопциональноstringАлиас date_from: отдельной плановой даты нет
planned_toопциональноstringАлиас date_to: отдельной плановой даты нет
statusопциональноintegerЧисловой статус WMS

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

200 OKСписок шапок

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID документа WMS
data[].numberstringНомер ПЕ или зПЕ
data[].urlstringСсылка на документ в WMS; требует обычного входа
data[].warehouse_idintegerСклад фулфилмента
data[].client_idintegerКлиент — владелец документа Может быть null.
data[].client_namestringНазвание клиента Может быть null.
data[].statusintegerШтатный числовой статус WMS
data[].status_namestringНазвание статуса WMS
data[].date_timestringДата документа
data[].planned_atstringСовпадает с date_time; отдельной плановой даты нет Может быть null.
data[].status_changed_atstringВсегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data[].posted_atstringДата проведения, если предусмотрена моделью документа Может быть null.
data[].shipped_atstringДата физической передачи, если предусмотрена моделью документа Может быть null.
data[].worker_idintegerID исполнителя, если указан в документе Может быть null.
data[].blockersarray of stringИнформационные признаки; для перемещений список пуст
data[].relationsarray of objectУ ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data[].relations[].resourcestring
data[].relations[].idinteger
data[].commentstringСохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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Заявка с составом

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobjectПеремещение ПЕ или заявка зПЕ. Список содержит шапки; items выдаётся только по ID. Состав ПЕ берётся из его заявки, и не является отдельным снимком факта. planned_at совпадает с date_time: отдельной плановой даты нет. status_changed_at равен null. У заявки ограничения ключа по клиентам проверяются и для получателя товара TargetLegal. Межскладские WarehouseTransfers в эти ресурсы не входят.
data.idintegerID документа WMS
data.numberstringНомер ПЕ или зПЕ
data.urlstringСсылка на документ в WMS; требует обычного входа
data.warehouse_idintegerСклад фулфилмента
data.client_idintegerКлиент — владелец документа Может быть null.
data.client_namestringНазвание клиента Может быть null.
data.statusintegerШтатный числовой статус WMS
data.status_namestringНазвание статуса WMS
data.date_timestringДата документа
data.planned_atstringСовпадает с date_time; отдельной плановой даты нет Может быть null.
data.status_changed_atstringВсегда null: отдельная дата смены статуса не ведётся Может быть null.Пример: null
data.posted_atstringДата проведения, если предусмотрена моделью документа Может быть null.
data.shipped_atstringДата физической передачи, если предусмотрена моделью документа Может быть null.
data.worker_idintegerID исполнителя, если указан в документе Может быть null.
data.blockersarray of stringИнформационные признаки; для перемещений список пуст
data.relationsarray of objectУ ПЕ — ссылка на доступную заявку transfer-orders; у зПЕ список пуст
data.relations[].resourcestring
data.relations[].idinteger
data.commentstringСохранённый комментарий заявки; у ПЕ без доступной заявки — null Может быть null.
data.itemsarray of objectТоварный состав заявки; у ПЕ читается из связанной зПЕ. Только при чтении по ID.
data.items[].calculationsobjectТолько include_calculations=1. Приёмка: fbs и income; FBO: services. Расчёты на единицу товара, количество строки — отдельно; null при скрытой карточке. Может быть null.
data.items[].calculations.fbsobject
data.items[].calculations.fbs.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.fbs.itemsarray of object
data.items[].calculations.fbs.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.incomeobject
data.items[].calculations.income.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.income.itemsarray of object
data.items[].calculations.income.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].calculations.servicesobject
data.items[].calculations.services.statestringДопустимо: "empty", "saved", "invalid".
data.items[].calculations.services.itemsarray of object
data.items[].calculations.services.sumnumberСумма снимка, не начисление. invalid — снимок повреждён, sum=null. Текущие тарифы не запрашиваются Может быть null.
data.items[].idinteger
data.items[].item_idintegerID карточки WMS Может быть null.
data.items[].articlestringАртикул Может быть null.
data.items[].namestringТовар Может быть null.
data.items[].barcodestringОсновной штрихкод карточки Может быть null.
data.items[].quantitynumber
metaobject
meta.countinteger
meta.next_after_idintegernull — последняя страница Может быть null.
meta.warehouse_idinteger
meta.generated_atstring
[] — элемент массива, точка — вложенное поле.
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опциональноintegerID карточки товара
after_idопциональноintegerКурсор предыдущей страницы
limitопциональноinteger1..500, по умолчанию 100

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idinteger
data[].client_idintegerВладелец карточки товара
data[].articlestring
data[].namestring
data[].barcodestring
data[].is_derivedbooleanПодчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data[].archivedboolean
data[].fbsobject
data[].fbs.physicalnumberФизический годный остаток
data[].fbs.reservednumberТекущий резерв годного товара
data[].fbs.unreservednumberphysical − reserved; отрицательное значение сохраняется
data[].fbs.availablenumberСвободно с учётом замороженных зон и сборочной тары; не меньше нуля
data[].fbs.frozennumberНезарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data[].fbs.rejected_physicalnumberФизический брак; не включён в physical
data[].fbs.rejected_reservednumberРезерв брака; не включён в reserved
data[].fbs.balance_anomalybooleanОтрицательный физический остаток/резерв либо резерв превышает физический остаток
data[].fboobject
data[].fbo.physicalnumberФизический годный остаток
data[].fbo.reservednumberТекущий резерв годного товара
data[].fbo.unreservednumberphysical − reserved; отрицательное значение сохраняется
data[].fbo.availablenumberСвободно с учётом замороженных зон и сборочной тары; не меньше нуля
data[].fbo.frozennumberНезарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data[].fbo.rejected_physicalnumberФизический брак; не включён в physical
data[].fbo.rejected_reservednumberРезерв брака; не включён в reserved
data[].fbo.balance_anomalybooleanОтрицательный физический остаток/резерв либо резерв превышает физический остаток
metaobject
meta.countintegerЧисло элементов data; для одиночного чтения 1
meta.next_after_idintegerМожет быть null.
meta.warehouse_idinteger
meta.generated_atstring
meta.stock_basisstringДопустимо: "own_register".
meta.record_typestringДопустимо: "goods".
meta.cursor_basisstringitem_id у резервов, register_id у движений
meta.append_onlybooleanДля движений всегда 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Результат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataobject
data.idinteger
data.client_idintegerВладелец карточки товара
data.articlestring
data.namestring
data.barcodestring
data.is_derivedbooleanПодчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data.archivedboolean
data.fbsobject
data.fbs.physicalnumberФизический годный остаток
data.fbs.reservednumberТекущий резерв годного товара
data.fbs.unreservednumberphysical − reserved; отрицательное значение сохраняется
data.fbs.availablenumberСвободно с учётом замороженных зон и сборочной тары; не меньше нуля
data.fbs.frozennumberНезарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data.fbs.rejected_physicalnumberФизический брак; не включён в physical
data.fbs.rejected_reservednumberРезерв брака; не включён в reserved
data.fbs.balance_anomalybooleanОтрицательный физический остаток/резерв либо резерв превышает физический остаток
data.fboobject
data.fbo.physicalnumberФизический годный остаток
data.fbo.reservednumberТекущий резерв годного товара
data.fbo.unreservednumberphysical − reserved; отрицательное значение сохраняется
data.fbo.availablenumberСвободно с учётом замороженных зон и сборочной тары; не меньше нуля
data.fbo.frozennumberНезарезервированный годный остаток, заблокированный заморозкой или сборочной тарой
data.fbo.rejected_physicalnumberФизический брак; не включён в physical
data.fbo.rejected_reservednumberРезерв брака; не включён в reserved
data.fbo.balance_anomalybooleanОтрицательный физический остаток/резерв либо резерв превышает физический остаток
metaobject
meta.countintegerЧисло элементов data; для одиночного чтения 1
meta.next_after_idintegerМожет быть null.
meta.warehouse_idinteger
meta.generated_atstring
meta.stock_basisstringДопустимо: "own_register".
meta.record_typestringДопустимо: "goods".
meta.cursor_basisstringitem_id у резервов, register_id у движений
meta.append_onlybooleanДля движений всегда 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опциональноintegerID карточки товара
after_idопциональноintegerКурсор предыдущей страницы
limitопциональноinteger1..500, по умолчанию 100
stock_typeопциональноstringfbs или fbo
is_rejectопциональноinteger0 — годный, 1 — брак
placeопциональноstringТочное место хранения; допускается пустое

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idinteger
data[].client_idintegerВладелец карточки товара
data[].articlestring
data[].namestring
data[].barcodestring
data[].is_derivedbooleanПодчинённая карточка или виртуальный комплект; показаны только собственные записи регистра
data[].archivedboolean
data[].reservationsarray of object
data[].reservations[].stock_typestringДопустимо: "fbs", "fbo".
data[].reservations[].is_rejectboolean
data[].reservations[].reject_type_idinteger
data[].reservations[].placestring
data[].reservations[].income_line_idintegerID строки приёмки; null при ограничении клиентов ключа Может быть null.
data[].reservations[].source_typestringТип источника записи WMS
data[].reservations[].source_idintegerID источника; null при ограничении клиентов ключа Может быть null.
data[].reservations[].reserved_quantitynumberМинус сумма виртуальных движений в этом срезе. При отрицательном значении есть аномалия регистра
data[].reservations[].balance_anomalyboolean
metaobject
meta.countintegerЧисло элементов data; для одиночного чтения 1
meta.next_after_idintegerМожет быть null.
meta.warehouse_idinteger
meta.generated_atstring
meta.stock_basisstringДопустимо: "own_register".
meta.record_typestringДопустимо: "goods".
meta.cursor_basisstringitem_id у резервов, register_id у движений
meta.append_onlybooleanДля движений всегда 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опциональноintegerID карточки товара
after_idопциональноintegerКурсор предыдущей страницы
limitопциональноinteger1..500, по умолчанию 100
stock_typeопциональноstringfbs или fbo
is_rejectопциональноinteger0 — годный, 1 — брак
placeопциональноstringТочное место хранения; допускается пустое
is_virtualопциональноinteger0 — физические движения, 1 — виртуальные
date_fromопциональноstringYYYY-MM-DD, включительно
date_toопциональноstringYYYY-MM-DD, включительно

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

200 OKРезультат

Поля ответа

ПолеТипОписание
statusstringПример: "OK"
dataarray of object
data[].idintegerID записи регистра
data[].item_idinteger
data[].client_idintegerВладелец карточки
data[].articlestring
data[].namestring
data[].barcodestring
data[].date_timestringМожет быть null.
data[].is_virtualbooleanfalse — физическое движение; true — резерв
data[].quantity_deltanumberЗнаковое количество в регистре. В виртуальном слое минус означает резервирование, плюс — снятие резерва
data[].stock_typestringДопустимо: "fbs", "fbo".
data[].is_rejectboolean
data[].reject_type_idinteger
data[].placestring
data[].income_line_idintegerID строки приёмки; null при ограничении клиентов ключа Может быть null.
data[].source_typestringТип источника записи WMS
data[].source_idintegerID источника; null при ограничении клиентов ключа Может быть null.
metaobject
meta.countintegerЧисло элементов data; для одиночного чтения 1
meta.next_after_idintegerМожет быть null.
meta.warehouse_idinteger
meta.generated_atstring
meta.stock_basisstringДопустимо: "own_register".
meta.record_typestringДопустимо: "goods".
meta.cursor_basisstringitem_id у резервов, register_id у движений
meta.append_onlybooleanДля движений всегда false: журнал не является неизменяемой лентой
[] — элемент массива, точка — вложенное поле.
400Некорректный фильтр
401Нет авторизации
403Нет доступа к методу/складу/клиенту
404Ресурс не найден
422Слишком большой состав резервов
429Лимит запросов
Попробовать запрос
GET /extapi/v1/stock-movements/