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

Метод Get a List of the Reseller's Orders используется для получения списка Заказов текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-Token header string Обязательный API токен Сотрудника, выполняющего операцию

Content-Type header string Обязательный Предназначен для идентификации формата и способа представления сущности

Accept header string Обязательный Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)

reseller_id path integer Обязательный ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

page[size] query integer Опциональный Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number] query integer Опциональный Параметр постраничной навигации. Номер страницы ответа

sort

query

string

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

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

sort={parameter} — сортировка по возрастанию
sort={-parameter} — сортировка по убыванию

В качестве {parameter} можно указать следующие параметры (см. Модель ответа):

id (ID Заказа)
created_at
closed_at
updated_at
expiration_date
provisioning_date

filter[created_at]

query

string

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

Предназначен для фильтрации Заказов по дате и времени создания в формате RFC 3339 (например, 2017-10-04T15:12:01.558009%2B03:00). Для указания диапазона используются следующие фильтры:

filter[created_at][gt] — дата и время более, чем указанные
filter[created_at][lt] — дата и время менее, чем указанные

filter[updated_at]

query

string

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

Предназначен для фильтрации Заказов по дате дате и времени последнего обновления в формате RFC 3339 (например, 2017-10-04T15:12:01.558009%2B03:00). Для указания диапазона используются следующие фильтры:

filter[updated_at][gt] — дата и время более, чем указанные
filter[updated_at][lt] — дата и время менее, чем указанные

filter[account_id] query string Опциональный Предназначен для фильтрации Заказов по ID Клиента

filter[type] query string Опциональный Предназначен для фильтрации Заказов по типу Заказа

filter[status] query string Опциональный Предназначен для фильтрации Заказов по статусу Заказа

filter[subscription_id]

query

string

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

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

include

query

string

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

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

Объект	Значение параметра
Списания	`charges`

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

Название

Тип данных

Описание

data

array

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

id

integer

ID Заказа

type

string

Тип данных

attributes

object

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

created_at

date

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

updated_at

date

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

document_id

string

Номер Заказа

status

string

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

account_id

integer

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

type

string

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

closed_at

date

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

expiration_date

date

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

provisioning_date

date

Дата предоставления Заказа. Применимо только для отложенных Заказов.

total

float

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

promo_code

string

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

payment_id

integer

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

manager_id

integer

ID и имя Сотрудника, который создал Заказ

requester_ip

string

IP адрес пользователя, который осуществил Заказ

custom_price

bool

Признак заказа Подписки по индивидуальной цене:

- true — Подписка была заказана по индивидуальным ценам
- false — Подписка была заказана по ценам Тарифного плана

created_by

string

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

ID и имя Сотрудника Реселлера или Пользователя Клиента, создавшего Заказ
system — Заказ был создан автоматически

subscription_id

integer

ID Подписки, для которой создан Заказ

items

array of objects

Перечень позиций в Заказе

id

integer

ID позиции Заказа

target_id

integer

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

target_type

string

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

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

type

string

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

"ProvisioningItem::Upgrade" — увеличение количества ресурсов подписки
"ProvisioningItem::New" — новая подписка
"ProvisioningItem::RegisterDomain" — регистрация домена
"ProvisioningItem::Renew" — продление подписки
"ProvisioningItem::SwitchPlan" — изменение тарифного плана в рамках подписки
"ProvisioningItem::Downgrade" — уменьшение количества ресурсов подписки
"ProvisioningItem::TransferDomain" — перенос домена
"ProvisioningItem::RegisterCertificate" — регистрация SSL-сертификата

status

string

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

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

description

string

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

quantity

integer

Изменение количества ресурса в рамках Заказа

relationships

array

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

charges

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

included

array

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

Название	Тип данных	Описание
id	integer	ID объекта
type	string	Тип данных
attributes	array	Атрибуты (см. ниже)

Атрибуты для Списаний: состав данных см. в Получение информации о Списании конечного клиента Реселлера по ID

links

array

Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

self

string

Ссылка на текущую страницу

first

string

Ссылка на первую страницу

Ссылка на предыдущую страницу

Ссылка на следующую страницу

last

string

Ссылка на последнюю страницу

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

GET /api/v3/resellers/1/orders?include=charges&page[size]=2&page[number]=190&filter[created_at][gt]=2020-08-01T10:00:00.000+03:00&filter[created_at][lt]=2020-11-01T10:00:00.000+03:00&filter[status]=completed
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "10567",
            "type": "sales_orders",
            "attributes": {
                "created_at": "2020-08-02T10:56:54.594+03:00",
                "updated_at": "2020-08-02T11:03:44.049+03:00",
                "document_id": "SO006035",
                "status": "completed",
                "account_id": 600,
                "type": "SalesOrder",
                "closed_at": "2020-08-02T11:03:44.049+03:00",
                "expiration_date": "2020-09-01",
                "provisioning_date": null,
                "total": "14.51",
                "promo_code": null,
                "payment_id": 7779,
                "manager_id": null,
                "requester_ip": "10.0.0.203",
                "custom_price": false,
                "created_by": "#17 Abramovich Roman",
                "subscription_id": 3007122,
                "items": [
                    {
                        "id": 18286,
                        "target_id": "SubscriptionResource",
                        "target_type": "SubscriptionResource",
                        "type": "ProvisioningItem::Upgrade",
                        "status": "completed",
                        "description": "HDD",
                        "quantity": 1
                    },
                    {
                        "id": 18285,
                        "target_id": "Subscription",
                        "target_type": "Subscription",
                        "type": "ProvisioningItem::New",
                        "status": "completed",
                        "description": "CSP monthly",
                        "quantity": 1
                    }
                ]
            },
            "relationships": {
                "charges": {
                    "data": [
                        {
                            "id": "308427",
                            "type": "charges"
                        },
                        {
                            "id": "308426",
                            "type": "charges"
                        }
                    ]
                }
            }
        },
        {
            "id": "10570",
            "type": "renewal_orders",
            "attributes": {
                "created_at": "2020-09-02T10:08:04.180+03:00",
                "updated_at": "2020-09-02T10:08:04.826+03:00",
                "document_id": "RN002160",
                "status": "completed",
                "account_id": 600,
                "type": "RenewalOrder",
                "closed_at": "2020-09-02T10:08:04.826+03:00",
                "expiration_date": "2020-10-02",
                "provisioning_date": null,
                "total": "14.52",
                "promo_code": "",
                "payment_id": 7782,
                "manager_id": null,
                "requester_ip": null,
                "custom_price": false,
                "created_by": "system",
                "subscription_id": 3007116,
                "items": [
                    {
                        "id": 18290,
                        "target_id": "Subscription",
                        "target_type": "Subscription",
                        "type": "ProvisioningItem::Renew",
                        "status": "completed",
                        "description": "CSP monthly",
                        "quantity": "2020-10-02"
                    }
                ]
            },
            "relationships": {
                "charges": {
                    "data": [
                        {
                            "id": "308456",
                            "type": "charges"
                        },
                        {
                            "id": "308457",
                            "type": "charges"
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": "308427",
            "type": "charges",
            "attributes": {
                "created_at": "2020-08-02T10:56:54.739078+0300",
                "updated_at": "2020-09-02T10:08:09.327220+0300",
                "subscription_id": 3007122,
                "subscription_resource_id": 34928,
                "quantity": 1,
                "operate_from": "2020-09-01",
                "duration": 0.033,
                "description": "Upgrade resource (recurring fee) \"HDD\" for Subscription #3007122 \"CSP monthly\"",
                "unit_price": "15.0",
                "amount": "0.5",
                "status": "deleted",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": "HDD",
                "plan_resource_id": 4340,
                "resource_id": 1454,
                "order_id": 10567,
                "operate_to": "2020-09-01",
                "close_date": "2020-09-01",
                "billing_date": "2020-09-01",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "0.5",
                "original_amount_currency": "EUR",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "600",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3007122",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1598",
                        "type": "plans"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        },
        {
            "id": "308426",
            "type": "charges",
            "attributes": {
                "created_at": "2020-08-02T10:56:54.732962+0300",
                "updated_at": "2020-09-02T10:08:07.740634+0300",
                "subscription_id": 3007122,
                "subscription_resource_id": 34928,
                "quantity": 1,
                "operate_from": "2020-08-02",
                "duration": 0.967,
                "description": "Upgrade resource (recurring fee) \"HDD\" for Subscription #3007122 \"CSP monthly\"",
                "unit_price": "15.0",
                "amount": "14.51",
                "status": "closed",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": "HDD",
                "plan_resource_id": 4340,
                "resource_id": 1454,
                "order_id": 10567,
                "operate_to": "2020-08-31",
                "close_date": "2020-08-31",
                "billing_date": "2020-08-01",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "14.51",
                "original_amount_currency": "EUR",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "600",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3007122",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1598",
                        "type": "plans"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        },
        {
            "id": "308456",
            "type": "charges",
            "attributes": {
                "created_at": "2020-09-02T10:08:04.297139+0300",
                "updated_at": "2020-09-02T10:08:04.857631+0300",
                "subscription_id": 3007116,
                "subscription_resource_id": 34903,
                "quantity": 1,
                "operate_from": "2020-09-02",
                "duration": 0.968,
                "description": "Renewal resource (recurring fee) \"HDD\" for subscription #3007116 \"CSP monthly\"",
                "unit_price": "15.0",
                "amount": "14.52",
                "status": "blocked",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": "HDD",
                "plan_resource_id": 4340,
                "resource_id": 1454,
                "order_id": 10570,
                "operate_to": "2020-09-30",
                "close_date": "2020-09-30",
                "billing_date": "2020-09-01",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "14.52",
                "original_amount_currency": "EUR",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "600",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3007116",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1598",
                        "type": "plans"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        },
        {
            "id": "308457",
            "type": "charges",
            "attributes": {
                "created_at": "2020-09-02T10:08:04.304794+0300",
                "updated_at": "2020-09-02T10:08:04.838551+0300",
                "subscription_id": 3007116,
                "subscription_resource_id": 34903,
                "quantity": 1,
                "operate_from": "2020-10-01",
                "duration": 0.032,
                "description": "Renewal resource (recurring fee) \"HDD\" for subscription #3007116 \"CSP monthly\"",
                "unit_price": "15.0",
                "amount": "0.48",
                "status": "opened",
                "type": "Charge::Recurring",
                "net_cost": null,
                "taxes_amount": 0,
                "subscription_resource_name": "HDD",
                "plan_resource_id": 4340,
                "resource_id": 1454,
                "order_id": 10570,
                "operate_to": "2020-10-01",
                "close_date": "2020-10-01",
                "billing_date": "2020-10-01",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "0.48",
                "original_amount_currency": "EUR",
                "currency_rate": "1.0",
                "currency_unit": 1
            },
            "relationships": {
                "taxes": {
                    "data": []
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "600",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3007116",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1598",
                        "type": "plans"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2020-08-01T10%3A00%3A00.000+03%3A00&filter%5Bcreated_at%5D%5Blt%5D=2020-11-01T10%3A00%3A00.000+03%3A00&filter%5Bstatus%5D=completed&include=charges&page%5Bnumber%5D=190&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2020-08-01T10%3A00%3A00.000+03%3A00&filter%5Bcreated_at%5D%5Blt%5D=2020-11-01T10%3A00%3A00.000+03%3A00&filter%5Bstatus%5D=completed&include=charges&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2020-08-01T10%3A00%3A00.000+03%3A00&filter%5Bcreated_at%5D%5Blt%5D=2020-11-01T10%3A00%3A00.000+03%3A00&filter%5Bstatus%5D=completed&include=charges&page%5Bnumber%5D=189&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2020-08-01T10%3A00%3A00.000+03%3A00&filter%5Bcreated_at%5D%5Blt%5D=2020-11-01T10%3A00%3A00.000+03%3A00&filter%5Bstatus%5D=completed&include=charges&page%5Bnumber%5D=191&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2020-08-01T10%3A00%3A00.000+03%3A00&filter%5Bcreated_at%5D%5Blt%5D=2020-11-01T10%3A00%3A00.000+03%3A00&filter%5Bstatus%5D=completed&include=charges&page%5Bnumber%5D=191&page%5Bsize%5D=2"
    }
}