Aller au contenu principal

Créer un type de client

POST

https://api-v2.test.eldowallet.fr/client-types

Crée un type de client (par exemple VIP ou standard) sur la carte de fidélité du wallet. Le nom du type apparaît sur la carte des clients qui y sont rattachés. Renvoie le type créé.

À retenir
  • Le premier type de client créé devient automatiquement le type par défaut. Avec isDefault: true, le nouveau type remplace le type par défaut actuel. Sans name, le type s'appelle Silver ; un nom doit compter de 2 à 30 caractères.

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 application/json required
  • name stringdefault: "Silver"minLength: 2maxLength: 30
  • isDefault booleandefault: false

Réponses​

Schéma application/json
  • 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
            • 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
    • option 2
  • name string required
  • isDefault boolean required
  • _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