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

page

query

integer

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

Возвращается список Заказов по указанному номеру страницы

per_page

query

integer

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

Установка числа элементов на странице

sorting[field]

query

string

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

Сортировка списка по указанному полю

sorting[reversed]

query

string

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

Установка режима обратной сортировки по указанному полю:

• true — список будет отсортирован по убыванию.
• false — список будет отсортирован по возрастанию (используется по умолчанию).

filters[created_at]

query

date

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

Фильтрация списка по дате создания

filters[updated_at]

query

date

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

Фильтрация списка по дате обновления

filters[account_id]

query

integer

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

Фильтрация списка по ID Аккаунта

filters[type]

query

string

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

Фильтрация списка по типу Заказа

filters[status]

query

string

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

Фильтрация списка по статусу

id

integer

ID Заказа

document_id

string

Номер Заказа

status

string

Статус Заказа. Список статусов см. в Просмотр информации о заказе.

account_id

integer

ID Аккаунта, с которого произведена оплата

type

string

Тип Заказа. Список типов см. в Управление заказами

created_at

date

Дата и время создания Заказа

updated_at

date

Дата и время последнего изменения Заказа

expiration_date

date

Дата окончания, до которой Заказ должен быть оплачен. Дата окончания рассчитывается исходя из установленного значения "Период отсрочки платежа" в "Правиле предоставления" (см. Создание правила предоставления в ActivePlatform. Панель управления Оператора)

total

float

Общая сумма Заказа

promo_code

string

Промо-код, если данный код применялся при создании Заказа (см. Создание Скидки по Промо-коду в ActivePlatform. Панель управления Оператора)

payment_id

integer

items

• id — ID позиции Заказа.

• target_id — ID сущности (услуги или дополнительного ресурса), которая относится к данной позиции Заказа.

• target_type — тип сущности, которая относится к данной позиции Заказа:

  • Subscription — подписка.

  • SubscriptionResource — дополнительный ресурс подписки.

• type — внутренний класс позиции Заказа:

  • "ProvisioningItem::Upgrade" — увеличение количества ресурсов подписки.

  • "ProvisioningItem::New" — новая подписка.

  • "ProvisioningItem::RegisterDomain" — регистрация домена.

  • "ProvisioningItem::Renew" — продление подписки.

  • "ProvisioningItem::SwitchPlan" — изменение тарифного плана в рамках подписки.

  • "ProvisioningItem::Downgrade" — уменьшение количества ресурсов подписки.

  • "ProvisioningItem::TransferDomain" — перенос домена.

  • "ProvisioningItem::RegisterCertificate" — регистрация SSL-сертификата.

• status — текущий статус позиции Заказа:

  • waiting for payment — Заказ был осуществлен, ожидается его оплата.
  • provisioning — Заказ был подтвержден, услуга предоставляется.
  • provisioning failed — Заказ был подтвержден, но услуга не предоставляется.
  • completed — Заказ был успешно обработан.
  • cancelled — Заказ был отменен.

• description — краткое описание позиции Заказа.

charges

Список списаний, сформированных по данному Заказу:

• id — ID списания.
• subscription_id — ID подписки.
• subscription_resource_id — ID ресурса в подписке.
• subscription_resource_name — имя ресурса в подписке.
• plan_resource_id — ID ресурса в тарифном плане.
• resource_id — ID ресурса.
• quantity — количество заказанных единиц.
• operate_from — дата начала оплаченного периода.
• operate_to — дата окончания оплаченного периода.
• duration — доля оплаченного периода в месяце.
• description — подробная информация о списании.
• unit_price — стоимость одной единицы.
• amount — общая сумма списания.
• status — текущий статус списания:
  
  • new — клиент еще не оплатил услугу.
  • opened — услуга заказана, списание не оплачено клиентом, денежные средства на балансе клиента не заблокированы (для CSP подписок).
  • blocked — услуга заказана, списание не оплачено клиентом, денежные средства на балансе клиента были заблокированы.
  • waiting for a refund — клиент осуществил операцию, по которой ожидается подтверждение Сотрудником возврата денежных средств.
  • closed — клиент оплатил списание, денежные средства списаны с баланса клиента.
  • deleted — запись была удалена.
  • refunded — клиент осуществил операцию, по которой произошел успешный возврат денежных средств. 
  • waiting for approve — клиент осуществил операцию, по которой ожидается подтверждение операции Сотрудником.
• type — внутренний класс списания:
  • "Charge::Setup" — списание за установку подписки.
  • "Charge::Recurring" — списание за абонентскую плату подписки.
  • "Charge::Renewal" — списание за обновление подписки.
  • "Charge::RecurringResource" — списание за абонентскую плату ресурса подписки.
  • "Charge::SetupResource" — списание за установку ресурсов подписки.
  • "Charge::Transfer" — списание за перенос домена.
• order_id — ID Заказа, по которому произведено списание.
• close_date — дата, когда списание должно быть закрыто.
• created_at — дата и время создания записи.
• updated_at — дата и время последнего изменения записи.