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

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

GET /v1/shipments/:id

Возвращает одну отгрузку заказа интернет-магазина по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор отгрузки. Список: GET /v1/shipments
select (query) string нет Выборка полей через запятую: ?select=id,orderId,trackingNumber. В data приходят только перечисленные поля. Список полей: GET /v1/shipments/fields

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/shipments/1205" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/shipments/1205" \
  -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/1205', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Отгрузка:', data.accountNumber, '— позиций:', data.shipmentItems.length)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Отгрузка со всеми полями — см. Поля отгрузки
data.shipmentItems array Позиции отгрузки. Пустой массив, если позиций нет. Состав меняется через позиции отгрузок

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

JSON 
{
  "success": true,
  "data": {
    "accountNumber": "1027/2",
    "allowDelivery": false,
    "basePriceDelivery": 500,
    "canceled": false,
    "comments": "Тестовая отгрузка для документации",
    "companyId": null,
    "currency": "RUB",
    "customPriceDelivery": false,
    "dateAllowDelivery": null,
    "dateCanceled": null,
    "dateDeducted": null,
    "dateInsert": "2026-10-06T11:30:44.000Z",
    "dateMarked": null,
    "dateResponsibleId": "2026-10-06T11:30:44.000Z",
    "deducted": false,
    "deliveryDocDate": null,
    "deliveryDocNum": null,
    "deliveryId": 1,
    "deliveryName": "Доставка курьером",
    "deliveryXmlId": null,
    "discountPrice": 0,
    "empAllowDeliveryId": null,
    "empCanceledId": null,
    "empDeductedId": null,
    "empMarkedId": null,
    "empResponsibleId": 1317,
    "externalDelivery": false,
    "id": 1205,
    "id1c": null,
    "marked": false,
    "orderId": 1027,
    "priceDelivery": 500,
    "reasonMarked": null,
    "reasonUndoDeducted": null,
    "responsibleId": 1295,
    "shipmentItems": [],
    "statusId": "DN",
    "statusXmlId": null,
    "system": false,
    "trackingDescription": null,
    "trackingLastCheck": null,
    "trackingNumber": "VIBE-DOC-1",
    "trackingStatus": null,
    "updated1c": false,
    "version1c": null,
    "xmlId": "bx_6ac4cdd46e442"
  }
}

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

404 — отгрузка не найдена:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является целым неотрицательным числом
404 ENTITY_NOT_FOUND Отгрузки с таким id нет. Текст ошибки — shipment is not exists
404 ENTITY_NOT_FOUND Запрос выполнился, но отгрузки в ответе нет. Текст ошибки — shipment <id> not found
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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