Получение информации о Заказе
Метод Get Order Info by ID позволяет получить информацию о существующем Заказе, используя ID данного Заказа.
GET /api/vendor/v1/orders/{id}.json?api_token={api_token}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
id | path | integer | Обязательный | ID Заказа |
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора) |
Модель ответа
Название | Тип данных | Описание |
---|---|---|
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 | ID Платежа, который связан с Заказом |
items | array | Перечень позиций в Заказе:
|
charges | array | Список списаний, сформированных по данному Заказу:
|
Пример запроса
GET http://billing.activeplatform.com:80/api/vendor/v1/orders/2010313.json?api_token=654321
Пример ответа
{
"id": 2010313,
"document_id": "RN002936",
"status": "cancelled",
"account_id": 2000532,
"type": "RenewalOrder",
"created_at": "2016-08-12T16:32:20.964+03:00",
"updated_at": "2016-10-01T01:03:56.000+03:00",
"expiration_date": "2016-08-12",
"total": 230,
"promo_code": null,
"payment_id": 2006909,
"items": [
{
"id": 16562,
"target_id": 2005882,
"target_type": "Subscription",
"type": "ProvisioningItem::Renew",
"status": "cancelled",
"description": "Fusion Manager"
}
],
"charges": [
{
"id": 754094,
"subscription_id": 2005882,
"subscription_resource_id": null,
"subscription_resource_name": null,
"plan_resource_id": null,
"resource_id": null,
"quantity": 1,
"operate_from": "2016-09-30",
"operate_to": "2017-07-30",
"duration": 1,
"description": "Renewal subscription (setup fee) #2005882 \"Service\"",
"unit_price": 30,
"amount": 30,
"status": "deleted",
"type": "Charge::Setup",
"order_id": 2010313,
"close_date": "2016-09-30",
"created_at": "2016-08-12T16:32:21.051680+0300",
"updated_at": "2016-10-01T01:03:56.349595+0300"
},
{
"id": 754105,
"subscription_id": 2005882,
"subscription_resource_id": null,
"subscription_resource_name": null,
"plan_resource_id": null,
"resource_id": null,
"quantity": 1,
"operate_from": "2017-07-15",
"operate_to": "2017-07-30",
"duration": 0.484,
"description": "Renewal subscription (recurring fee) #2005882 \"Service\"",
"unit_price": 20,
"amount": 9.68,
"status": "deleted",
"type": "Charge::Recurring",
"order_id": 2010313,
"close_date": "2017-07-30",
"created_at": "2016-08-12T16:32:21.570265+0300",
"updated_at": "2016-10-01T01:03:56.328776+0300"
}
]
}