Получение информации о заказе

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

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
order_idpathintegerОбязательныйID заказа
includequerystringОпциональный

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

Объект

Значение параметра

Списания

charges

Клиентaccount
Платежpayment
Подпискаsubscription

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

Название

Тип данных

Описание

dataobject
Данные ответа

idstring
ID заказа

typestringТип данных

attributesobjectИнформация о заказе


created_at

string

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



updated_at

string

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



document_id

string

Номер заказа



status

string

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



account_id

integer

ID клиента



type

string

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



closed_atstringДата и время закрытия заказа


expiration_date

string

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



provisioning_date

string
Дата предоставления заказа. Для отложенных заказов дата предоставления больше даты создания


total

string

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



promo_code

string

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



payment_id

integer

ID платежа, который связан с заказом


manager_idintegerID сотрудника, создавшего заказ


stringIP-адрес пользователя, создавшего заказ


custom_priceboolПризнак заказа подписки по индивидуальной цене:
  • true — подписка была заказана по индивидуальным ценам.
  • false — подписка была заказана по ценам тарифного плана.


created_bystring

Информация о том, кто создал заказ:

  • ID и имя сотрудника реселлера или пользователя клиента, создавшего заказ.
  • system — заказ был создан автоматически.


subscription_idintegerID подписки, для которой создан заказ


items

array of objectsПеречень позиций в заказе



idintegerID позиции заказа



target_idintegerID сущности, которая относится к данной позиции заказа



target_typestring

Тип сущности, которая относится к данной позиции заказа:

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

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




typestring

Внутренний класс позиции заказа:

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

  • ProvisioningItem::Prolong — пролонгация подписки.

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

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

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

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

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

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

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




statusstring

Текущий статус позиции заказа:

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



descriptionstringКраткое описание позиции заказа



quantity

Зависит от позиции заказа

Количественное представление позиции в рамках заказа




resource_id

integer

ID заказанного ресурса тарифного плана. Только для target_type = SubscriptionResource


relationshipsobject
Перечень объектов, связанных с заказом


chargesobject
Информация о списаниях



dataarray

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


accountobjectИнформация о клиенте



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


paymentobjectИнформация о платеже



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных


subscriptionobjectИнформация о подписке



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
includedarray

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
attributesobjectАтрибуты (см. ниже)
  • Для списаний см. в Получение информации о Списании конечного клиента реселлера по ID.
  • Для клиента см. в Получение информации о клиенте.
  • Для платежа см. в Получение информации о платеже.
  • Для подписки:

    НазваниеТип данныхОписание
    idstringID подписки
    typestringТип данных
    attributesobjectИнформация о подписке

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

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

    auto_renewalbool

    Признак автоматического продления подписки:

    • true — автоматическое продление включено.
    • false — автоматическое продление отключено.

    billing_fromstringДата начала генерации списаний по подписке

    expiration_datestringДата истечения срока действия подписки

    namestringНазвание подписки

    auto_renew_point_daysintegerТочка автоматического продления подписки (в днях)

    start_datestringДата активации подписки

    statusstring

    Статус подписки (список статусов см. в Просмотр списка подписок)


    payment_modelstring

    Модель оплаты подписки. Возможные значения:

    • prepay — Предоплата.
    • postpay — Постоплата.

    payment_model_parametersobjectПараметры модели оплаты подписки


    credit_limitnumberВеличина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay


    current_debtnumberВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay

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

GET /api/v3/resellers/1/orders/13416?include=charges,account,payment,subscription
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "13416",
        "type": "sales_orders",
        "attributes": {
            "created_at": "2021-05-28T16:01:32.308+03:00",
            "updated_at": "2021-05-28T16:01:40.227+03:00",
            "document_id": "SO007350",
            "status": "completed",
            "account_id": 944,
            "type": "SalesOrder",
            "closed_at": "2021-05-28T16:01:40.227+03:00",
            "expiration_date": "2021-06-01",
            "provisioning_date": "2021-05-28",
            "total": "54.18",
            "promo_code": null,
            "payment_id": 10146,
            "manager_id": 346,
            "requester_ip": "12.23.0.8",
            "custom_price": false,
            "created_by": "#1038 James Tony",
            "subscription_id": 3008520,
            "items": [
                {
                    "id": 35924,
                    "target_id": 3012374,
                    "target_type": "Subscription",
                    "type": "ProvisioningItem::New",
                    "status": "completed",
                    "description": "Autoprovisioning Plan 1",
                    "quantity": 1
                },
                {
                    "id": 35925,
                    "target_id": 49964,
                    "target_type": "SubscriptionResource",
                    "type": "ProvisioningItem::Upgrade",
                    "status": "completed",
                    "description": "Resource 1",
                    "quantity": 1,
                    "resource_id": 152581
                }
            ]
        },
        "relationships": {
            "charges": {
                "data": [
                    {
                        "id": "317159",
                        "type": "charges"
                    },
                    {
                        "id": "317158",
                        "type": "charges"
                    }
                ]
            },
            "account": {
                "data": {
                    "id": "944",
                    "type": "accounts"
                }
            },
            "payment": {
                "data": {
                    "id": "10146",
                    "type": "payments"
                }
            },
            "subscription": {
                "data": {
                    "id": "3008520",
                    "type": "subscriptions"
                }
            }
        }
    },
    "included": [
        {
            "id": "317159",
            "type": "charges",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "317158",
            "type": "charges",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "944",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
        },
        {
            "id": "10146",
            "type": "payments",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "3008520",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2021-05-28T16:01:32.323030+0300",
                "updated_at": "2021-06-07T15:49:37.995072+0300",
                "auto_renewal": false,
                "billing_from": "2021-05-28",
                "expiration_date": "2021-06-28",
                "name": "CSPMonthly",
                "auto_renew_point_days": 0,
                "start_date": "2021-05-28",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        }
    ]
}