#Получить заказ

GET /v1/orders/:id

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

#Параметры

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

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/orders/845" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data } = await res.json()
console.log('Заказ:', data.accountNumber, '—', data.price, data.currency)

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

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

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

#Поля ответа

Объект заказа со всеми полями — см. Поля заказа. Дополнительно ответ содержит вложенные массивы:

Поле Описание
basketItems[] Полные объекты позиций корзины этого заказа
payments[] Полные объекты оплат этого заказа
propertyValues[] Значения свойств заказа: ФИО, e-mail, телефон, адрес доставки и другие (зависит от настройки портала)
clients[] CRM-привязки к контактам/компаниям
requisiteLink Связь с реквизитами получателя
tradeBindings[] Привязки к внешним торговым площадкам

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

JSON 
{
  "success": true,
  "data": {
    "id": 845,
    "accountNumber": "443",
    "lid": "s1",
    "personTypeId": 5,
    "currency": "RUB",
    "price": 100,
    "discountValue": 0,
    "taxValue": 0,
    "sumPaid": 0,
    "statusId": "N",
    "dateInsert": "2026-04-21T06:48:16.000Z",
    "dateUpdate": "2026-04-21T06:48:16.000Z",
    "dateStatus": "2026-04-21T06:48:16.000Z",
    "payed": false,
    "canceled": false,
    "marked": false,
    "deducted": false,
    "responsibleId": 1,
    "userId": 1,
    "companyId": 15,
    "clients": [
      { "entityTypeId": 3, "entityId": 2471, "isPrimary": "Y", "roleId": 0, "sort": 0 },
      { "entityTypeId": 4, "entityId": 15, "isPrimary": "Y", "roleId": 0, "sort": 0 }
    ],
    "basketItems": [
      {
        "id": 187,
        "productId": 1119,
        "name": "Спортивный Костюм Розовый Вихрь",
        "price": 12,
        "currency": "RUB",
        "quantity": 1,
        "vatRate": 0,
        "vatIncluded": true
      }
    ],
    "payments": [
      {
        "id": 117,
        "paySystemId": 11,
        "paySystemName": "Наличные",
        "sum": 100,
        "currency": "RUB",
        "paid": true,
        "datePaid": "2026-04-21T06:48:16.000Z"
      }
    ],
    "propertyValues": [
      { "id": 9311, "orderPropsId": 41, "code": "EMAIL", "name": "E-Mail", "value": "buyer@example.com" }
    ],
    "comments": "",
    "xmlId": "",
    "externalOrder": false
  }
}

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

422 — заказ не найден:

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

#Ошибки

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

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

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