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

Получить позицию отгрузки

GET /v1/shipment-items/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор позиции отгрузки. Список: GET /v1/shipment-items
select (query) string нет Выборка полей через запятую: ?select=id,orderDeliveryId,quantity. В data приходят только перечисленные поля. Неизвестное поле не вызывает ошибку: его нет в data, а в meta.warnings приходит предупреждение UNKNOWN_SELECT_FIELD с именем поля в field. Список полей: GET /v1/shipment-items/fields

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/shipment-items/1353" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/shipment-items/1353" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipment-items/1353', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`Отгрузка ${data.orderDeliveryId}: позиция корзины ${data.basketId}, количество ${data.quantity}`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/shipment-items/1353', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Позиция отгрузки
data.id number Идентификатор позиции отгрузки
data.orderDeliveryId number ID отгрузки. Получить отгрузку: GET /v1/shipments/:id
data.basketId number ID позиции корзины. Получить позицию корзины: GET /v1/basket-items/:id
data.quantity number Количество товара в отгрузке, бывает дробным
data.reservedQuantity number Зарезервированное количество
data.xmlId string Внешний код позиции
data.dateInsert datetime Дата создания, ISO 8601
meta.warnings array Предупреждения о параметрах запроса: code, message, field. Приходит, только если предупреждения есть

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

JSON 
{
  "success": true,
  "data": {
    "basketId": 1387,
    "dateInsert": "2026-10-07T09:55:27.000Z",
    "id": 1353,
    "orderDeliveryId": 1207,
    "quantity": 0.75,
    "reservedQuantity": 0,
    "xmlId": "vibe-doc-si-1"
  }
}

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

404 — позиция отгрузки не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "shipment item is not exists"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является целым неотрицательным числом
404 ENTITY_NOT_FOUND Позиции отгрузки с таким id нет. Текст ошибки — shipment item is not exists
404 ENTITY_NOT_FOUND Запрос выполнился, но позиции в ответе нет. Так отвечает позиция системной отгрузки и позиция отгрузки, которой уже нет. Текст ошибки — shipmentItem <id> not found
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-ключ не имеет настроенных токенов

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

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

Позиция из списка может не открываться по id. Позиции, на которые этот метод отвечает 404 с текстом shipmentItem <id> not found, при этом возвращаются списком GET /v1/shipment-items. Состав отгрузки получайте списком с filter[orderDeliveryId]: он отдаёт и такие позиции.

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