Breadcrumbs

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

Метод используется для получения многостраничного списка заказов, включая заказы в статусе Отменен, для аккаунта, к которому есть доступ у текущего пользователя. 

GET {reseller_domain}/internal_api/accounts/{account_id}/orders

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название

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

Тип данных

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

Описание

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

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

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

account_id

path

integer

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

ID аккаунта, для которого запрашивается список заказов

page[size]

query

integer

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

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

integer

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

Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)

filter[document_id][like]

query

string

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

Предназначен для фильтрации списка по части номера заказа

filter[status]

query

string

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

Предназначен для фильтрации списка по статусу заказа. Можно указать несколько значений через запятую. Доступные значения:

  • waiting_for_payment — Ожидает оплаты — заказ создан, связанный платеж ожидает оплаты.

  • waiting_for_provisioning — Ожидает предоставления — отложенный заказ подтвержден, начало предоставления услуги запланировано на дату предоставления.

  • provisioning — Предоставляется — заказ подтвержден, услуга в процессе активации.

  • provisioning_failed — Ошибка активации — заказ подтвержден, но услуга не была активирована.

  • completed — Завершен — заказ обработан.

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

filter[created_at]

query

string

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

Предназначен для фильтрации списка по дате создания заказа в формате ГГГГ-ММ-ДД. Для указания диапазона используются следующие фильтры:

  • filter[created_at][gt] — дата больше, чем указанная.

  • filter[created_at][lt] — дата меньше, чем указанная.

  • filter[created_at][gteq] — дата больше, чем указанная, или равна.

  • filter[created_at][lteq] — дата меньше, чем указанная, или равна.

filter[subscription_id]

query

integer

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

Предназначен для фильтрации списка по ID связанной подписки

sort

query

string

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

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

  • sort=created_at — сортировка по возрастанию значений created_at.

  • sort=-created_at — сортировка по убыванию значений created_at.

include

query

string

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

Предназначен для включения в ответ дополнительной информации о связанных объектах:

Объект

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

Списания

charges

Списания и рассчитанные для них налоги

charges.taxes

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

Название

Тип данных

Описание

data

array of objects

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


id

string

ID заказа


type

string

Тип данных


attributes

object

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



created_at

string

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



document_id

string

Номер заказа



type

string

Тип заказа:

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

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

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

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

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



subtype

string

Подтип заказа:

  • immediate_switch — немедленное переключение. Только для заказа на переключение тарифного плана.

  • delayed_switch — отложенное переключение. Только для заказа на переключение тарифного плана.

  • null — для всех остальных типов заказа.



total

number

Сумма заказа в валюте реселлера



status

string

Статус заказа:

  • waiting_for_payment — Ожидает оплаты — заказ создан, связанный платеж ожидает оплаты.

  • waiting_for_provisioning — Ожидает предоставления — отложенный заказ подтвержден, начало предоставления услуги запланировано на дату предоставления.

  • provisioning — Предоставляется — заказ подтвержден, услуга в процессе активации.

  • provisioning_failed — Ошибка активации — заказ подтвержден, но услуга не была активирована.

  • completed — Завершен — заказ обработан.

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



provisioning_date

string

Дата предоставления заказа



created_by

object

Информация о том, кто создал заказ




requester_type

string

Информация о том, кто создал заказ:

  • manager — менеджер.

  • user — пользователь аккаунта.

  • system — платформа (автоматически).




requester_name

string

Имя менеджера или пользователя аккаунта, создавшего заказ



payment

object

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




id

integer

ID платежа




document_id

string

Номер платежа



subscription


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




id

integer

ID подписки




name

string

Название подписки




billing_type

string

Тип биллинга тарифного плана, на который заказана подписка (см.

)




payment_model

string

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

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

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



detail_items

array of objects

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




description

string

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




quantity_float

string

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




duration_float

string

Оплачиваемый период в месяцах




unit_price

string

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




discount_amount

string

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




amount

string

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




unit_price_in_plan_currency

string

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



available_operations

object

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




cancel

bool

Отмена (см. Отмена заказа):

  • true — действие доступно.

  • false — действие недоступно.




recreate

bool

Изменение (см. Изменение заказа):

  • true — действие доступно.

  • false — действие недоступно.



taxes_total

object

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




total

string

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




taxes

array of objects

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





name

string

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





rate

number

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





amount

number

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





origin_id

integer

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





amount_with_currency

string

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



po_number

string

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

Обновление информации о PO в заказе

)



po_document

object

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




name

string

Имя файла




url

string

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




size

integer

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


relationships

object

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



charges

object

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




data

array of objects

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

Название

Тип данных

Описание

id

string

ID объекта

type

string

Тип данных

included

array of objects

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

Название

Тип данных

Описание

id

string

ID объекта

type

string

Тип данных

attributes

object

Атрибуты (см. ниже)

  • Для списания — см. модель ответа метода Получение списка заблокированных списаний без включения дополнительной информации о связанных объектах.

  • Для налогов — о каждом налоге, использованном при создании списания (см. ):

    Название

    Тип данных

    Описание

    id

    string

    ID налога

    type

    string

    Тип данных

    attributes

    object

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


    created_at

    string

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


    updated_at

    string

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


    charge_id

    integer

    ID списания, для которого рассчитан налог


    origin_id

    integer

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


    name

    string

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


    code

    string

    Код налога


    rate

    number

    Размер налога в процентах


    amount

    number

    Сумма налога в валюте реселлера, рассчитанная для net_amount списания

links

object

Ссылки для постраничной навигации


self

string

Текущая страница


first

