Создание Заказа

Метод Create an Order используется для создания Заказа.

Ограничения использования метода

Метод Create an Order не может быть использован для заказа Подписок на Услуги, для которых требуется указание дополнительных параметров (например, услуги Google и Microsoft). Вместо это используйте метод API v3 Create a Sales Order (см. Создание Заказа на покупку).

Метод Create an Order не генерирует Запрос на сертификат (CSR) и Закрытый ключ, которые требуется указать при заказе Подписки на Сертификат (см. Заказ подписки на сертификат), поэтому для успешного предоставления заказанной Подписки на Сертификат необходимо использование дополнительных инструментов интеграции.

POST /api/vendor/v1/orders.json?api_token={api_token}

Аргументы

Название

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

Тип данных

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

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

account_id

form

integer

Обязательный

ID Аккаунта

payment_modelformstringОбязательный

Модель оплаты Подписки. Возможные значения:

  • prepay — Предоплата.
  • postpay — Постоплата.
subscription_credit_limit_use_systemformboolОпциональный

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

  • true — используется системное значение Кредитного лимита по Подписке из Правила обслуживания или переопределенное на уровне Клиента.
  • false — используется значение, установленное в параметре subscription_credit_limit на уровне Заказа.

Параметр используется только для Заказов по Постоплате (payment_model = postpay)

subscription_credit_limitformfloatОпциональныйВеличина Кредитного лимита по подписке на уровне Заказа, если не используется системное значение значение Кредитного лимита по подписке (subscription_credit_limit_use_system = false). Параметр используется только для Заказов по Постоплате (payment_model = postpay)
promocodeformstringОпциональныйКод для получения скидки

items

form

array

Обязательный

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


plan_idformintegerОбязательныйID Тарифного плана


plan_period_id

form

integer

Обязательный

ID Периода Тарифного плана


resources

form

array

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

Перечень Ресурсов в Заказе



idformintegerОпциональныйID Ресурса



quantity

form

integer

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

Количество Ресурса


certificate_infoformstringОпциональныйСведения о Сертификате. Указывается только при заказе Подписки на Сертификат (см. Заказ подписки на сертификат)


approver_emailformstringОпциональныйEmail поставщика, на который будет отправлено письмо с запросом на подтверждение


server_typeformstringОпциональныйТип веб-сервера, который будет использовать сертификат


positionformstringОпциональныйДолжность сотрудника организации, для которой выдается сертификат


domainformstringОпциональныйПолностью определенное доменное имя (FQDN), для которого необходимо получить сертификат. Имя должно в точности соответствовать домену или поддомену, для которого производится заказ SSL


csrformstringОпциональныйЗаранее сгенерированный запрос на сертификат

nameformstringОпциональныйИмя домена. Указывается только при заказе Подписки на Домен (см. Заказ подписки на домен для клиента)


additional_params

form

array

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

Дополнительные параметры Заказа



idformintegerОпциональныйID параметра



value

form

Зависит от параметра

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

Значение параметра

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

Название

Тип данных

Описание

id

integer

ID Заказа

document_id

string

Номер Заказа

status

string

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

account_id

integer

ID Аккаунта, для которого создан Заказ

type

string

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

created_at

date

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

closed_at

date

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

expiration_date

date

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

total

float

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

promo_code

string

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

payment_id

integer

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

items

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

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

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

target_typestring

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

  • Subscription — Подписка.

  • SubscriptionResource — дополнительный Ресурс Подписки.


typestring

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

  • ProvisioningItem::Upgrade — увеличение количества Ресурсов Подписки.

  • ProvisioningItem::New — новая Подписка.

  • ProvisioningItem::RegisterDomain — регистрация домена.

  • ProvisioningItem::Renew — продление Подписки.

  • ProvisioningItem::SwitchPlan — изменение Тарифного плана в рамках Подписки.

  • ProvisioningItem::Downgrade — уменьшение количества Ресурсов Подписки.

  • ProvisioningItem::TransferDomain — перенос домена.

  • ProvisioningItem::RegisterCertificate — регистрация SSL-сертификата.


statusstring

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

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

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

charges

array

Список Списаний, сформированных по данному Заказу (см. Списания)


idintegerID Списания

subscription_idintegerID Подписки

subscription_resource_idintegerID Ресурса в Подписке

subscription_resource_namestringИмя Ресурса в Подписке

plan_resource_idintegerID Ресурса в Тарифном плане

resource_idintegerID Ресурса

quantityintegerКоличество заказанных единиц

operate_fromdateДата начала оплаченного периода в формате ГГГГ-ММ-ДД

operate_todateДата окончания оплаченного периода в формате ГГГГ-ММ-ДД

durationfloatДоля оплаченного периода в месяце

descriptionstringПодробная информация о Списании

