Skip to main content
Une vente est une commande de votre boutique, avec ses articles, ses paiements et son client.
Permissions : sales.read pour lire, sales.write pour livrer ou annuler. Référence : Ventes.

Lister

Sans filtre status, seules les ventes encaissées sont listées : c’est ce que la plupart des intégrations veulent. Avec status, vous obtenez toutes les commandes de ce statut, payées ou non.

L’objet vente

payment_status résume les paiements : completed, refunded, processing, failed ou pending. C’est lui qu’il faut regarder pour savoir si l’argent est encaissé.

Livrer une vente

POST /sales/{id}/fulfill marque la commande livrée et déclenche la livraison numérique habituelle (accès au téléchargement, e-mail). Elle n’est possible que pour une commande encaissée et non encore livrée (409 invalid_state sinon). Une clé ne peut donc jamais livrer un produit non payé.

Annuler une commande

POST /sales/{id}/cancel annule une commande impayée. Si un paiement est déjà encaissé, l’API refuse (409) : un remboursement est un mouvement d’argent et reste dans le tableau de bord.

Suivre les ventes en continu

Plutôt que d’interroger l’API toutes les minutes, utilisez les Pulses : sale.completed, sale.failed, sale.abandoned et sale.refunded.