Обновление Заказа

Метод Update an Order применяется для обновления Заказа, используя ID данного Заказа.

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

Аргументы

Название	Тип параметров	Тип данных	Обязательный/Опциональный	Описание
id	path	string	Опциональный	ID Заказа
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора).
payment_id	form	integer	Обязательный	ID Платежа

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

Название	Тип данных	Описание
id	integer	ID Заказа
document_id	string	Номер Заказа
status	string	Статус Заказа. Список статусов см. в Просмотр информации о заказе
account_id	integer	ID Аккаунта, с которого произведена оплата
type	string	Тип Заказа. Список типов см. в Управление заказами
created_at	date	Дата и время создания Заказа
updated_at	date	Дата и время последнего изменения Заказа
expiration_date	date	Дата окончания, до которой Заказ должен быть оплачен. Дата окончания рассчитывается исходя из установленного значения "Период отсрочки платежа" в "Правиле предоставления" (см. Создание правила предоставления в ActivePlatform. Панель управления Оператора)
total	float	Общая сумма Заказа
promo_code	string	Промо-код, если данный код применялся при создании Заказа (см. Создание Скидки по Промо-коду в ActivePlatform. Панель управления Оператора)
payment_id	integer	ID платежа, который связан с Заказом
items	array	Перечень позиций в Заказе: id — ID позиции Заказа. target_id — ID сущности (услуги или дополнительного ресурса), которая относится к данной позиции Заказа. target_type — тип сущности, которая относится к данной позиции Заказа: Subscription — подписка. SubscriptionResource — дополнительный ресурс подписки. type — внутренний класс позиции заказа: "ProvisioningItem::Upgrade" — увеличение количества ресурсов подписки. "ProvisioningItem::New" — новая подписка. "ProvisioningItem::RegisterDomain" — регистрация домена. "ProvisioningItem::Renew" — продление подписки. "ProvisioningItem::SwitchPlan" — изменение тарифного плана в рамках подписки. "ProvisioningItem::Downgrade" — уменьшение количества ресурсов подписки. "ProvisioningItem::TransferDomain" — перенос домена. "ProvisioningItem::RegisterCertificate" — регистрация SSL-сертификата. status — текущий статус позиции Заказа: waiting for payment — Заказ был осуществлен, ожидается его оплата. provisioning — Заказ был подтвержден, услуга предоставляется. provisioning failed — Заказ был подтвержден, но услуга не предоставляется. completed — Заказ был успешно обработан. cancelled — Заказ был отменен. description — краткое описание позиции Заказа.
charges	array	Список списаний, сформированных по данному Заказу: id — ID списания. subscription_id — ID подписки. subscription_resource_id — ID ресурса в подписке. subscription_resource_name — имя ресурса в подписке. plan_resource_id — ID ресурса в тарифном плане. resource_id — ID ресурса. quantity — количество заказанных единиц. operate_from — дата начала оплаченного периода. operate_to — дата окончания оплаченного периода. duration — доля оплаченного периода в месяце. description — подробная информация о списании. unit_price — стоимость одной единицы. amount — общая сумма списания. status — текущий статус списания: new — клиент еще не оплатил услугу. opened — услуга заказана, списание не оплачено клиентом, денежные средства на балансе клиента не заблокированы (для CSP подписок). blocked — услуга заказана, списание не оплачено клиентом, денежные средства на балансе клиента были заблокированы. wating for a refund — клиент осуществил операцию, по которой ожидается подтверждение Сотрудником возврата денежных средств. closed — клиент оплатил списание, денежные средства списаны с баланса клиента. deleted — запись была удалена. refunded — клиент осуществил операцию, по которой произошел успешный возврат денежных средств. waiting for approve — клиент осуществил операцию, по которой ожидается подтверждение операции Сотрудником. type — внутренний класс списания: "Charge::Setup" — списание за установку подписки. "Charge::Recurring" — списание за абонентскую плату подписки. "Charge::Renewal" — списание за обновление подписки. "Charge::RecurringResource" — списание за абонентскую плату ресурса подписки. "Charge::SetupResource" — списание за установку ресурсов подписки. "Charge::Transfer" — списание за перенос домена. order_id — ID заказа, по которому произведено списание. close_date — дата, когда списание должно быть закрыто. created_at — дата и время создания записи. updated_at — дата и время последнего изменения записи.

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

