#Получить позицию корзины

GET /v1/basket-items/:id

Возвращает одну позицию корзины по идентификатору со всеми полями.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор позиции

#Примеры

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

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

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

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

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

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

const { success, data } = await res.json()
console.log('Позиция:', data.name, '×', data.quantity, '=', data.price * data.quantity, data.currency)

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

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

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

#Поля ответа

Поле Тип Описание
id number Идентификатор позиции
orderId number | null Идентификатор заказа. null у свободных позиций без заказа
productId number Идентификатор товара в каталоге
name string Название товара
price number Цена за единицу
basePrice number Базовая цена до скидки
discountPrice number Размер скидки за единицу
currency string Валюта
quantity number Количество
weight number | null Вес в граммах. null у виртуальных позиций с productId: 0
vatRate number | null Ставка НДС в долях единицы. null у виртуальных позиций с productId: 0
vatIncluded boolean Включён ли НДС в цену
customPrice boolean Защита цены от автопересчёта при изменении товара в каталоге
canBuy boolean Доступен ли товар к покупке
measureCode number | null Код единицы измерения. null у виртуальных позиций с productId: 0
measureName string | null Название единицы измерения. null у виртуальных позиций с productId: 0
dimensions string | null Габариты в формате сериализации PHP. null у виртуальных позиций с productId: 0
xmlId string Внешний идентификатор позиции
productXmlId string | null Внешний идентификатор товара в каталоге. null у виртуальных позиций с productId: 0
catalogXmlId string | null Внешний идентификатор каталога. null у виртуальных позиций с productId: 0
dateInsert datetime Дата создания
dateUpdate datetime Дата последнего изменения
dateRefresh datetime Дата последнего пересчёта цены

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

JSON 
{
  "success": true,
  "data": {
    "id": 9,
    "orderId": 33,
    "productId": 119,
    "name": "Домашние Тапочки Любимый Спорт",
    "price": 470,
    "basePrice": 470,
    "discountPrice": 0,
    "currency": "RUB",
    "quantity": 1,
    "weight": 0,
    "vatRate": 0,
    "vatIncluded": true,
    "customPrice": false,
    "canBuy": true,
    "barcodeMulti": false,
    "measureCode": 796,
    "measureName": "шт",
    "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
    "xmlId": "bx_5fc9f8c57fe6c",
    "productXmlId": "1000000475",
    "catalogXmlId": "FUTURE-1C-CATALOG",
    "type": null,
    "sort": 200,
    "properties": [
      {
        "id": 17,
        "basketId": 9,
        "code": "CATALOG.XML_ID",
        "name": "Catalog XML_ID",
        "value": "FUTURE-1C-CATALOG",
        "sort": 100,
        "xmlId": "bx_5fc9f8c57ff3e"
      },
      {
        "id": 19,
        "basketId": 9,
        "code": "PRODUCT.XML_ID",
        "name": "Product XML_ID",
        "value": "1000000475",
        "sort": 100,
        "xmlId": "bx_5fc9f8c57ffb2"
      }
    ],
    "reservations": [],
    "dateInsert": "2020-12-04T07:52:21.000Z",
    "dateUpdate": "2022-11-02T05:10:13.000Z"
  }
}

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

422 — позиция не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "basket item is not exists"
  }
}

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Позиция с таким ID не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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