Obtenir le détail de la carte de fidélité

GET

https://api-v2.test.eldowallet.fr/store-cards/details

Renvoie un résumé de la carte de fidélité utile pour construire un formulaire client : type de carte (cardType), types de clients disponibles (clientTypes), date d'expiration calculée d'après la validité de la carte (expirationDate), contenu des lignes de la carte (startRow, middleRow, endRow) et canal de communication du wallet. isUnlimited vaut true quand la carte n'expire pas.

Requête

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Réponses

200

Schéma application/json

• cardType string requiredenum: STORE_CARD, MEMBER_CARD
• clientTypes object[] required
  • storeCard oneOf required
    • StoreCard
      • 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
          • additionalContacts object[] required
          • termsAndConditions object required
          • 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
      • cardType string requiredenum: STORE_CARD, MEMBER_CARD
      • displayIdentifiant boolean required
      • displayWalletName boolean
      • strip string required
      • passBuilderPassTemplateId string
      • programName string
      • keysHasChanged string[]
      • startRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
      • middleRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
      • endRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
      • iosHeader object
        • labelEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
        • valueEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
        • customLabel string
        • customValue string
      • barcodeType string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
      • descriptions object[] required
        • title string required
        • value string required
      • openingHours string required
      • colors object required
        • labelColor string required
        • backgroundColor string required
        • foregroundColor string required
      • oneTimeToUse boolean required
      • sharingProhibited boolean required
      • sharingProhibitedAndroid boolean required
      • validity object required
        • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
        • expirationDate string <date-time>
        • expirationAfterPeriod string
        • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
        • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
      • gainLabel string requiredenum: GAIN, GAINS, CAGNOTE, POINTS
      • gainUnit string requiredenum: NONE, EURO, USD, MAD, POINTS
      • offerLabel string required
      • enableDisplayIdentifiant boolean required
      • gainFormatMigrated boolean required
        Indique si le modèle PassBuilder et tous les passes existants ont été migrés vers le nouveau format de gain, où le symbole de l'unité est intégré à la valeur de l'attribut du pass (par exemple « 50 Pts ») plutôt qu'au champ du modèle. `false` (ou absent) signifie que l'ancien format est toujours utilisé.
      • _id string required
      • createdAt string <date-time> required
      • updatedAt string <date-time> required
    • option 2
  • name string required
  • isDefault boolean required
  • _id string required
  • createdAt string <date-time> required
  • updatedAt string <date-time> required
• expirationDate string <date-time> required
• startRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• middleRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• endRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• communicationChannel string requiredenum: email, sms, all
• isUnlimited boolean

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

404

MODEL_NOT_FOUND

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email