Заказы
Право: orders:read.
GET /api/v1/orders
Заголовок раздела «GET /api/v1/orders»Параметры: offset, limit, family, status, client_reference (точное совпадение).
Неизвестное значение family или status читается как «без фильтра». Порядок фиксирован и не
настраивается: новые сверху.
| Поле | Значение |
|---|---|
product, kind, family | что куплено; kind: resident или ipv4 |
quantity | число купленных единиц: адресов у ipv4; у заказа на трафик всегда 1 - куплен один пакет, а объём лежит в packages[].traffic.purchased_gb |
price_per_proxy, total | цена единицы (total / quantity) и стоимость заказа; у заказа на трафик равны |
status | см. ниже |
applied_to_package_id | непусто - заказ применён к существующему пакету: долив трафика или продление адресов |
client_reference | ваша метка из тела покупки |
packages | пакет трафика, который выдал заказ. Пусто у долива и у заказов фиксированных адресов - их пакеты читайте через GET /api/v1/packages?family=dedicated, в карточке есть order_id |
GET /api/v1/orders/{id}
Заголовок раздела «GET /api/v1/orders/{id}»Форма та же, что в списке. Заказ другого аккаунта отвечает 404 без ключа code.
Статусы выдачи
Заголовок раздела «Статусы выдачи»Покупка завершается внутри запроса, поэтому в ответе POST /api/v1/packages заказ уже
completed. Остальные статусы встречаются при чтении заказов.
| Статус | Что делать |
|---|---|
pending, provisioning | опрашивать раз в 5-10 секунд |
completed | готово: пакет трафика в packages[0], пакет адресов - в package_id ответа покупки |
failed | деньги не списаны либо возвращены, можно повторить |
refunded | деньги возвращены решением поддержки; повторять как новую покупку |
needs_attention | деньги списаны, разбирается вручную. Не покупать повторно, обратиться в поддержку |
Вместо опроса заказов можно читать журнал событий.