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

Поиск отгрузок

POST /v1/shipments/search

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

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

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

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/shipments/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "orderId": 1027, "deducted": false },
    "select": ["id", "orderId", "deliveryName", "priceDelivery", "trackingNumber"],
    "sort": "-id",
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/shipments/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "orderId": 1027, "deducted": false },
    "select": ["id", "orderId", "deliveryName", "priceDelivery", "trackingNumber"],
    "sort": "-id",
    "limit": 10
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { orderId: 1027, deducted: false },
    select: ['id', 'orderId', 'deliveryName', 'priceDelivery', 'trackingNumber'],
    sort: '-id',
    limit: 10,
  }),
})

const { success, data, meta } = await res.json()
console.log('Без отметки «отгружено»:', data.length)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { orderId: 1027, deducted: false },
    select: ['id', 'orderId', 'deliveryName', 'priceDelivery', 'trackingNumber'],
    sort: '-id',
    limit: 10,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив отгрузок. Все поля — Поля отгрузки
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.pageErrorSample object Код и текст ошибки, из-за которой автоматическая пагинация остановилась раньше. Приходит, только если в data меньше записей, чем limit

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1205,
      "orderId": 1027,
      "deliveryName": "Доставка курьером",
      "priceDelivery": 500,
      "trackingNumber": "VIBE-DOC-1"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false,
    "durationMs": 278
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'unknownField' for entity 'shipments'. Available: accountNumber, allowDelivery, basePriceDelivery, canceled, comments, companyId, currency, customPriceDelivery, dateAllowDelivery, dateCanceled, dateDeducted, dateInsert, dateMarked, dateResponsibleId, deducted, deliveryDocDate, deliveryDocNum, deliveryId, deliveryName, deliveryXmlId, discountPrice, empAllowDeliveryId, empCanceledId, empDeductedId, empMarkedId, empResponsibleId, externalDelivery, id, id1c, marked, orderId, priceDelivery, reasonMarked, reasonUndoDeducted, responsibleId, statusId, statusXmlId, system, trackingDescription, trackingLastCheck, trackingNumber, trackingStatus, updated1c, version1c, xmlId, shipmentItems"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет в схеме. Список полей: GET /v1/shipments/fields
400 INVALID_FILTER_FIELD Имя поля в фильтре начинается с неподдерживаемого префикса @ или !@
400 INVALID_FILTER_OPERATOR Неизвестный оператор фильтра, пустой объект в значении условия или логическое условие $or
400 INVALID_FILTER_SHAPE filter передан не объектом условий, например строкой, числом или массивом
400 INVALID_DUPLICATE_FILTER_FIELD Два условия фильтра сводятся к одному условию Битрикс24, например $ne и $nin на одном поле. Передайте одно из них
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет в схеме или по которому сортировать нельзя
400 INVALID_SORT_TYPE sort или order передан значением неподходящего типа, например числом
400 INVALID_SORT_DIRECTION Направление в order не из списка 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
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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

Разбиение по временны́м окнам. Фильтр по полю-дате (dateInsert, dateDeducted, dateAllowDelivery и другие) с диапазоном шире 14 дней разбивается на недельные окна, которые выполняются параллельными волнами. Так выборка обходит потолок в 5000 записей на один вызов.

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

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