Замовлення
Право: orders:read.
GET /api/v1/orders
Section titled “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}
Section titled “GET /api/v1/orders/{id}”Форма та сама, що в списку. Замовлення іншого акаунта відповідає 404 без ключа code.
Статуси видачі
Section titled “Статуси видачі”Купівля завершується всередині запиту, тому у відповіді POST /api/v1/packages замовлення вже
completed. Інші статуси трапляються під час читання замовлень.
| Статус | Що робити |
|---|---|
pending, provisioning | опитувати раз на 5-10 секунд |
completed | готово: пакет трафіку в packages[0], пакет адрес - у package_id відповіді купівлі |
failed | гроші не списано або повернуто, можна повторити |
refunded | гроші повернуто рішенням підтримки; повторювати як нову купівлю |
needs_attention | гроші списано, розбирається вручну. Не купувати повторно, звернутися в підтримку |
Замість опитування замовлень можна читати журнал подій.