PUT http://billing.activeplatform.com:80/api/vendor/v1/orders/2010543.json?api_token=654321

{
 "payment_id": 2007029
}

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

 {
  "id": 2010543,
  "document_id": "SO005309",
  "status": "waiting_for_payment",
  "account_id": 2000532,
  "type": "SalesOrder",
  "created_at": "2016-10-04T09:48:36.979+03:00",
  "updated_at": "2016-10-04T10:04:25.066+03:00",
  "expiration_date": "2016-10-04",
  "total": 0.14,
  "promo_code": null,
  "payment_id": 2007029,
  "items": [
    {
      "id": 16850,
      "target_id": 2006205,
      "target_type": "Subscription",
      "type": "ProvisioningItem::New",
      "status": "waiting_for_payment",
      "description": "MSExPlan"
    }
  ],
  "charges": [
    {
      "id": 754717,
      "subscription_id": 2006205,
      "subscription_resource_id": null,
      "subscription_resource_name": null,
      "plan_resource_id": null,
      "resource_id": null,
      "quantity": 1,
      "operate_from": "2016-12-01",
      "operate_to": "2017-01-01",
      "duration": 1,
      "description": "Purchasing Plan (recurring fee) #2006205 \"MSExPlan\"",
      "unit_price": 0.03,
      "amount": 0.03,
      "status": "new",
      "type": "Charge::Recurring",
      "order_id": 2010543,
      "close_date": "2017-01-01",
      "created_at": "2016-10-04T09:48:37.394427+0300",
      "updated_at": "2016-10-04T09:48:37.394427+0300"
    },
    {
      "id": 754716,
      "subscription_id": 2006205,
      "subscription_resource_id": null,
      "subscription_resource_name": null,
      "plan_resource_id": null,
      "resource_id": null,
      "quantity": 1,
      "operate_from": "2016-11-01",
      "operate_to": "2016-12-01",
      "duration": 1,
      "description": "Purchasing Plan (recurring fee) #2006205 \"MSExPlan\"",
      "unit_price": 0.03,
      "amount": 0.03,
      "status": "new",
      "type": "Charge::Recurring",
      "order_id": 2010543,
      "close_date": "2016-12-01",
      "created_at": "2016-10-04T09:48:37.362625+0300",
      "updated_at": "2016-10-04T09:48:37.362625+0300"
    },
    {
      "id": 754715,
      "subscription_id": 2006205,
      "subscription_resource_id": null,
      "subscription_resource_name": null,
      "plan_resource_id": null,
      "resource_id": null,
      "quantity": 1,
      "operate_from": "2016-10-04",
      "operate_to": "2016-11-01",
      "duration": 0.903,
      "description": "Purchasing Plan (recurring fee) #2006205 \"MSExPlan\"",
      "unit_price": 0.03,
      "amount": 0.03,
      "status": "new",
      "type": "Charge::Recurring",
      "order_id": 2010543,
      "close_date": "2016-11-01",
      "created_at": "2016-10-04T09:48:37.331884+0300",
      "updated_at": "2016-10-04T09:48:37.331884+0300"
    },
    {
      "id": 754714,
      "subscription_id": 2006205,
      "subscription_resource_id": null,
      "subscription_resource_name": null,
      "plan_resource_id": null,
      "resource_id": null,
      "quantity": 1,
      "operate_from": "2016-10-04",
      "operate_to": "2017-01-04",
      "duration": 1,
      "description": "Purchasing Plan (setup fee) #2006205 \"MSExPlan\"",
      "unit_price": 0.05,
      "amount": 0.05,
      "status": "new",
      "type": "Charge::Setup",
      "order_id": 2010543,
      "close_date": "2016-11-01",
      "created_at": "2016-10-04T09:48:37.227973+0300",
      "updated_at": "2016-10-04T09:48:37.227973+0300"
    }
  ]
}