Supprimer des coupons en masse
DELETE
https://api-v2.test.eldowallet.fr/coupons/:id/passes/bulk
La réponse est une opération en masse : suivez son statut et ses résultats avec GET /bulk-operations/{operationId}.
À retenir
- Chaque
instanceIdest supprimé comme avecDELETE /coupons/{id}/passes/{instanceId}: sur un modèle multi-instance, la première suppression efface tout le modèle et ses coupons, et les éléments suivants échouent. S'exécute en arrière-plan par défaut ; avecforceSync: true(moins de 1000 éléments, sinonSYNC_EXECUTION_NOT_ALLOWED), la réponse contient déjà les résultats.
Requête
path parameters
idstring requiredIdentifiant du modèle de coupon dont les coupons sont supprimés.
header parameters
x-langstringLangue des messages d'erreur et des textes renvoyés : `fr` ou `en`.enum:en,frdefault:"en"
Body
application/json requiredwebhookUrlstringURL de webhook facultative, appelée à la fin de l'opération. En-têtes d'authentification : ajoutez `#headers=Authorization:Bearer%20token` à l'URL.example:https://example.com/webhook#headers=Authorization:Bearer%20tokenforceSyncbooleanExécute l'opération de manière synchrone (moins de 1 000 éléments). Si la valeur est `true` et que la requête contient 1 000 éléments ou plus, elle est rejetée.default:falseinstanceIdsstring[] requiredListe des identifiants d'instance des coupons à supprimer.
Réponses
- 200
- 400
- 401
- 403
- 404
- 500
Schéma
application/jsonoperationIdstring requiredIdentifiant unique de l'opération en masse.example:507f1f77bcf86cd799439011totalItemsnumber requiredNombre total d'éléments de l'opération.example:100successCountnumber requiredNombre d'éléments traités avec succès.example:95failureCountnumber requiredNombre d'éléments en échec.example:5statusstring requiredCurrent status of the operationenum:pending,processing,completed,failedexample:pendingoperationErrorsobject[]Liste des erreurs des éléments en échec.itemIdstring requiredIdentifiant de l'élément en échec.example:507f1f77bcf86cd799439011messagestring requiredMessage d'erreur.example:Client not foundcodestringCode d'erreur, s'il est disponible.example:404:MODEL_NOT_FOUND
resultsobject[]Liste des résultats des éléments traités avec succès.itemIdstring requiredIdentifiant de l'élément.example:507f1f77bcf86cd799439011resultobjectDonnées du résultat.
createdAtstring <date-time> requiredDate et heure de création de l'opération.example:2024-01-01T00:00:00.000ZcompletedAtstring <date-time>Date et heure de fin de l'opération.example:2024-01-01T00:05:00.000Z
VALIDATION_ERROR · INVALID_JSON
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNAUTHORIZED
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
FORBIDDEN
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
COUPON_TEMPLATE_NOT_FOUND · MODEL_NOT_FOUND
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNKNOWN_ERROR
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email