Aller au contenu principal

Créer un modèle de coupon

POST

https://api-v2.test.eldowallet.fr/coupons

Crée un modèle de coupon dans votre wallet et le modèle de pass associé. La requête est envoyée en multipart/form-data avec l'image du bandeau (strip). Le modèle créé est renvoyé ; utilisez ensuite POST /coupons/{id}/passes/send pour envoyer des coupons à vos clients.

À retenir
  • Corps en multipart/form-data : les objets imbriqués (colors, security, locations…) s'envoient en chaîne JSON, les booléens en "true"/"false". Images : PNG ou JPEG, 1 Ko à 5 Mo.

Requête​

header parameters
  • x-lang string
    Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary> required
  • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string required
  • description string required
  • promoCode string
  • value string
  • expirationDate string <date-time>
  • isMultipleInstance boolean
  • isWelcomeCoupon boolean
  • status stringenum: ACTIVE, INACTIVE, EXPIRED
  • source stringenum: INTERNAL, EXTERNAL, CRM, ALL
  • valueLabel stringenum: VALUE, AMOUNT, PRESTATION
  • colors object required
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • security object
    • oneTimeToUseJwtLink boolean
    • disableIOSPassSharing boolean
    • enableOneTimeUse boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string

Réponses​

Schéma application/json
  • wallet oneOf required
    • Wallet
      • name string required
      • logo string required
      • icon string required
      • androidLogo string
      • displayIdentifiant boolean required
      • passBuilderPassTemplateId string
      • passBuilderBusinessId string
      • passBuilderToken string
      • identifier string required
      • identifierQr string required
      • address string
      • website string required
      • servicePhone string required
      • businessPhone string required
      • socialMedia object required
        • linkedin string
        • facebook string
        • instagram string
        • tiktok string
        • twitter string
        • youtube string
        • snapchat string
        • pinterest string
        • reddit string
        • whatsapp string
        • telegram string
      • additionalContacts object[] required
        • title string required
        • value string required
        • kind string requiredenum: URL, PHONE, EMAIL
      • termsAndConditions object required
        • type string requiredenum: PDF, URL, NONE
        • customUrl string
        • pdfUrl string
      • webHookUrl string required
      • rootDomain string required
      • timezone string
      • allowedPasses string[] requiredenum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
      • expiredCleanupEnabled boolean required
      • _id string required
      • createdAt string <date-time> required
      • updatedAt string <date-time> required
    • option 2
  • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string required
  • description string required
  • promoCode string
  • value string
  • expirationDate string <date-time>
  • isMultipleInstance boolean required
  • isWelcomeCoupon boolean required
  • status string requiredenum: ACTIVE, INACTIVE, EXPIRED
  • source string requiredenum: INTERNAL, EXTERNAL, CRM, ALL
  • colors object required
    • labelColor string required
    • backgroundColor string required
    • foregroundColor string required
  • strip string
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • security object
    • oneTimeToUseJwtLink boolean required
    • disableIOSPassSharing boolean
    • enableOneTimeUse boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • valueLabel string requiredenum: VALUE, AMOUNT, PRESTATION
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
  • passBuilderPassTemplateId string
  • _id string required
  • createdAt string <date-time> required
  • updatedAt string <date-time> required

Les nouveautés de l'API, une fois par mois

Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

Signaler un problème technique

Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

Pour une réponse rapide, indiquez :

  • La méthode et l’endpoint (ex. POST /clients)
  • Le code d’erreur renvoyé (errorCode) et le corps envoyé
  • La date et l’heure de l’appel
  • Les identifiants concernés (client, modèle, pass)

N’y mettez jamais de jeton d’API ni de mot de passe.

Assistant IA

Beta

Chargement…

Réponses générées par IA (Claude) : vérifiez les points importants.

Connectez-vous pour utiliser l'assistant