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

Метод Create a Change Order позволяет создать Заказ на изменение количества ресурсов для существующей Подписки текущего Реселлера или любого из его нижестоящих Реселлеров (см. Изменение количества ресурсов подписки).

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

POST {base_url}/api/v3/resellers/{reseller_id}/change_order

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
dataformobjectОбязательныйИнформация об атрибутах операции

attributesformobjectОбязательныйАтрибуты операции


subscription_idformintegerОбязательныйID Подписки, для которой необходимо изменить количество Ресурсов


resourcesformobjectОпциональныйПеречень Ресурсов Подписки в Заказе на переключение



dataformarrayОпциональныйИнформация о Ресурсе Подписки




subscription_resource_idformintegerОпциональныйID Ресурса Подписки




additionalformintegerОпциональныйДополнительное количество Ресурса Подписки сверх включенного в Тарифный план (см. Ресурсы тарифного плана)


promo_codeformstringОпциональныйКод для получения скидки

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

В случае отсутствия ошибок метод возвращает данные о созданном Заказе на изменение количества ресурсов (см. модель ответа в Получение информации о Заказе Реселлера). Статус ответа: 201 Created.

Ошибки

Статус ошибкиТекст ошибкиКомментарий
403Выполнение действия запрещеноСписок доступных действий над Подпиской см. в Получение информации о Подписке Реселлера
422Уменьшение количества ресурсов недоступно
Заказанное количество ресурсов не удовлетворяет доступному диапазону значенийОбщее количество Ресурса с учетом указанного дополнительного количества должно быть в пределах, заданных в Тарифном плане (см. Получение информации о Тарифном плане Реселлера)
Заказ не может быть завершен: сумма заказа превышает кредитный лимит по подпискеЧтобы создать Заказ, необходимо увеличить Кредитный лимит для Клиента (см. Просмотр и обновление информации о клиенте) или индивидуальный Кредитный лимит для данной Подписки (см. Просмотр и обновление информации о подписке)
Ресурс id недоступен для заказа в тарифном планеРесурс с указанным ID недоступен в рамках Тарифного плана
Для изменения количества ресурса id необходимо указать значение отличное от уже заказанногоВ Заказе указано количество Ресурса, равное текущему в Подписке (см. Получение информации о Подписке Реселлера). Необходимо указать измененное количество Ресурса

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

POST /api/v3/resellers/1/change_order
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
    "data": {
        "attributes": {
            "subscription_id": 3007514,
            "resources": {
                "data": [
                    {
                        "subscription_resource_id": 36229,
                        "additional": 1
                    }
                ]
            },
            "promo_code": ""
        }
    }
}

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

{
    "data": {
        "id": "11708",
        "type": "change_orders",
        "attributes": {
            "created_at": "2020-11-06T09:03:42.130+03:00",
            "updated_at": "2020-11-06T09:03:42.498+03:00",
            "document_id": "CO001248",
            "status": "completed",
            "account_id": 710,
            "type": "ChangeOrder",
            "closed_at": "2020-11-06T09:03:42.498+03:00",
            "expiration_date": "2020-12-05",
            "provisioning_date": null,
            "total": "58.02",
            "promo_code": "",
            "payment_id": null,
            "manager_id": 225,
            "requester_ip": null,
            "custom_price": false,
            "created_by": "#225 Adam Manager",
            "subscription_id": 3007514,
            "items": [
                {
                    "id": 20058,
                    "target_id": "SubscriptionResource",
                    "target_type": "SubscriptionResource",
                    "type": "ProvisioningItem::Upgrade",
                    "status": "completed",
                    "description": "HDD",
                    "quantity": 1
                }
            ]
        },
        "relationships": {
            "charges": {
                "data": [
                    {
                        "id": "311752",
                        "type": "charges"
                    }
                ]
            }
        }
    }
}