Breadcrumbs

Получение отчета по заказам

Метод используется для получения отчета по заказам, включая заказы в статусе Отменен, для аккаунта, к которому есть доступ у текущего пользователя:

  • Отчет содержит список заказов с учетом заданных фильтров, отсортированный по ID заказов.

  • Состав отчета

    • Номер заказа.

    • Тип — тип заказа.

    • Статус — статус заказа.

    • Описание — в отдельной строке описание каждого неудаленного списания, сформированного для заказа. Описание включает номер и название подписки и даты начала и конца периода, покрытого списанием.

    • Количество — количество заказанных единиц услуги или ресурса.

    • Цена за единицу — цена за единицу услуги или ресурса.

    • Скидка — размер скидки по списанию.

    • Период — период (в месяцах), покрытый списанием.

    • Сумма — сумма списания.

    • Валюта — валюта списания.

    • Дата создания — дата создания заказа (ДД.ММ.ГГГГ).

    • Дата предоставления — дата предоставления заказа (ДД.ММ.ГГГГ).

    • Создан: Система — заказ создан автоматический, Менеджер — заказ создал менеджер или имя пользователя аккаунта, создавшего заказ.

    • Номер платежа (при наличии связанного платежа).

    Для пробных подписок и для заказов в статусе Отменен: Количество, Период — пустое значение, Цена за единицу — 0.

  • Имя файла отчета формируется по шаблону: Orders_<ID аккаунта>_<текущая дата ГГГГ-ММ-ДД>.

  • Формат файла отчета — .XLSX.

GET {reseller_domain}/internal_api/accounts/{account_id}/orders/export

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

Авторизация

Требуется авторизация с помощью 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 аккаунта, для которого запрашивается список заказов

filter[document_id][like]

query

string

Опциональный

Предназначен для фильтрации списка по части номера заказа

filter[status]

query

string

Опциональный

Предназначен для фильтрации списка по статусу заказа. Можно указать несколько значений через запятую. Доступные значения:

  • waiting_for_payment — Ожидает оплаты — заказ создан, связанный платеж ожидает оплаты.

  • waiting_for_provisioning — Ожидает предоставления — отложенный заказ подтвержден, начало предоставления услуги запланировано на дату предоставления.

  • provisioning — Предоставляется — заказ подтвержден, услуга в процессе активации.

  • provisioning_failed — Ошибка активации — заказ подтвержден, но услуга не была активирована.

  • completed — Завершен — заказ обработан.

  • cancelled — Отменен — заказ отменен вручную или автоматически.

filter[created_at]

query

string

Опциональный

Предназначен для фильтрации списка по дате создания заказа в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:

  • filter[created_at][gt] — дата больше, чем указанная.

  • filter[created_at][lt] — дата меньше, чем указанная.

  • filter[created_at][gteq] — дата больше, чем указанная, или равна.

  • filter[created_at][lteq] — дата меньше, чем указанная, или равна.

filter[subscription_id]

query

integer

Опциональный

Предназначен для фильтрации списка по ID связанной подписки

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

Метод возвращает файл отчета по заказам.

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

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