unit_pricefloatСтоимость одной единицы

amountfloatОбщая сумма Списания

statusstringТекущий статус Списания:
  • new — Клиент еще не оплатил услугу.
  • opened — услуга заказана, Списание не оплачено Клиентом, денежные средства на Балансе клиента не заблокированы (для CSP подписок).
  • blocked — услуга заказана, Списание не оплачено Клиентом, денежные средства на Балансе клиента были заблокированы.
  • waiting for a refund — Клиент осуществил операцию, по которой ожидается подтверждение Сотрудником возврата денежных средств.
  • closed — Клиент оплатил Списание, денежные средства списаны с Баланса клиента.
  • deleted — запись была удалена.
  • refunded — Клиент осуществил операцию, по которой произошел успешный возврат денежных средств. 
  • waiting for approve — Клиент осуществил операцию, по которой ожидается подтверждение операции Сотрудником.

typestringВнутренний класс Списания:
  • Charge::Setup — Списание за установку Подписки.
  • Charge::Recurring — Списание за абонентскую плату Подписки.
  • Charge::Renewal — Списание за обновление Подписки.
  • Charge::RecurringResource — Списание за абонентскую плату ресурса Подписки.
  • Charge::SetupResource — Списание за установку ресурсов Подписки.
  • Charge::Transfer — Списание за перенос домена.

order_idintegerID Заказа, по которому произведено Списание

close_datedateДата, когда Списание должно быть закрыто, в формате ГГГГ-ММ-ДД

created_atdateДата и время создания записи

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

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

POST /api/vendor/v1/orders.json?api_token=vY5fwetestK3gJXZH5uHCw
{  
 "account_id": 505,
 "payment_model": "postpay",
 "subscription_credit_limit_use_system": false,
 "subscription_credit_limit": 1500.0,
 "items": [
      {
          "plan_id": 1376,
          "plan_period_id": 2529,
          "resources": [
          {
          	"id": 4057,
          	"quantity": 1
          }	
          ],
          "additional_params": []
      }
  ]
}
POST /api/vendor/v1/orders.json?api_token=vY5fwetestK3gJXZH5uHCw
{
"account_id": 1,
"payment_model": "prepay",
"items": [ { "plan_id": 6, "plan_period_id": 2, "name": "example.com" }]
}
POST /api/vendor/v1/orders.json?api_token=vY5fwetestK3gJXZH5uHCw
{
 "account_id":513,
   "payment_model":"postpay",
   "items":[
      {
         "plan_id":21,
         "plan_period_id":112,
         "resources":[          ],
         "certificate_info":{
            "approver_email":"admin@example.com",
            "server_type":"apachessl",
            "position":"CEO",
            "domain":"*.example.com",
            "csr":"-----BEGIN CERTIFICATE REQUEST-----\cTBk1vc2NvdzERMA8GA1UECgwITmV3T3JkZXIxETAPBgNVBAsMCEdGREZnc2ZnMSUwIwYDVQQDDBwqLnRlc3Q0NTY3OC5hcC10ZXN0LXRlYW0uY29tMRowGAYJKoZIhvcNAQkBDAtkZXBAZml4LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ2pW5mo+m69bm/giMcBJE3IyUwtMFj8nJQhp6PmkXZfO2I7R4MNS0pHvfTe8A+Pj40W8AlbWdEDdN+8E9LrFjUhrB6TCx9V1oxHF7m96auAieiPpZ0Az9hmm4fpBzGoVqAqjf5MJBW7z2aeUecjLtoUz3xZ8foTG5cy9J0GvgUko5fuQLIzmYpyZmKDzFaPSDgf9kchI0+emh0ebcMGvAolAIHr9B+jMlsh7YfBjd1kBmAa/1K4TjD8XLs1cJpQu84wwwSa4d9cUCv/ETi7COGorQpBFUJ2LZ1/JD//6Rh9h5ZZ3rq+ZIeVeKhJIPO7N+dc/W7PLNXdasD/di8ifnsCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQB5W0X687TC8gnNjOAOStMbNt0kKpBIzHNiOtlUBMB2tVaJjfAcsiXmOoqXyHKbPUZ8Ac+leNlQkqtGnkHUU5jX1RQAp9DqVQhyi3c0xbIMn2HEd5s0cD269cJGAdh/u2UPKNPM46N642scB/sqObI18fozOLF7DPoPSJPYgJ56C5RAbNdbxTFT4O9BlT5Goeypck3J986dFUQi32Gs9kEdWQyFo2Q3dMio5gSATHofxi5pBcmsiPoKOH1aZL+wtAABd8HWaEEOypRR4ejuopijnLPrqhke0z+7DfLriIFvXU8aBpGoG7253ftjUA5xYADkg1Ft35nARt7qeZomJD+q\n-----END CERTIFICATE REQUEST-----"
         }
      }
   ]
}

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

