Mettre à jour la carte de fidélité

PATCH

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

Met à jour le modèle de la carte de fidélité du wallet (design, textes, bandeau, validité, unité de gain…) et applique les changements aux cartes déjà émises. Accepte application/json ou multipart/form-data (pour envoyer l'image strip). Renvoie la carte mise à jour.

À 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>
• cardType stringenum: STORE_CARD, MEMBER_CARD
• programName string
• barcodeType stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
• colors object
  • backgroundColor string required
  • labelColor string required
  • foregroundColor string required
• validity object
  • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
  • expirationDate string <date-time>
  • expirationAfterPeriod string
  • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
  • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
• descriptions object[]
  • title string required
  • value string required
• openingHours string
• oneTimeToUse boolean
• sharingProhibited boolean
• sharingProhibitedAndroid boolean
• displayIdentifiant boolean
• displayWalletName boolean
• 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
• gainLabel stringenum: GAIN, GAINS, CAGNOTE, POINTS
• gainUnit stringenum: NONE, EURO, USD, MAD, POINTS

Body application/json required

• strip string <binary>
• cardType stringenum: STORE_CARD, MEMBER_CARD
• programName string
• barcodeType stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
• colors object
  • backgroundColor string required
  • labelColor string required
  • foregroundColor string required
• validity object
  • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
  • expirationDate string <date-time>
  • expirationAfterPeriod string
  • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
  • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
• descriptions object[]
  • title string required
  • value string required
• openingHours string
• oneTimeToUse boolean
• sharingProhibited boolean
• sharingProhibitedAndroid boolean
• displayIdentifiant boolean
• displayWalletName boolean
• 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
• gainLabel stringenum: GAIN, GAINS, CAGNOTE, POINTS
• gainUnit stringenum: NONE, EURO, USD, MAD, POINTS

Réponses

200

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
• 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

400

VALIDATION_ERROR · INVALID_JSON · INVALID_MULTIPART · CLIENTS_EXIST_FOR_THIS_CARD_TYPE · INSUFFICIENT_CREDIT · OPERATION_TYPE_REQUIRED · OPERATION_TYPE_NOT_ALLOWED

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

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

409

INSUFFICIENT_CREDIT_PARTIAL

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

415

UNSUPPORTED_MEDIA_TYPE

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

503

PASS_BUILDER_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