#E-commerce

Управляйте заказами интернет-магазина через Entity API. Оплаты, корзина, статусы заказов — всё через стандартные CRUD-операции.

#Обзор

E-commerce API предоставляет entity-обёртки для работы с интернет-магазином Битрикс24:

Оплаты (/v1/payments/*) — управление оплатами заказов
Корзина (/v1/basket-items/*) — позиции в корзине заказа
Статусы заказов (/v1/order-statuses/*) — управление статусами воронки заказов

Требуемый скоуп: sale, crm

Базовый URL: https://vibecode.bitrix24.tech/v1

Авторизация: заголовок X-Api-Key с вашим API-ключом.

#Быстрый старт

#Получите список оплат заказа

Terminal

curl -H "X-Api-Key: $VIBE_KEY" \
  "https://vibecode.bitrix24.tech/v1/payments?filter[orderId]=150"

Ответ:

JSON

{
  "success": true,
  "data": [
    {
      "id": 80,
      "orderId": 150,
      "paySystemId": 1,
      "sum": 12500,
      "currency": "RUB",
      "paid": "Y",
      "datePaid": "2026-03-24T14:30:00+03:00"
    }
  ]
}

#Оплаты

Entity: payments — оплаты заказов интернет-магазина.

#POST /v1/payments

Создаёт новую оплату для заказа.

Параметры тела запроса (в fields):

Параметр	Тип	Обязательный	Описание
`orderId`	number	да	ID заказа
`paySystemId`	number	да	ID платёжной системы
`sum`	number	да	Сумма оплаты
`currency`	string	нет	Валюта (по умолчанию — валюта заказа)
`paid`	string	нет	Оплачено: `Y` или `N`
`comments`	string	нет	Комментарий к оплате

Terminal

curl -X POST https://vibecode.bitrix24.tech/v1/payments \
  -H "X-Api-Key: $VIBE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "orderId": 150,
      "paySystemId": 1,
      "sum": 12500,
      "paid": "Y",
      "comments": "Оплата через внешний шлюз"
    }
  }'

JavaScript:

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/payments', {
  method: 'POST',
  headers: {
    'X-Api-Key': VIBE_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    fields: {
      orderId: 150,
      paySystemId: 1,
      sum: 12500,
      paid: 'Y',
      comments: 'Оплата получена от платёжного шлюза'
    }
  })
})

const { data } = await res.json()
console.log('Payment ID:', data.payment.id)