Pedidos
Alcance: orders:read.
GET /api/v1/orders
Sección titulada «GET /api/v1/orders»Parámetros: offset, limit, family, status, client_reference (coincidencia exacta).
Un valor desconocido de family o status se interpreta como «sin filtro». El orden es fijo y no
se puede configurar: los más nuevos primero.
| Campo | Significado |
|---|---|
product, kind, family | qué se compró; kind: resident o ipv4 |
quantity | número de unidades compradas: direcciones en ipv4; en un pedido de tráfico siempre 1: se compró un paquete, y el volumen está en packages[].traffic.purchased_gb |
price_per_proxy, total | precio por unidad (total / quantity) e importe del pedido; en un pedido de tráfico son iguales |
status | ver abajo |
applied_to_package_id | si no está vacío, el pedido se aplicó a un paquete existente: recarga de tráfico o prolongación de direcciones |
client_reference | su etiqueta del cuerpo de la compra |
packages | el paquete de tráfico que entregó el pedido. Vacío en las recargas de volumen y en los pedidos de direcciones fijas: lea sus paquetes con GET /api/v1/packages?family=dedicated, la ficha incluye order_id |
GET /api/v1/orders/{id}
Sección titulada «GET /api/v1/orders/{id}»La forma es la misma que en la lista. Un pedido de otra cuenta responde 404 sin la clave code.
Estados de entrega
Sección titulada «Estados de entrega»La compra se completa dentro de la solicitud, por eso en la respuesta de POST /api/v1/packages el pedido ya está
completed. Los demás estados aparecen al leer los pedidos.
| Estado | Qué hacer |
|---|---|
pending, provisioning | consultar cada 5-10 segundos |
completed | listo: el paquete de tráfico está en packages[0], el paquete de direcciones en package_id de la respuesta de compra |
failed | el dinero no se cobró o se devolvió, se puede repetir |
refunded | el dinero se devolvió por decisión de soporte; repetir como una compra nueva |
needs_attention | el dinero se cobró, se revisa manualmente. No volver a comprar, contactar con soporte |
En lugar de consultar los pedidos, puede leer el registro de eventos.