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

Метод используется для получения информации о количестве заказов и связанных подписках аккаунта, к которому есть доступ у текущего пользователя. Полученную информацию можно использовать для построения фильтров.

GET {reseller_domain}/internal_api/accounts/{account_id}/order_statistics

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта, для которого запрашивается статистика заказов

Модель ответа

Название		Тип данных	Описание
count_by_statuses		object	Число заказов в каждом статусе. Если в каком-либо статусе нет ни одного заказа, соответствующий элемент объекта отсутствует
	waiting_for_payment	integer	Число заказов в статусе Ожидает оплаты
	waiting_for_provisioning	integer	Число заказов в статусе Ожидает предоставления
	provisioning	integer	Число заказов в статусе Предоставляется
	provisioning_failed	integer	Число заказов в статусе Ошибка активации
	completed	integer	Число заказов в статусе Завершен
	cancelled	integer	Число заказов в статусе Отменен
count		integer	Общее число заказов
subscriptions		array of objects	Список заказанных подписок
	id	integer	ID подписки
	name	string	Название подписки

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/1185/order_statistics' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "count_by_statuses": {
        "waiting_for_payment": 1,
        "cancelled": 1,
        "completed": 1
    },
    "count": 3,
    "subscriptions": [
        {
            "id": 3010785,
            "name": "Office"
        }
    ]
}