{
    "id": 8082,
    "document_id": "SO004723",
    "status": "provisioning",
    "account_id": 505,
    "type": "SalesOrder",
    "created_at": "2019-10-19T10:27:59.142+03:00",
    "closed_at": null,
    "expiration_date": "2019-11-01",
    "total": "0.42",
    "promo_code": null,
    "payment_id": null,
    "items": [
        {
            "id": 12138,
            "target_id": 3005691,
            "target_type": "Subscription",
            "type": "ProvisioningItem::New",
            "status": "waiting_for_payment",
            "description": "Csp endless"
        },
        {
            "id": 12139,
            "target_id": 30292,
            "target_type": "SubscriptionResource",
            "type": "ProvisioningItem::Upgrade",
            "status": "waiting_for_payment",
            "description": "Chill"
        }
    ],
    "charges": [
        {
            "id": 73511,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-10-01",
            "operate_to": "2020-10-18",
            "duration": 0.581,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "0.58",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-10-31",
            "created_at": "2019-10-19T10:27:59.918855+0300",
            "updated_at": "2019-10-19T10:27:59.918855+0300"
        },
        {
            "id": 73510,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-09-01",
            "operate_to": "2020-09-30",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-09-30",
            "created_at": "2019-10-19T10:27:59.912897+0300",
            "updated_at": "2019-10-19T10:27:59.912897+0300"
        },
        {
            "id": 73509,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-08-01",
            "operate_to": "2020-08-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-08-31",
            "created_at": "2019-10-19T10:27:59.906015+0300",
            "updated_at": "2019-10-19T10:27:59.906015+0300"
        },
        {
            "id": 73508,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-07-01",
            "operate_to": "2020-07-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-07-31",
            "created_at": "2019-10-19T10:27:59.897296+0300",
            "updated_at": "2019-10-19T10:27:59.897296+0300"
        },
        {
            "id": 73507,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-06-01",
            "operate_to": "2020-06-30",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-06-30",
            "created_at": "2019-10-19T10:27:59.890144+0300",
            "updated_at": "2019-10-19T10:27:59.890144+0300"
        },
        {
            "id": 73506,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-05-01",
            "operate_to": "2020-05-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-05-31",
            "created_at": "2019-10-19T10:27:59.882115+0300",
            "updated_at": "2019-10-19T10:27:59.882115+0300"
        },
        {
            "id": 73505,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-04-01",
            "operate_to": "2020-04-30",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-04-30",
            "created_at": "2019-10-19T10:27:59.872124+0300",
            "updated_at": "2019-10-19T10:27:59.872124+0300"
        },
        {
            "id": 73504,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-03-01",
            "operate_to": "2020-03-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-03-31",
            "created_at": "2019-10-19T10:27:59.862073+0300",
            "updated_at": "2019-10-19T10:27:59.862073+0300"
        },
        {
            "id": 73503,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-02-01",
            "operate_to": "2020-02-29",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-02-29",
            "created_at": "2019-10-19T10:27:59.852040+0300",
            "updated_at": "2019-10-19T10:27:59.852040+0300"
        },
        {
            "id": 73502,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2020-01-01",
            "operate_to": "2020-01-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2020-01-31",
            "created_at": "2019-10-19T10:27:59.840842+0300",
            "updated_at": "2019-10-19T10:27:59.840842+0300"
        },
        {
            "id": 73501,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2019-12-01",
            "operate_to": "2019-12-31",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2019-12-31",
            "created_at": "2019-10-19T10:27:59.828518+0300",
            "updated_at": "2019-10-19T10:27:59.828518+0300"
        },
        {
            "id": 73500,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2019-11-01",
            "operate_to": "2019-11-30",
            "duration": 1.0,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "1.0",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2019-11-30",
            "created_at": "2019-10-19T10:27:59.815670+0300",
            "updated_at": "2019-10-19T10:27:59.815670+0300"
        },
        {
            "id": 73499,
            "subscription_id": 3005691,
            "subscription_resource_id": 30292,
            "subscription_resource_name": "Chill",
            "plan_resource_id": 4057,
            "resource_id": 1504,
            "quantity": 1.0,
            "operate_from": "2019-10-19",
            "operate_to": "2019-10-31",
            "duration": 0.419,
            "description": "Upgrade resource (recurring fee) \"Chill\" for Subscription #3005691 \"Csp endless\"",
            "unit_price": "1.0",
            "amount": "0.42",
            "status": "new",
            "type": "Charge::Recurring",
            "order_id": 8082,
            "close_date": "2019-10-31",
            "created_at": "2019-10-19T10:27:59.799305+0300",
            "updated_at": "2019-10-19T10:27:59.799305+0300"
        }
    ]
}