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

Список отгрузок

GET /v1/shipments

Возвращает список отгрузок заказов интернет-магазина с поддержкой фильтрации, сортировки и автоматической пагинации.

Параметры

Параметр Тип По умолч. Описание
limit (query) number 50 Количество записей, от 1 до 5000. Значение больше 5000 приводится к 5000 без ошибки
offset (query) number 0 Пропустить N записей: offset=7 начинает выборку с 8-й записи
select (query) string — Выборка полей через запятую: ?select=id,orderId,deducted,trackingNumber. Неизвестное поле не вызывает ошибку: его нет в элементах data, а в meta.warnings приходит предупреждение UNKNOWN_SELECT_FIELD с именем поля в field
sort (query) string — Сортировка кратким синтаксисом: ?sort=-id, минус означает убывание
order (query) object — Сортировка: ?order[id]=desc
filter (query) object — Фильтрация по полям GET /v1/shipments/fields.
Синтаксис фильтрации. Пример: ?filter[orderId]=1027
withTotal (query) string — Нужно ли количество записей в meta.total: true или false. Подробнее — Листание и количество записей

Пагинация. При limit > 50 Вайбкод собирает ответ из нескольких последовательных чтений по 50 записей и возвращает все записи одним ответом. Есть ли записи дальше, показывает meta.hasMore.

Примеры

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/shipments?select=id,orderId,deducted,trackingNumber&filter[orderId]=1027" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/shipments?select=id,orderId,deducted,trackingNumber&filter[orderId]=1027" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments?select=id,orderId,deducted,trackingNumber&filter[orderId]=1027', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Отгрузок в заказе: ${data.length}`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments?select=id,orderId,deducted,trackingNumber&filter[orderId]=1027', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив отгрузок. Все поля — Поля отгрузки
meta.total number Общее количество записей, соответствующих фильтру. Может не прийти — см. параметр withTotal
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.warnings array Предупреждения о параметрах запроса: code, message, field. Приходит, только если предупреждения есть
meta.pageErrorSample object Код и текст ошибки, из-за которой автоматическая пагинация остановилась раньше. data тогда содержит записи до места остановки

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1205,
      "orderId": 1027,
      "deducted": false,
      "trackingNumber": "VIBE-DOC-1"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'foo' 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 Параметр filter не является ни объектом, ни JSON-строкой, либо в одном запросе смешаны обе формы записи фильтра
400 INVALID_DUPLICATE_FILTER_FIELD Два условия фильтра сводятся к одному условию Битрикс24, например $ne и != на одном поле. Передайте одно из них
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет в схеме или по которому сортировать нельзя
400 INVALID_SORT_DIRECTION Направление в order не из списка asc, desc, ASC, DESC, 1, -1
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 — Ошибки.

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

Позиций отгрузки в списке нет. Элементы data не содержат поле shipmentItems. Состав отгрузки возвращает GET /v1/shipments/:id.

Когда использовать search вместо list: POST /v1/shipments/search передаёт параметры в теле запроса, а не в строке запроса, и разбивает выборку по временны́м окнам при фильтре по диапазону дат шире 14 дней.

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