#Поиск заказов

POST /v1/orders/search

Поиск заказов с фильтрацией, сортировкой и авто-пагинацией. Аналогичен `GET /v1/orders`, но через POST — удобнее для сложных запросов с большим количеством условий.

#Поля запроса (body)

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/orders/fields.
Синтаксис фильтрации
limit number 50 Количество записей (до 5000)
select string[] — Выборка полей: ["id", "price", "currency", "statusId"]
order object — Сортировка: { "id": "desc" }

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/orders/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "statusId": "N", "payed": false },
    "limit": 10,
    "select": ["id", "price", "currency", "statusId", "dateInsert"]
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/orders/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "statusId": "N", "payed": false },
    "limit": 10,
    "select": ["id", "price", "currency", "statusId", "dateInsert"]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/orders/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { statusId: 'N', payed: false },
    limit: 10,
    select: ['id', 'price', 'currency', 'statusId', 'dateInsert'],
  }),
})

const { success, data, meta } = await res.json()
console.log('Найдено:', meta.total)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/orders/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { statusId: 'N', payed: false },
    limit: 10,
    select: ['id', 'price', 'currency', 'statusId', 'dateInsert'],
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив заказов (поля — см. Поля заказа)
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 845,
      "price": 100,
      "currency": "RUB",
      "statusId": "N",
      "dateInsert": "2026-04-21T06:48:16.000Z"
    },
    {
      "id": 841,
      "price": 100.5,
      "currency": "RUB",
      "statusId": "N",
      "dateInsert": "2026-04-04T20:02:28.000Z"
    }
  ],
  "meta": {
    "total": 181,
    "hasMore": true
  }
}

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

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown field 'foo'. Available: id, accountNumber, price, currency, statusId, userId, ..."
  }
}

#Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет в схеме. Список полей: `GET /v1/orders/fields`
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

#Известные особенности

select ограничивает поля в ответе. Если передан select, в каждом элементе data[] будут только перечисленные поля. Без select возвращаются все поля заказа.

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