Commandes
Créez une commande, évitez les doublons et suivez sa livraison.
Créer une commande
POST /orders
orders:writeAction facturée
curl -X POST 'https://esimy.siraj-ai.com/api/v1/orders' \
-H "Authorization: Bearer $ESIMY_API_KEY" \
-H 'Idempotency-Key: voyage-001-esim-01' \
-H 'Content-Type: application/json' \
-d '{"quoteId":"aq_EXEMPLE","reference":"VOYAGE-001"}'| Champ / en-tête | Règle |
|---|---|
Idempotency-Key | Obligatoire, 8 à 128 caractères : lettres, chiffres, point, tiret, deux-points et underscore. |
quoteId | Identifiant d’un devis valide appartenant à votre agence. |
reference | Facultatif ; votre référence de réservation, 120 caractères maximum. |
{
"id": "ao_EXEMPLE",
"agencyId": "ag_EXEMPLE",
"quoteId": "aq_EXEMPLE",
"reference": "VOYAGE-001",
"packageCode": "CODE_CATALOGUE",
"name": "France 1 GB · 7 jours",
"days": 1,
"daily": false,
"feeUnits": 10000,
"amountUnits": 110000,
"currency": "USD",
"status": "queued",
"lastError": "",
"createdAt": "2026-11-17T12:00:00Z",
"updatedAt": "2026-11-17T12:00:00Z"
}Une réponse 202 indique que la commande et son débit sont enregistrés. L’eSIM est préparée de manière asynchrone.
Éviter les doubles commandes
Créez une clé d’idempotence par achat et conservez-la dans votre base. En cas de délai d’attente ou de coupure réseau, renvoyez le même quoteId, la même reference et la même clé. Une commande déjà enregistrée est retournée sans nouveau débit, même si son devis a expiré depuis.
Une reprise trouve généralement une réponse 200 ; des requêtes simultanées peuvent aussi retourner 202 avec le même identifiant de commande. Une même clé accompagnée d’un contenu différent retourne 409 idempotency_conflict.
Lister les commandes
GET /orders?page=1
orders:readcurl 'https://esimy.siraj-ai.com/api/v1/orders?page=1' \
-H "Authorization: Bearer $ESIMY_API_KEY"{
"items": [
{
"id": "ao_EXEMPLE",
"agencyId": "ag_EXEMPLE",
"quoteId": "aq_EXEMPLE",
"reference": "VOYAGE-001",
"packageCode": "CODE_CATALOGUE",
"name": "France 1 GB · 7 jours",
"days": 1,
"daily": false,
"feeUnits": 10000,
"amountUnits": 110000,
"currency": "USD",
"status": "queued",
"lastError": "",
"createdAt": "2026-11-17T12:00:00Z",
"updatedAt": "2026-11-17T12:00:00Z"
}
],
"total": 1,
"page": 1,
"limit": 50
}Les commandes sont classées de la plus récente à la plus ancienne, par pages de 50. Seules les commandes de votre agence sont accessibles.
Suivre une commande
GET /orders/{id}
orders:readcurl 'https://esimy.siraj-ai.com/api/v1/orders/ao_EXEMPLE' \
-H "Authorization: Bearer $ESIMY_API_KEY"La réponse est l’objet commande. Interrogez cet endpoint toutes les 10 secondes pendant la préparation.
| État | Signification |
|---|---|
queued | Commande en attente de préparation ou de reprise. |
processing | Préparation auprès du fournisseur en cours. |
ready | eSIM disponible ; récupérez les informations d’installation. |
needs_review | Vérification requise par l’équipe eSIMY. |
depleted | Volume épuisé lorsque cet état est remonté. |
expired | eSIM expirée lorsque cet état est remonté. |
cancelled_provider | Annulation signalée par le fournisseur. |
En cas de vérification, la référence et le débit restent conservés. Aucun remboursement automatique n’est annoncé tant que l’émission fournisseur n’est pas clarifiée.