Dice a che punto è un ordine e cosa è stato eseguito.
- Metodo:
GET
- Indirizzo:
https://console.icbs.it/api/v1/orders/{id}
- Permesso: Domini — lettura
Parametri
| Parametro | Posizione | Obbligatorio | Descrizione |
|---|
id | indirizzo | sì | Il numero dell'ordine, come orderId nella risposta che l'ha creato. |
Esempio di richiesta
curl -H "Authorization: Bearer $ICBS_API_KEY" \
"https://console.icbs.it/api/v1/orders/4812"
Esempio di risposta
{
"orderId": 4812,
"status": "completed",
"amount": 19.9,
"currency": "EUR",
"paymentMethod": "stripe",
"domain": "esempio.it",
"lines": [{ "name": "esempio.it", "period": 1, "price": 19.9, "renewed": true }],
"createdAt": "2026-08-07T09:14:00.000Z"
}
Gli stati
| Stato | Significato |
|---|
pending_payment | In attesa del pagamento. Non è stato eseguito nulla. |
paid | Pagamento ricevuto, esecuzione in corso. |
completed | Eseguito per intero. |
partial | Eseguito solo per una parte dei domini dell'ordine. |
failed | Pagamento ricevuto ma esecuzione non riuscita: ti ricontattiamo. |
cancelled | Ordine annullato, nessun addebito. |
Con più domini nello stesso ordine, il campo renewed di ogni riga dice quali sono andati a buon fine.
Quando interrogarlo
Dopo aver mandato il cliente al pagamento, basta ricontrollare ogni pochi minuti: il passaggio a completed non è immediato, ma non richiede nessun intervento da parte tua.
Possibili errori
| Codice | Causa |
|---|
400 | Numero d'ordine non valido. |
401 | Chiave assente, non valida, scaduta o revocata. |