string

Первая страница


prev

string

Предыдущая страница (при наличии)


next

string

Следующая страница (при наличии)


last

string

Последняя страница

meta

object

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


current_page

integer

Номер текущей страницы


page_count

integer

Общее число страниц


server_current_time

string

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

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

Bash
curl --location --request GET 'https://test.activeplatform.com/internal_api/accounts/95/orders?include=charges.taxes' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON
{
    "data": [
        {
            "id": "3605",
            "type": "sales_orders",
            "attributes": {
                "created_at": "2023-02-28T07:25:07.556436+0000",
                "document_id": "SO001595",
                "type": "SalesOrder",
                "subtype": null,
                "total": 6.66,
                "status": "waiting_for_payment",
                "provisioning_date": "2023-03-01",
                "created_by": {
                    "requester_type": "user",
                    "requester_name": "Fae Donnelly"
                },
                "payment": {
                    "id": 2484,
                    "document_id": "002379"
                },
                "subscription": {
                    "id": 1737,
                    "name": "Office",
                    "billing_type": "csp_monthly",
                    "payment_model": "prepay"
                },
                "detail_items": [
                    {
                        "description": "\"Licenses\" for subscription #1737 \"Office\" from 01.03.2023 to 31.03.2023 (recurring fee)",
                        "quantity_float": "1.0",
                        "duration_float": "1.0",
                        "unit_price": "11.00 €",
                        "discount_amount": "5.50 €",
                        "amount": "6.66 €",
                        "unit_price_in_plan_currency": null
                    }
                ],
                "available_operations": {
                    "cancel": true,
                    "recreate": false
                },
                "taxes_total": {
                    "total": "1.16 €",
                    "taxes": [
                        {
                            "name": "Tax1",
                            "rate": 2.0,
                            "amount": 0.11,
                            "origin_id": 18,
                            "amount_with_currency": "0.11 €"
                        },
                        {
                            "name": "Tax2",
                            "rate": 11.0,
                            "amount": 0.61,
                            "origin_id": 20,
                            "amount_with_currency": "0.61 €"
                        },
                        {
                            "name": "Tax3",
                            "rate": 8.0,
                            "amount": 0.44,
                            "origin_id": 38,
                            "amount_with_currency": "0.44 €"
                        }
                    ]
                },
                "po_number": "123456",
                "po_document": {
                    "name": "PO_signed.pdf",
                    "url": "https://storage.test.activeplatform.com/private/uploads/sales_order/po_document/3605/PO_signed.pdf?expires=1699722165\u0026hash=iuM",
                    "size": 294186
                }
            },
            "relationships": {
                "charges": {
                    "data": [
                        {
                            "id": "7312",
                            "type": "charge_recurrings"
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": "7312",
            "type": "charge_recurrings",
            "attributes": {
                "created_at": "2023-02-28T07:25:07.818629+0000",
                "type": "Charge::Recurring",
                "description": "Upgrade resource (recurring fee) \"Licenses\" for Subscription #1737 \"Office\" from 01.03.2023 to 31.03.2023",
                "quantity_float": "1.0",
                "duration_float": "1.0",
                "operate_from": "2023-03-01",
                "operate_to": "2023-04-01",
                "unit_price": "11.00 €",
                "discount_amount": "5.50 €",
                "amount": "6.66 €",
                "total": 6.66,
                "tax_is_calculated_using": "net_prices",
                "net_amount": 5.5,
                "taxes_amount": "1.16 €",
                "reseller_currency_iso_code": "EUR",
                "item_target_data": {
                    "target_id": 2096,
                    "target_type": "SubscriptionResource",
                    "type": "ProvisioningItem::Upgrade",
                    "description": "Licenses"
                },
                "subscription": {
                    "id": 1737,
                    "name": "Office",
                    "billing_type": "csp_monthly",
                    "payment_model": "prepay"
                },
                "original_amount": 6.66,
                "unit_price_currency": "EUR"
            },
            "relationships": {
                "taxes": {
                    "data": [
                        {
                            "id": "8921",
                            "type": "taxes"
                        },
                        {
                            "id": "8920",
                            "type": "taxes"
                        },
                        {
                            "id": "8919",
                            "type": "taxes"
                        }
                    ]
                }
            }
        },
        {
            "id": "8921",
            "type": "taxes",
            "attributes": {
                "charge_id": 7312,
                "origin_id": 18,
                "name": "Tax1",
                "code": "taxCode1",
                "rate": 2.0,
                "amount": 0.11,
                "created_at": "2023-02-28T07:25:07.826058+0000",
                "updated_at": "2023-02-28T07:25:07.826058+0000"
            }
        },
        {
            "id": "8920",
            "type": "taxes",
            "attributes": {
                "charge_id": 7312,
                "origin_id": 38,
                "name": "Tax3",
                "code": "taxCode3",
                "rate": 8.0,
                "amount": 0.44,
                "created_at": "2023-02-28T07:25:07.825011+0000",
                "updated_at": "2023-02-28T07:25:07.825011+0000"
            }
        },
        {
            "id": "8919",
            "type": "taxes",
            "attributes": {
                "charge_id": 7312,
                "origin_id": 20,
                "name": "Tax2",
                "code": "taxCode2",
                "rate": 11.0,
                "amount": 0.61,
                "created_at": "2023-02-28T07:25:07.823175+0000",
                "updated_at": "2023-02-28T07:25:07.823175+0000"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/accounts/95/orders?include=charges.taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/accounts/95/orders?include=charges.taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/accounts/95/orders?include=charges.taxes&page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}