Для AI-агентов: markdown этой страницы — /docs-content/entities/shipment-items/search.md индекс документации — /llms.txt

Поиск позиций отгрузок

POST /v1/shipment-items/search

Поиск позиций отгрузок заказов интернет-магазина с фильтрацией, сортировкой и автоматической пагинацией. Параметры передаются в теле POST-запроса. Подходит для сложных фильтров и широких диапазонов дат. Для простых выборок до 5000 записей хватает списка позиций отгрузок.

Поля запроса (body)

Поле Тип Обяз. По умолч. Описание
filter object нет — Фильтрация по полям GET /v1/shipment-items/fields.
Синтаксис фильтрации. Пример: { "basketId": 1387 }
select string[] нет — Выборка полей: ["id", "orderDeliveryId", "quantity"]. Принимается и строка через запятую. Неизвестное поле не вызывает ошибку: его нет в элементах data, а в meta.warnings приходит предупреждение UNKNOWN_SELECT_FIELD с именем поля в field
sort string нет — Сортировка кратким синтаксисом: "-id", минус означает убывание
order object нет — Сортировка объектом: { "id": "asc" }. Если передан и sort, действует sort
limit number нет 50 Количество записей, от 1 до 5000. Значение больше 5000 приводится к 5000 без ошибки
offset number нет 0 Пропустить N записей. Вместе с фильтром по диапазону дат шире 14 дней отклоняется, если не передан autoWindow: false — см. UNSTABLE_OFFSET_PAGINATION в разделе «Ошибки»
autoWindow boolean нет true Разбивать выборку по недельным окнам при фильтре по диапазону dateInsert шире 14 дней. false отключает разбиение
withTotal boolean нет — Нужно ли количество записей в meta.total. Подробнее — Листание и количество записей

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/shipment-items/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "basketId": 1387 },
    "select": ["id", "orderDeliveryId", "quantity"],
    "order": { "id": "asc" }
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/shipment-items/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "basketId": 1387 },
    "select": ["id", "orderDeliveryId", "quantity"],
    "order": { "id": "asc" }
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipment-items/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { basketId: 1387 },
    select: ['id', 'orderDeliveryId', 'quantity'],
    order: { id: 'asc' },
  }),
})

const { success, data, meta } = await res.json()
for (const item of data) {
  console.log(`Отгрузка ${item.orderDeliveryId}: ${item.quantity}`)
}

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipment-items/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { basketId: 1387 },
    select: ['id', 'orderDeliveryId', 'quantity'],
    order: { id: 'asc' },
  }),
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив позиций отгрузок
data[].id number Идентификатор позиции отгрузки
data[].orderDeliveryId number ID отгрузки. Список: GET /v1/shipments
data[].basketId number ID позиции корзины. Список: GET /v1/basket-items
data[].quantity number Количество товара в отгрузке, бывает дробным
data[].reservedQuantity number Зарезервированное количество
data[].xmlId string Внешний код позиции
data[].dateInsert datetime Дата создания, ISO 8601
meta.total number Сколько записей подошло под фильтр. Может не прийти — см. поле withTotal
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.durationMs number Длительность запроса в миллисекундах
meta.autoWindowed boolean true, если выборка была разбита по временны́м окнам
meta.windowCount number Число окон. Приходит при autoWindowed: true
meta.windowErrors number Сколько окон завершилось ошибкой. Приходит, если ошиблась часть окон
meta.windowErrorSample object Код и текст ошибки первого неудачного окна. Приходит вместе с windowErrors
meta.batchWaves number Число волн параллельных запросов. Приходит при autoWindowed: true
meta.warnings array Предупреждения о параметрах запроса: code, message, field. Приходит, только если предупреждения есть
meta.hint string Совет сузить диапазон дат или отключить разбиение. Приходит, если поиск прошёл больше 10 окон и длился дольше 10 секунд
meta.pageErrorSample object Код и текст ошибки, из-за которой автоматическая пагинация остановилась раньше. Приходит, только если в data меньше записей, чем limit

Пример ответа

Запрос с select возвращает только перечисленные поля:

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1347,
      "orderDeliveryId": 1195,
      "quantity": 0.25
    },
    {
      "id": 1353,
      "orderDeliveryId": 1207,
      "quantity": 0.75
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "durationMs": 342
  }
}

Пример ответа при ошибке

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'foo' for entity 'shipment-items'. Available: basketId, dateInsert, id, orderDeliveryId, quantity, reservedQuantity, xmlId"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет в схеме. Список полей: GET /v1/shipment-items/fields
400 INVALID_FILTER_FIELD Имя поля в фильтре начинается с неподдерживаемого префикса @ или !@
400 INVALID_FILTER_OPERATOR Неизвестный оператор фильтра, пустой объект в значении условия или логическое условие $or
400 INVALID_FILTER_SHAPE filter передан не объектом условий, например строкой, числом или массивом
400 INVALID_DUPLICATE_FILTER_FIELD Два условия фильтра сводятся к одному условию Битрикс24, например $ne и != на одном поле. Передайте одно из них
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет в схеме
400 INVALID_SORT_TYPE sort или order передан значением неподходящего типа, например числом
400 INVALID_SORT_DIRECTION Направление в order или в объектной форме sort не из списка asc, desc, ASC, DESC, 1, -1
400 INVALID_LIMIT limit не является числом
400 INVALID_SELECT_TYPE select не является строкой или массивом строк
400 INVALID_REQUEST Тело запроса не является JSON-объектом
400 UNSTABLE_OFFSET_PAGINATION offset больше нуля вместе с фильтром по диапазону дат шире 14 дней. Возьмите всё одним запросом с limit до 5000, либо передайте autoWindow: false с сортировкой по id, либо режьте диапазон дат на части сами
403 SCOPE_DENIED API-ключ не имеет скоупа sale
403 MANAGEMENT_KEY_NO_ENTITY_ACCESS Запрос сделан ключом управления. Для сущностей нужен ключ приложения или личный ключ со скоупом sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный API-ключ не найден
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Разбиение по временны́м окнам. С окнами выборка обходит потолок в 5000 записей на один вызов. Диапазон с 1 января 2025 по 8 октября 2026 года ушёл в 93 окна тремя волнами: meta.windowCount: 93, meta.batchWaves: 3. Тот же запрос с autoWindow: false вернул те же 104 записи одним проходом.

Частичный отказ окон не прерывает запрос. Если ошиблась часть окон, ответ приходит с success: true и записями только из успешных окон. Прежде чем считать выборку полной, проверьте, что meta.windowErrors не пришёл.

Смотрите также