Получение списка заказов

Описание

GET /api/v1/orders

Возвращает объект, содержащий общее количество заказов, параметры пагинации и отсортированный массив идентификаторов заказов.

Пример запроса

curl -X GET "https://b2b.63kolesa.ru/api/v1/orders" -H "X-API-KEY: <API_KEY>"

fetch('https://b2b.63kolesa.ru/api/v1/orders', {
  headers: { 'X-API-KEY': '<API_KEY>' }
});

import requests
requests.get(
  'https://b2b.63kolesa.ru/api/v1/orders',
  headers={'X-API-KEY': '<API_KEY>'}
)

<?php
$ch = curl_init('https://b2b.63kolesa.ru/api/v1/orders');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-KEY: <API_KEY>']);
curl_exec($ch);
curl_close($ch);
?>

Параметры запроса

Все параметры передаются в query string и являются необязательными.

Пагинация

Параметр	Тип	По умолчанию	Описание
`page`	`int`	`1`	Номер страницы
`limit`	`int`	`20`	Кол-во записей на странице

Возвращаемое значение

{
    "error": false,
    "total": 13,
    "page": 1,
    "limit": 20,
    "count": 13,
    "pages": 1,
    "orders": [
        58952,
        57357,
        44592,
        44557,
        44556,
        38016,
        35354,
        33266,
        32536,
        29026,
        29025
  ]
}

Описание полей

Поле	Тип	Описание
`total`	`int`	Общее кол-во заказов
`page`	`int`	Текущая страница
`limit`	`int`	Кол-во записей на странице
`pages`	`int`	Общее кол-во страниц
`count`	`int`	Количество заказов
`orders`	`array`	Массив идентификаторов заказов

Возможные ошибки

Код ошибки	Описание	Решение
401	Пользователь не авторизован	Добавить `X-API-KEY` в заголовок запроса
500	Ошибка получения списка заказов	Связаться с менеджером