Получение информации о корзине покупок

Content-Type

header

string

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

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

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

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

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

Двухбуквенный код языка данных в ответе и созданной асинхронной задачи

Authorization 

header

string

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

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

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

Доменное имя реселлера

shopping_cart_id

path

integer

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

ID корзины покупок, созданной в результате вызова метода 

order_type

query

string

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

Тип заказа. Доступные значения:

• SalesOrder — заказ на покупку.

• SwitchPlanOrder — заказ на переключение тарифного плана.

• RenewalOrder — заказ на продление.

• ProlongOrder — заказ на пролонгацию.

• ChangeOrder — заказ на изменение количества ресурсов.

data

object

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

id

string

ID корзины покупок

type

string

Тип данных

attributes

object

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

created_at

string

Дата и время создания корзины покупок

provisioning_date

string

Дата предоставления заказа (ГГГГ-ММ-ДД)

total

number

Стоимость заказа

total_with_currency

string

Стоимость заказа с указанием валюты

has_discount

bool

Признак наличия скидки:

• true — к заказу применяется скидка.

• false — к заказу не применяется скидка.

total_discount

number

Сумма скидки

total_discount_with_currency

string

Сумма скидки с указанием валюты

promo_code

string

Промокод, указанный при оформлении заказа

trial

bool

Признак пробной подписки:

• true — подписка на пробный период.

• false — коммерческая подписка.

billing_day

integer

Финансовый день по подписке

next_billing_date

string

Следующий финансовый день по подписке (ГГГГ-ММ-ДД)

items

array of objects

Список позиций в заказе

name

string

Описание позиции

quantity

integer

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

discount_amount

string

Сумма скидки с указанием валюты

amount

string

Стоимость позиции с указанием валюты

top_up

bool

Признак пополнения баланса:

• true — позиция в заказе — платеж на пополнение баланса.

• false — позиция в заказе — услуга или ресурс.

duration

string

Период, на который заказывается позиция (в месяцах)

unit_price

string

Цена за единицу заказанной единицы услуги или ресурса с указанием валюты

taxes_total

object

Итоговые данные налогов (см.

)

total

string

Сумма все налогов по всем списаниям с указанием валюты реселлера

taxes

array of objects

Итоговые данные каждого налога

origin_id

string

ID налога в налоговом модуле

name

string

Название налога

rate

number

Ставка налога в процентах

amount

string

Сумма налога по всем списаниям с указанием валюты реселлера

tax_is_calculated_using

string

Настройка Налоги рассчитываются (см. ):

• net_prices — Сверх цены плана — все цены в тарифных планах указаны без налогов.

• gross_prices — Внутри цены плана — все цены в тарифных планах включают в себя налоги.

payment_model

string

Модель оплаты подписки в заказе:

• prepay — Предоплата.

• postpay — Постоплата.

work_permit_for_postpaid

string

Наличие у аккаунта разрешения на заказ подписок по модели Постоплата (см. ):

• approved — менеджер разрешил аккаунту заказывать подписки на коммерческий период по модели Постоплата.

• approval required — аккаунт попытался заказать первую подписку на коммерческий период по модели Постоплата в период, когда для этого требовалось ручное подтверждение менеджера. Аккаунт находится на рассмотрении у менеджера.

• declined — менеджер запретил аккаунту заказывать подписки на коммерческий период по модели Постоплата.

• verification not performed — аккаунт не заказывал подписки на коммерческий период по модели Постоплата в период, когда для этого требовалось ручное подтверждение менеджера.

allow_order_postpaid_subscription

string

Значение настройки реселлера Разрешать работу клиента по постоплате (см. ):

• automatically — Автоматически — все существующие и новые клиенты могут заказывать подписки по модели Постоплата без ручного подтверждения менеджером.

• manually — Вручную — для заказа подписок по модели Постоплата менеджер должен предоставить клиенту разрешение.

po_number

string

Номер заказа в системе закупок клиента (Purchase Order, PO) (см. Обновление информации о PO в корзине покупок)

po_document

object

Информация о файле заказа из системе закупок клиента

name

string

Имя файла

url

string

Ссылка на файл

size

integer

Размер файла в байтах

next_month_amount_with_currency

string

Стоимость подписки на следующий месяц с указанием валюты

plan_data

object

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

id

integer

ID тарифного плана

name

string

Название тарифного плана

sku

string

SKU тарифного плана

meta

object

Дополнительная информация

server_current_time

string

Текущие дата и время сервера