#Товарные позиции сделки

GET /v1/deals/:id/products

Возвращает список товарных позиций, привязанных к сделке.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да ID сделки

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deals/741/products" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deals/741/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { success, data } = await res.json()
console.log('Товаров:', data.length)

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

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

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

#Поля ответа

Поле Тип Описание
data array Массив товарных позиций
data[].productId number ID товара. Каталог: GET /v1/products
data[].productName string Название товара
data[].price number Цена за единицу
data[].quantity number Количество
data[].discount number Сумма скидки
data[].taxRate number/null Ставка налога (%)
data[].taxIncluded boolean Налог включён в цену

Показаны основные поля. Полный список (20 полей, включая priceAccount, measureCode и др.): Поля товаров.

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

JSON 
{
  "success": true,
  "data": [
    {
      "productId": 1,
      "productName": "Серверное оборудование",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false
    }
  ]
}

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

404 — сделка не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Сделка не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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