Получение информации о заказе
Метод Get order позволяет получить информацию о заказе для текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||||||||||
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | ||||||||||
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | ||||||||||
base_url | path | string | Обязательный | URL ActivePlatform | ||||||||||
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | ||||||||||
order_id | path | integer | Обязательный | ID заказа | ||||||||||
include | query | string | Опциональный | Предназначен для включения в ответ дополнительной информации о связанных объектах. Поддерживается следующий объект:
|
Модель ответа
Название | Тип данных | Описание | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object | Данные ответа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | ID заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Тип данных | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes | object | Информация о заказе | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | string | Дата и время создания заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | string | Дата и время последнего изменения заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
document_id | string | Номер заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | Статус заказа. Список статусов см. в Просмотр информации о заказе | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account_id | integer | ID клиента | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Тип заказа. Список типов см. в Управление заказами | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
closed_at | string | Дата и время закрытия заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expiration_date | string | Дата окончания, до которой заказ должен быть оплачен. Дата окончания устанавливается автоматически в зависимости от типа биллинга, но с учетом даты, рассчитанной исходя из установленного значения период отсрочки платежа в правиле предоставления (см. Создание правила предоставления) и даты создания заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisioning_date | string | Дата предоставления заказа. Для отложенных заказов дата предоставления больше даты создания | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | string | Общая сумма заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promo_code | string | Промокод, если данный код применялся при создании заказа (см. Создание скидки типа Промо-код) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_id | integer | ID платежа, который связан с заказом | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manager_id | integer | ID сотрудника, создавшего заказ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string | IP-адрес пользователя, создавшего заказ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_price | bool | Признак заказа подписки по индивидуальной цене:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_by | string | Информация о том, кто создал заказ:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_id | integer | ID подписки, для которой создан заказ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items | array of objects | Перечень позиций в заказе | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | integer | ID позиции заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_id | integer | ID сущности, которая относится к данной позиции заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_type | string | Тип сущности, которая относится к данной позиции заказа:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Внутренний класс позиции заказа:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | Текущий статус позиции заказа:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Краткое описание позиции заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | Зависит от позиции заказа | Количественное представление позиции в рамках заказа | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource_id | integer | ID заказанного ресурса тарифного плана. Только для | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_document_id | string | Номер платежа, который связан с заказом | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relationships | object | Перечень объектов, связанных с заказом | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
charges | object | Информация о списаниях | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account | object | Информация о клиенте | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment | object | Информация о платеже | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription | object | Информация о подписке | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | object | Информация о связанном объекте:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
included | array | Дополнительная информация о связанных объектах, указанных в запросе:
|
Пример запроса
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
}
],
"payment_document_id": "000002"
},
"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": {}
}
}
]
}