createRefundRequest
Créer une demande de remboursement pour une commande. 🔐 Cette méthode nécessite une autorisation.
Description
Crée une demande de remboursement pour la commande avec l'id indiqué. Renvoie true en cas de succès.
Dans body.products, indiquez les produits à rembourser sous forme d'objet associant un id de produit à { quantity } ; note est facultatif.
La commande doit appartenir à l'utilisateur et être entièrement payée, et elle ne peut avoir qu'une seule demande de remboursement en attente à la fois. Pour modifier une demande en attente, annulez-la avec cancelRefundRequest() et créez-en une nouvelle.
.createRefundRequest(
,
);
Schéma des paramètres
Schema
id(required): number
ID de la commande.
exemple : 1
body(required): ICreateRefundRequest
Données de la demande de remboursement.
body.products(required): Record<string, IRefundProduct>
Détails du remboursement indexés par ID de produit.
exemple :
{ "146": { "quantity": 1 } }
body.note: string
Note jointe à la demande de remboursement. Requise par l'API (le SDK la type comme facultative pour rester rétrocompatible — passez-la pour éviter un 400).
exemple : "test"
Exemples
Exemple minimal
const response = await Orders.createRefundRequest(476, {
products: { '2957': { quantity: 1 } },
note: 'Damaged on delivery',
});
Exemple de réponse
true