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

Обновить отгрузку

PATCH /v1/shipments/:id

Обновляет существующую отгрузку заказа интернет-магазина. Непереданные поля сохраняются.

Поля передаются плоско в корне JSON, без обёртки fields. Как сохраняются непереданные поля — Отгрузки.

Параметры

Параметр	Тип	Обяз.	Описание
`id` (path)	number	да	ID отгрузки. Список: `GET /v1/shipments`

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

Поле	Тип	Описание
`trackingNumber`	string	Трек-номер
`deliveryDocNum`	string	Номер документа отгрузки
`deliveryDocDate`	datetime	Дата документа отгрузки
`allowDelivery`	boolean	Доставка разрешена
`statusId`	string	Статус доставки. Список: `GET /v1/order-statuses?filter[type]=D`
`deliveryId`	number	ID службы доставки. Список: `GET /v1/delivery-services`
`priceDelivery`	number	Стоимость доставки
`basePriceDelivery`	number	Базовая стоимость доставки
`responsibleId`	number	ID ответственного сотрудника. Список: `GET /v1/users`. Пустое значение `null` или `0` не принимается
`companyId`	number	ID компании CRM. Список: `GET /v1/companies`. Существование компании не проверяется. Пустое значение принимается, только если у заказа тоже нет компании — поле `companyId` в `GET /v1/orders/:id`
`comments`	string	Комментарий к отгрузке
`xmlId`	string	Внешний код
`orderId`	number	RO. Задаётся только при создании
`deducted`	boolean	RO. Меняется через `ship` и `unship`
`customPriceDelivery`	boolean	RO. Признак ручной стоимости доставки

Полный список полей — GET /v1/shipments/fields.

Примеры

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/shipments/1205" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trackingNumber": "VIBE-DOC-2",
    "deliveryDocNum": "ТН-1205",
    "allowDelivery": true
  }'

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/shipments/1205" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "trackingNumber": "VIBE-DOC-2",
    "deliveryDocNum": "ТН-1205",
    "allowDelivery": true
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments/1205', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    trackingNumber: 'VIBE-DOC-2',
    deliveryDocNum: 'ТН-1205',
    allowDelivery: true,
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/shipments/1205', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    trackingNumber: 'VIBE-DOC-2',
    deliveryDocNum: 'ТН-1205',
    allowDelivery: true,
  }),
})

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

Поля ответа

Поле	Тип	Описание
`success`	boolean	`true` при успехе
`data`	object	Обновлённая отгрузка со всеми полями, включая непереданные. Все поля — Поля отгрузки

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

JSON

{
  "success": true,
  "data": {
    "accountNumber": "1027/2",
    "allowDelivery": true,
    "basePriceDelivery": 500,
    "canceled": false,
    "comments": "Тестовая отгрузка для документации",
    "companyId": null,
    "currency": "RUB",
    "customPriceDelivery": false,
    "dateAllowDelivery": "2026-10-06T11:31:17.000Z",
    "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": "ТН-1205",
    "deliveryId": 1,
    "deliveryName": "Доставка курьером",
    "deliveryXmlId": null,
    "discountPrice": 0,
    "empAllowDeliveryId": 1317,
    "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-2",
    "trackingStatus": null,
    "updated1c": false,
    "version1c": null,
    "xmlId": "bx_6ac4cdd46e442"
  }
}

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

400 — передан пустой responsibleId: