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

Метод Get list of orders используется для получения списка заказов текущего реселлера или любого из его нижестоящих реселлеров.

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

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

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

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

Аргументы

Название

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

Тип данных

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

Описание

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 любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

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

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

sort

query

string

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

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

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

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

id.
created_at.
closed_at.
updated_at.
expiration_date.
provisioning_date.

filter[created_at]

query

string

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

Предназначен для фильтрации заказов по дате и времени создания в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:

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

filter[updated_at]

query

string

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

Предназначен для фильтрации заказов по дате дате и времени последнего обновления в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:

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`
Клиент	`account`
Платеж	`payment`
Подписка	`subscription`

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

Название

Тип данных

Описание

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::New — новая подписка.
ProvisioningItem::Prolong — пролонгация подписки.
ProvisioningItem::Renew — продление подписки.
ProvisioningItem::Upgrade — увеличение количества ресурсов подписки.
ProvisioningItem::Downgrade — уменьшение количества ресурсов подписки.
ProvisioningItem::SwitchPlan — изменение тарифного плана в рамках подписки.
ProvisioningItem::RegisterDomain — регистрация домена.
ProvisioningItem::TransferDomain — перенос домена.
ProvisioningItem::RegisterCertificate — регистрация SSL-сертификата.

status

string

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

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

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

quantity

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

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

resource_id

integer

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

payment_document_id

string

Номер платежа, связанного с заказом

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

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

data

array

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

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

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

data

object

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

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

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

data

object

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

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

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

data

object

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

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

included

array

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

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

Для списаний см. в Получение информации о списании.
Для клиента см. в Получение информации о клиенте.
Для платежа см. в Получение информации о платеже.

Для подписки:

Название			Тип данных	Описание
id			integer	ID подписки
type			string	Тип данных
attributes			object	Информация о подписке
	created_at		date	Дата и время создания подписки
	updated_at		date	Дата и время последнего изменения подписки
	auto_renewal		bool	Признак автоматического продления подписки: true — автоматическое продление включено. false — автоматическое продление отключено.
	billing_from		date	Дата начала генерации списаний по подписке
	expiration_date		date	Дата истечения срока действия подписки
	name		string	Название подписки
	auto_renew_point_days		integer	Точка автоматического продления подписки (в днях)
	start_date		date	Дата активации подписки
	status		string	Статус подписки (список статусов см. в Просмотр списка подписок)
	payment_model		string	Модель оплаты подписки. Возможные значения: prepay — Предоплата. postpay — Постоплата.
	payment_model_parameters		object	Параметры модели оплаты подписки
		credit_limit	float	Величина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для `payment_model = postpay`
		current_debt	float	Величина текущей задолженности по подписке. Возвращается только для `payment_model = postpay`

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

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

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

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

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

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

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

GET /api/v3/resellers/1/orders?page[size]=2&page[number]=2&sort=-updated_at&filter[created_at][gt]=2021-05-01T00:00:00.000000+0300&filter[created_at][lt]=2021-05-30T23:59:59.000000+0300&filter[status]=completed&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": "000001"
            },
            "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"
                    }
                }
            }
        },
        {
            "id": "13415",
            "type": "sales_orders",
            "attributes": {
                "created_at": "2021-05-28T15:02:34.509+03:00",
                "updated_at": "2021-05-28T15:02:36.372+03:00",
                "document_id": "SO007349",
                "status": "completed",
                "account_id": 990,
                "type": "SalesOrder",
                "closed_at": "2021-05-28T15:02:36.372+03:00",
                "expiration_date": "2021-06-01",
                "provisioning_date": "2021-05-28",
                "total": "54.18",
                "promo_code": "",
                "payment_id": null,
                "manager_id": 346,
                "requester_ip": "12.23.0.8",
                "custom_price": false,
                "created_by": "#1077 Bill Wong",
                "subscription_id": 3008519,
                "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": "317157",
                            "type": "charges"
                        },
                        {
                            "id": "317156",
                            "type": "charges"
                        }
                    ]
                },
                "account": {
                    "data": {
                        "id": "990",
                        "type": "accounts"
                    }
                },
                "payment": {
                    "data": null
                },
                "subscription": {
                    "data": {
                        "id": "3008519",
                        "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": {}
            }
        },
        {
            "id": "317157",
            "type": "charges",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "317156",
            "type": "charges",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "990",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "3008519",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2021-05-28T15:02:34.524836+0300",
                "updated_at": "2021-05-28T15:04:05.893641+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": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 5000,
                    "current_debt": 0
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2021-05-01T00%3A00%3A00.000000+0300&filter%5Bcreated_at%5D%5Blt%5D=2021-05-30T23%3A59%3A59.000000+0300&filter%5Bstatus%5D=completed&include=charges%2Csubscription%2Caccount%2Cpayment&page%5Bnumber%5D=2&page%5Bsize%5D=2&sort=-updated_at",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2021-05-01T00%3A00%3A00.000000+0300&filter%5Bcreated_at%5D%5Blt%5D=2021-05-30T23%3A59%3A59.000000+0300&filter%5Bstatus%5D=completed&include=charges%2Csubscription%2Caccount%2Cpayment&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=-updated_at",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2021-05-01T00%3A00%3A00.000000+0300&filter%5Bcreated_at%5D%5Blt%5D=2021-05-30T23%3A59%3A59.000000+0300&filter%5Bstatus%5D=completed&include=charges%2Csubscription%2Caccount%2Cpayment&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=-updated_at",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2021-05-01T00%3A00%3A00.000000+0300&filter%5Bcreated_at%5D%5Blt%5D=2021-05-30T23%3A59%3A59.000000+0300&filter%5Bstatus%5D=completed&include=charges%2Csubscription%2Caccount%2Cpayment&page%5Bnumber%5D=3&page%5Bsize%5D=2&sort=-updated_at",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/orders?filter%5Bcreated_at%5D%5Bgt%5D=2021-05-01T00%3A00%3A00.000000+0300&filter%5Bcreated_at%5D%5Blt%5D=2021-05-30T23%3A59%3A59.000000+0300&filter%5Bstatus%5D=completed&include=charges%2Csubscription%2Caccount%2Cpayment&page%5Bnumber%5D=98&page%5Bsize%5D=2&sort=-updated_at"
    }
}