For AI agents: markdown of this page — /docs-content-en/entities/orders/get.md documentation index — /llms.txt

Get an order

GET /v1/orders/:id

Returns a single order by identifier with all fields.

Parameters

Parameter Type Required Description
id (path) number yes Order identifier

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

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

JavaScript — OAuth application

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

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

Response fields

The order object with all fields — see Order fields. Additionally, the response contains nested arrays:

Field Description
basketItems[] Full objects of this order's basket items
payments[] Full objects of this order's payments
propertyValues[] Order property values: full name, email, phone, delivery address, and others (depends on the Bitrix24 account configuration)
clients[] CRM bindings to contacts and companies. Each element: {entityTypeId, entityId, isPrimary, roleId, sort}
requisiteLink Link to the recipient's requisites
tradeBindings[] Bindings to external trading platforms

The clients, payments, basketItems, propertyValues arrays are returned only by GET /v1/orders/:id — they are absent from the GET /v1/orders list. All four are read-only. Boolean fields inside the nested objects come as true/false — clients[].isPrimary, payments[].paid, basketItems[].vatIncluded, and others; dates are in the UTC …Z format.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 845,
    "accountNumber": "443",
    "lid": "s1",
    "personTypeId": 5,
    "currency": "USD",
    "price": 100,
    "discountValue": 0,
    "taxValue": 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": true, "roleId": 0, "sort": 0 },
      { "entityTypeId": 4, "entityId": 15, "isPrimary": true, "roleId": 0, "sort": 0 }
    ],
    "basketItems": [
      {
        "id": 187,
        "productId": 1119,
        "name": "Pink Whirl Sports Suit",
        "price": 12,
        "currency": "USD",
        "quantity": 1,
        "vatRate": 0,
        "vatIncluded": true
      }
    ],
    "payments": [
      {
        "id": 117,
        "paySystemId": 11,
        "paySystemName": "Cash",
        "sum": 100,
        "currency": "USD",
        "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
  }
}

Error response example

422 — order not found:

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

Errors

HTTP Code Description
422 BITRIX_ERROR An order with this ID was not found
403 SCOPE_DENIED The API key does not have the sale scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

See also