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

Поля позиции отгрузки

GET /v1/shipment-items/fields

Возвращает схему полей позиции отгрузки — справочник для выборки и фильтрации полей, тела создания и изменения.

Примеры

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

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

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

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

const { data } = await res.json()
console.log('Поля позиции отгрузки:', Object.keys(data.fields))

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.fields object Схема полей. Ключ — имя поля, значение — описание поля
data.fields.<поле>.type string Тип значения: number, string, datetime
data.fields.<поле>.readonly boolean true — поле заполняется системой, передача при создании и изменении отклоняется с 400 READONLY_FIELD
data.fields.<поле>.required boolean Приходит со значением true и только у полей, обязательных при создании
data.fields.<поле>.readonlyOnUpdate boolean Приходит со значением true и только у полей, которые задаются при создании и не меняются при изменении. Передача такого поля в PATCH /v1/shipment-items/:id отклоняется с 400 READONLY_FIELD
data.fields.<поле>.label string Короткое название поля
data.fields.<поле>.description string Пояснение к полю
data.aggregatable array Поля, допустимые в агрегации позиций отгрузок: как поле числовой функции и как поле группировки groupBy
data.batch array Операции, доступные в пакетных операциях с позициями отгрузок: create, update, delete

Поля позиции отгрузки

Полный набор полей, который возвращает GET /v1/shipment-items/fields. Колонка RO — поле только для чтения.

Поле Тип RO Описание
id number да ID позиции отгрузки
orderDeliveryId number нет ID отгрузки. Список: GET /v1/shipments. Обязательно при создании. Задаётся только при создании: при изменении отклоняется с 400 READONLY_FIELD, в схеме помечено readonlyOnUpdate
basketId number нет ID позиции корзины того же заказа. Список: GET /v1/basket-items. Обязательно при создании. Задаётся только при создании: при изменении отклоняется с 400 READONLY_FIELD, в схеме помечено readonlyOnUpdate
quantity number нет Количество товара в отгрузке, допускается дробное, например 0.75. Обязательно при создании и в каждом изменении: PATCH без quantity отклоняется с 422 BITRIX_ERROR
reservedQuantity number да Зарезервированное количество
xmlId string нет Внешний код позиции
dateInsert datetime да Дата создания в формате ISO 8601, например 2026-10-07T09:55:27.000Z

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "basketId": {
        "type": "number",
        "readonly": false,
        "readonlyOnUpdate": true,
        "required": true,
        "label": "ID позиции корзины",
        "description": "Позиция корзины того же заказа. Поиск: GET /v1/basket-items."
      },
      "dateInsert": {
        "type": "datetime",
        "readonly": true,
        "label": "Дата создания",
        "description": "Дата создания."
      },
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID позиции отгрузки",
        "description": "Идентификатор позиции отгрузки."
      },
      "orderDeliveryId": {
        "type": "number",
        "readonly": false,
        "readonlyOnUpdate": true,
        "required": true,
        "label": "ID отгрузки",
        "description": "ID отгрузки. Поиск: GET /v1/shipments."
      },
      "quantity": {
        "type": "number",
        "readonly": false,
        "required": true,
        "label": "Количество",
        "description": "Количество."
      },
      "reservedQuantity": {
        "type": "number",
        "readonly": true,
        "label": "Зарезервировано",
        "description": "Зарезервировано."
      },
      "xmlId": {
        "type": "string",
        "readonly": false,
        "label": "Внешний код",
        "description": "Внешний код."
      }
    },
    "aggregatable": [
      "quantity",
      "reservedQuantity",
      "orderDeliveryId",
      "basketId"
    ],
    "batch": [
      "create",
      "update",
      "delete"
    ]
  }
}

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

401 — не передан API-ключ:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Ошибки

HTTP Код Описание
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 — Ошибки.

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