Privilege API reference

identifier

Your Club (merchant) identifier. This is an internal identifier (not displayed to members), and secondarily, if you need to create campaign or offer for this merchant, you will have to precise the "identifier" while calling the API service. Ex: mysite

name

Your merchant name. It is displayed to members on some pages (landing page, tickets, ...). Ex: My Site

nameVariante1,2,3,4

Your merchant name variantes n°1, n°2, n°3, n°4. It is displayed to members on some legal pages (ex: CGU). If not provided it will be the name which will be used. Ex: My Site, My Site SA, My Site & Associates

email

It may be used to send you message info concerning your Privilege activity

password

This is the password you may be used to access to the Privilege backoffice here

address

Your merchant physical address. Ex: Route Industrielle 4, 1806 Saint-Légier-La Chiésaz, Suisse

address

Your hotline number. By default it is IDMobile hotline number +41 848 123 400

siteUrl

Your Club (merchant) site name. By default, it is https://www.clubprivilege.ch/club/mysite.

infosUrl

Your owned site name. Ex: https://www.mysite.com

cguUrl

Your owned site CGU URL. Ex: https://www.mysite.com/terms-and-conditions

shopsMapUrl

Your owned shops map. Ex: https://www.google.com/maps/d/embed?mid=1wOM6b_b1uAa9Dz2cB8KUABi-GZi9dFob

unsubscriptionUrl

Your owned site unsubscription URL. By default it is https://www.clubprivilege.ch/club/mysite/fr/unsubscribe

smsSender

It is used as the sender whiling sending SMS message to the members

translations

{langue}

smsKeyword

It is used by members as the keyword to send (to the 494) to subscribe as a member to the Merchant Privilege. The service Keyword will be created at our SMS provider and each SMS sent will trigger a notification which will subscribe the member.

mobileValidators

This is the list of mobiles (separated by "#") which will be considered as mobile testers. They will be able to bypass some restriction and limits while using club campaigns forms and offers. Ex: 4177777777#4177888888

status

The merchant activation status (true/false). By default "true"

hidden

The merchant display status (true for hidden, false for displayed). By default "false"

secured

Activate/Secured merchant club form access by password. By default "false"

id

This is the Club (merchant) internal ID from Privilege database

merchantCode

Unique Club (merchant) code provided at creation

status

enabled/disabled merchant

creationDate

The date when this merchant was created

modificationDate

The last date when this merchant was modified

id

This is the merchant internal ID from Privilege database

name

The readable name of the merchant. It can be displayed on form or ticket pages

nameVariante1

The readable name of the merchant. It can be displayed on legal conditions page

nameVariante2

The readable name of the merchant. It can be displayed on legal conditions page

nameVariante3

The readable name of the merchant. It can be displayed on legal conditions page

nameVariante4

The readable name of the merchant. It can be displayed on legal conditions page

smsSender

The sender name use to send SMS. It is displayed as the sender on members mobile when they receive an SMS from Privilege

smsKeyword

The SMS keyword to send to the 494 for subscribing to the merchant Privilege

siteUrl

The canonical URL of the form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

unsubscriptionUrl

The canonical URL of the form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

shopsMapUrl

The GoogleMaps displayed your points of sale/shops

cguUrl

The link to your general conditions page (generally, redirecting to your website)

infosUrl

The link to the data protection policy page. By default it is the one of Privilege https://www.clubprivilege.ch/club/#your_merchant_code#/fr/conditions

code

This is the merchant code and URL identifier. You will have to send this identifier while using the API for this merchant

identifier

This is the Mbuy customer ID related to this merchant

identifier2

This is the Mbuy campaign ID related to this merchant

tags

In case you need various URL for your Privilege, this parameter allow you to manage them (separated by "|")

address

The main address of this merchant. It is displayed on the form page

hotlineNumber

The hotline number of this merchant. It is displayed on the form page

mobileValidators

In case you need to be able to make several registrations, you can specify your mobile number as a tester (separated by "#")

authorizedLanguages

The allowed languages on this Club

hidden

If set to true, the Club (merchant) is not visible

secured

If set to true, the Club (merchant) form page is secured with a login/password

account

In case you manage multiple merchants, this is your account ID

translations

{langue}

header

The header displayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

translations

{langue}

conditionsIntro

The term of usage intro displayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

translations

{langue}

conditionsData

The term of page linked on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

translations

{langue}

conditionsOffline

The term of usage intro displayed on the form page for offline registration https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

id

The campaign id of the campaign

identifier

The merchant code

page

The page number for paginated results

limit

The numbers of results by page for paginated results

list of merchants

The Clubs (merchants) result list

identifier

The campaign identifier. You will need to manage this campaign using the identifier

name

The campaign name. It is using for displaying statistics and when scanning ticket using the scan app

merchant

The Club (merchant) identifier to which this campaign belong to

startDate

The start date of the campaign. Starting that date the configuration of this campaign will be used for the form page

endDate

The end date of the campaign. Ending that date the configuration of this campaign will not be used anymore for the form page

status

The campaign activation status. By default true

main

If that campaign is the club principal campaign, then its configuration will be used on the default club form page. By default false

publishStatus

The publication status of the campaign (STATUS_DRAFT = 1; STATUS_WAITING_FOR_VALIDATION = 2; STATUS_VALIDATED = 3; STATUS_SENDING = 4; STATUS_LIVE = 5; STATUS_CLOSED = 6; STATUS_INTERRUPTED = 7; STATUS_DELETED = 8). By default 5.

hasRegistration

If that campaign need to override the main form page, then set this parameter to true. By default false

hasDedicatedRegistration

If that campaign need to have its proper new landing page, then set this parameter to true. By default "false"

isTargetingMultipleCountries

If members can comes from various countries then set this parameter to true. If they only comes from Switzerlland then set this parameter to false

presentationHeaderImage

The header image used on the main home of Privilege

formHeaderImage

The header image used on the form page

formBackgroundImage

The background image used on the form page

sharedImage

The image used when sharing a Privilege page (form, ticket, ...) on social networks

translations

{langue}

formTitle

The title of the form page. You can precise the {langue} (e.g: formTitleFr or formTitleEn or formTitleIt or formTitleDe) to set the translation of that title. If none langue is used (e.g: formTitle) the default langue is "fr".

translations

{langue}

formSubtitle

The subtitle of the form page. You can precise the {langue} (e.g: formSubtitleFr or formSubtitleEn or formSubtitleIt or formSubtitleDe) to set the translation of that subtitle. If none langue is used (e.g: formSubtitle) the default langue is "fr".

translations

{langue}

formIntroduction

The introduction of the form page. You can precise the {langue} (e.g: formIntroductionFr or formIntroductionEn or formIntroductionIt or formIntroductionDe) to set the translation of that introduction. If none langue is used (e.g: formIntroduction) the default langue is "fr".

translations

{langue}

formFieldsTitle

The text displayed on club form page above fields.

translations

{langue}

formFooter

The text displayed on club form page below fields.

formHasFirstname

Set this parameter to true if you want to display the "firstname" entry field on the form page

formHasLastname

Set this parameter to true if you want to display the "lastname" entry field on the form page

formHasPostalCode

Set this parameter to true if you want to display the "postal code" entry field on the form page

formHasGender

Set this parameter to true if you want to display the "gender" entry field on the form page

formHasShareLinks

Set this parameter to true if you want to display the "share on social networks" buttons on the form page

hasSharedReward

Set this parameter to true if you want to generate a ticket each time a member sponsors a new member

hasScanAnwsers

Set this parameter to true if you want to send specific SMS message content to members when they consume their tickets at the shop. By default, defaults message are used

isOffline

Set this parameter to true if you want to allow subscription of members with no mobile. By default "false"

ticketValidityMinDate

The min date to consume tickets of this campaign. Starting that date the tickets will be accepted by the app scan

ticketValidityMaxDate

The max date to consume tickets of this campaign. Ending that date the tickets will not be accepted anymore by the app scan

ticketValidityMinDelay

The min delay (in days) to consume tickets of this campaign after the ticket creation date. Starting that delay the tickets will be accepted by the app scan

ticketValidityMaxDelay

The max delay (in days) to consume tickets of this campaign after the ticket creation date. Starting that delay the tickets will not be accepted anymore by the app scan

maxTickets

The max number of tickets generated for this campaign. When limit is reached, members will not receive anymore ticket while registering on the form page

translations

{langue}

smsRegistrationConfirm

The SMS text receive when members register to the Privilege using the form page. You can precise the {langue} (e.g: smsRegistrationConfirmFr or smsRegistrationConfirmEn or smsRegistrationConfirmIt or smsRegistrationConfirmDe) to send this text to members with that language set on their profil. If none langue is used (e.g: smsRegistrationConfirm) the default langue is "fr".

translations

{langue}

smsGodfatherConfirm

The SMS text receive when members register to the Privilege using the form page and using a sponsored link (i.e: shared on social networks). You can precise the {langue} (e.g: smsGodfatherConfirmFr or smsGodfatherConfirmEn or smsGodfatherConfirmIt or smsGodfatherConfirmDe) to send this text to members with that language set on their profil. If none langue is used (e.g: smsGodfatherConfirm) the default langue is "fr".

translations

{langue}

smsTicketBurnConfirm

The SMS text receive when members scan their ticket using the app scan. You can precise the {langue} (e.g: smsTicketBurnConfirmFr or smsTicketBurnConfirmEn or smsTicketBurnConfirmIt or smsTicketBurnConfirmDe) to send this text to members with that language set on their profil. If none langue is used (e.g: smsTicketBurnConfirm) the default langue is "fr".

hasSmsKeyword

Set this parameter to true if you want to accept member registration by sending an SMS to the 494 (e.g.: send BUYANDWIN to 494)

translations

{langue}

smsKeyword

The SMS keyword to send (to the 494 number) for registering to the Privilege using this campaign. You can precise the {langue} (e.g: smsKeywordFr or smsKeywordEn or smsKeywordIt or smsKeywordDe) to set the registered member language using this keyword. If none langue is used (e.g: smsKeyword) the default langue is "fr".

translations

{langue}

smsKeywordRegistrationConfirm

The SMS text received when members register to the Privilege using the campaign SMS keyword. You can precise the {langue} (e.g: smsKeywordRegistrationConfirmFr or smsKeywordRegistrationConfirmEn or smsKeywordRegistrationConfirmIt or smsKeywordRegistrationConfirmDe) to send this text to members with that language set on their profil. If none langue is used (e.g: smsKeywordRegistrationConfirm) the default langue is "fr".

hasTargeting

If you want to send a mass SMS to all existing members for this club then set this parameter to true. By default "false"

smsTargetingDate

The date when mass SMS will be sent to all members targeted by the campaign

smsRetargetingDate

The date when mass SMS will be re-sent to all members targeted by the campaign

isSentAuto

Set this parameter to true if you want to send the campaign automatically. By default "false"

targetingGeoPostalCode

Set this parameter to true if you want to send the campaign automatically. By default "false"

id

This is the campaign internal ID from the Privilege database

id

The internal ID of the campaign

merchant

The Club (merchant) code of the campaign

id

This is the campaign internal ID from Privilege database

status

enabled/disabled campaign

creationDate

The date when this campaign was created

modificationDate

The last date when this campaign was modified

name

The readable name of the campaign. It can be displayed on form or ticket pages

identifier

The campaign identifier. You need it to manage this campaign configuration or its offers ones using the API

startDate

The start date of the campaign. Starting that date the configuration of this campaign will be used for the form page

endDate

The end date of the campaign. Ending that date the configuration of this campaign will not be used anymore for the form page

publishStatus

The publication status of the campaign (STATUS_DRAFT = 1; STATUS_WAITING_FOR_VALIDATION = 2; STATUS_VALIDATED = 3; STATUS_SENDING = 4; STATUS_LIVE = 5; STATUS_CLOSED = 6; STATUS_INTERRUPTED = 7; STATUS_DELETED = 8). By default 5.

ticketValidityMinDate

The min date to consume tickets of this campaign. Starting that date the tickets will be accepted by the app scan

ticketValidityMaxDate

The max date to consume tickets of this campaign. Ending that date the tickets will not be accepted anymore by the app scan

ticketValidityMinDelay

The min delay (in days) to consume tickets of this campaign after the ticket creation date. Starting that delay the tickets will be accepted by the app scan

ticketValidityMaxDate

The max delay (in days) to consume tickets of this campaign after the ticket creation date. Starting that delay the tickets will not be accepted anymore by the app scan

hasRegistration

If this campaign has a registration form (main registration page) then this parameter will be set to true

hasDedicatedRegistration

If this campaign has a dedicated registration form (landing page) then this parameter will be set to true

hasScanRegistration

If this campaign has a registration form on scan app then this parameter will be set to true

hasTargeting

If this campaign has a set of members targeting criteria (form page) then this parameter will be set to true

ticketOnlyTargeted

When set to true, generates and sends a ticket at subscription only if member is targeted

isSentAuto

Set this parameter to true if you want to send the campaign automatically. By default "false"

isTargetingMultipleCountries

If registered members can comes from various countries then this parameter is set to true. If they only comes from Switerland, then it is set to false

targetingDate

The date when mass SMS will be sent to all members targeted by the campaign

retargetingDate

The date when mass SMS will be re-sent to all members targeted by the campaign

targetingGeoPostalCode

Target members by geographic postal code

targetingGeoState

Target members by geographic state

targetingGeoStatesExclude

Target members by geographic state to exclude

targetingGeoLangue

Target members by member language

targetingGeoGender

Target members by member gender

targetingGeoDistance

Target members by geographic distance from the postal code

targetingMobileCountry

Target members by mobile country prefix

targetingActivesOnly

Target members actives only (burned at least one ticket)

targetingInactivesOnly

Target members inactives only (burned no ticket)

targetingCampaignOld

Target members who received a ticket from an Mbuy campaign (deprecated)

targetingIncompleteOnly

Target members with missing information (firstname, lastname, postal code)

targetingMinSubscriptionDate

Target members registered after a subscription date

targetingBirthDayOnly

Target members who borned on the current day of a previous year

targetingSubscriptionDayOnly

Target members who registered on the current day of a previous year

targetingSubscription

Target members who subscribed using a source

targetingTicketValidShop

Target members who burned their tickets at a shop (scan desk)

targetingTicketBurnedStartDate

Target members who burned their tickets after a date

targetingTicketBurnedEndDate

Target members who burned their tickets before a date

targetingTicketsBurnedMinCount

Target members who burned at least a number of tickets

presentationHeaderImage

The image URL that is displayed on the main/home of Privilege

formHeaderImage

The images URL that is displayed as the header of the merchant form page https://www.clubprivilege.ch/club/#your_merchant_code#/fr/

formBackgroundImage

The images URL that is displayed as the background of the merchant form page https://www.clubprivilege.ch/club/#merchant_id#/fr/

formHasFirstname

This parameter is set to true if the "firstname" entry field is displayed on the form page

formHasLastname

This parameter is set to true if the "lastname" entry field is displayed on the form page

formHasPostalCode

This parameter is set to to true if the "postal code" entry field is displayed on the form page

formHasGender

This parameter is set to true if the "gender" entry field is displayed on the form page

formPersonalInfoOptional

This parameter is set to true if personal information are optional on form page

formHasCgu

This parameter is set to true if the "confirm general conditions" checkbox is displayed on the form page

formHasFieldTitle

This parameter is set to true if the form fields title is displayed on the form page

formIsProtected

This parameter is set to true if the form page is protected by a login/password

formHasShareLinks

This parameter is set to true if the "share on social networks" buttons are displayed on the form page

hasSharedReward

This parameter is set to true if a ticket is generated each time a member sponsors another new member

sharedImage

The image used when sharing a Privilege page (form, ticket, ...) on social networks

hasSmsKeyword

This parameter is to true if members registrations by sending an SMS to the 494 (e.g.: send BUYANDWIN to 494) are accepted

hasScanAnswers

This parameter is set to true if SMS are sent for this campaign at ticket specific scan status

maxTickets

The max number of tickets generated for this campaign. When limit is reached, the form page is closed

maxBurnedTickets

The max number of tickets burned for this campaign. When limit is reached, the scan app refuses next scanned tickets

maxKey

The max key to manage common stock for maxTickets and maxBurnedTickets

formEndRedirectionUrl

This is the URL to redirect member to when form page is closed

formCloseSubscriptionDate

This is the date to close the form page

hasSingleTicketRegistration

If set to true, the form page will allow member to choose their offer

isOffline

If set to true, then members registration without mobile are accepted

isCloseSubscriptionDateLimitReached

If set to true, the form is closed because close subscription date is reached

isAllOffersMaxTicketsLimitReached

If set to true, the form is closed because max numbers of generated tickets is reached

main

If this parameter is set to true, then it means that this will be the default campaign (in case there are no others activated campaigns available)

onConsumeStartCampaign

Trigger the campaign registration when ticket is scanned

sentSMSsCount

The number of sent SMS with this campaign

generatedTicketsCount

The number of generated tickets with this campaign

burnedTicketsCount

The number of scanned tickets with this campaign

targetedCustomersCount

The number of members targeted with this campaign

estimatedCustomersCount

The estimated number of members targeted with this campaign

merchant

The merchant related to this campaign

offers

The offers related to this campaign

fields

The custom form fields related to this campaign

targetingFields

The targeted criteria values used by the campaign targeting

targetingCampaigns

The campaigns to used as targeting for this campaign

translations

{langue}

presentation

The presentation of the Privilege displayed on the home Privilege

translations

{langue}

formTitle

The title of the Privilege diplayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/.

translations

{langue}

formSubtitle

The subtitle of the Privilege campaign diplayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/.

translations

{langue}

formFieldsTitle

The subtitle of the Privilege campaign diplayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/.

translations

{langue}

formIntroduction

The introduction of Privilege campaign diplayed on the form page https://www.clubprivilege.ch/club/#your_merchant_code#/.

translations

{langue}

formLegalOptin

The text label for the optin checkbox of the form.

translations

{langue}

formRegistrationConfirm

The confirmation message for the {langue} displayed after a registration through the form page

translations

{langue}

formFooter

The text for the form footer.

translations

{langue}

smsSender

The sender name of the SMS.

translations

{langue}

smsTargeting

The text for the content of SMS targeting launch.

translations

{langue}

smsRetargeting

The text for the content of SMS re-targeting launch.

translations

{langue}

smsRegistrationConfirm

The text for the content of SMS sent at registration.

translations

{langue}

smsAlreadyRegisteredConfirm

The text for the content of SMS at registration of an already known.

translations

{langue}

smsGodfatherConfirm

The text for the content of SMS at sponsoring of a member.

translations

{langue}

smsTicketBurnConfirm

The text for the content of SMS at ticket scan succeed.

translations

{langue}

smsScanAlreadyConsumed

The text for the content of SMS at ticket already scanned.

translations

{langue}

smsScanExpired

The text for the content of SMS at scan of ticket expired.

translations

{langue}

smsScanOutOfStock

The text for the content of SMS at scan of ticket after stock limit.

translations

{langue}

smsKeyword

The text to send by SMS for automatic registration.

translations

{langue}

smsKeywordRegistrationConfirmation

The text for the content of SMS at keyword registration.

translations

{langue}

smsGameWinConfirm

The text for the content of SMS sent at game win.

translations

{langue}

smsGameLooseConfirm

The text for the content of SMS sent at game loose.

main

This gets only main campaigns

merchant

The Club (merchant) code of the campaign

merchantIdentifier

The merchant Mbuy customer identifier of the campaign

merchantIdentifier2

The merchant Mbuy campaign identifier of the campaign

page

The page number for paginated results

limit

The numbers of results by page for paginated results

list of campaigns

The campaigns result list

identifier

The identifier of the offer. It is not displayed to members. It can be latter used to retrieve/update offer information

merchant

The identifier of the campaign which this offer needs to be created for

campaign

The identifier of the Club (merchant) which this offer needs to be created for

ticketBarcode

If your shop need to scan a barcode (moreover than the QR code) to update your system, then send the barcode URL using this parameter

ticketHeaderImage

The image is displayed on the header of members tickets

ticketBackgroundColorCode

The color code is used as background on members tickets

ticketBorderColorCode

The color code is used as border on members tickets

ticketTextColor

The color code is used as text color on members tickets

ticketValidColorCode

The color code is used by the app when a member ticket is scanned

ticketValidShop

The identifier of one of merchant shops which the ticket is valid for

translations

{langue}

name

The title of the offer. It is displayed on the ticket offer. You can precise the {langue} (e.g: nameFr or nameEn or nameIt or nameDe) to set the translation of that name. If none langue is used (e.g: name), then the default langue is "fr".

translations

{langue}

informations

The informations of the offer. It is displayed on the ticket offer. You can precise the {langue} (e.g: informationsFr or informationsEn or informationsIt or informationsDe) to set the translation of that informations. If none langue is used (e.g: informations), then the default langue is "fr".

translations

{langue}

conditions

The conditions of the offer. It is displayed on the ticket offer. You can precise the {langue} (e.g: conditionsFr or conditionsEn or conditionsIt or conditionsDe) to set the translation of those conditions. If none langue is used (e.g: conditions), then the default langue is "fr".

translations

{langue}

restrictions

The restrictions of the offer. It is displayed on the ticket offer. You can precise the {langue} (e.g: restrictionsFr or restrictionsEn or restrictionsIt or restrictionsDe) to set the translation of that retrictions. If none langue is used (e.g: restrictions) the default langue is "fr".

id

This is the offer internal ID created in Privilege database.

id

The offer id which you need to retrieve the information for

id

The offer internal ID from Privilege database.

identifier

The offer identifier (code). It is not displayed to the members. It can be used to retrieve offer information using the API

status

The status of the offer (enabled/disabled)

creationDate

The offer creation date

modificationDate

The offer modification date

name

The offer name

type

The offer type (-1: none, 1: gift, 2: election, 3: win, 4: gift_card, 5: auth_card, 6: prepaid_card, 7: reward_card)

hideCustomerInfos

This hides member personal informations from tickets

hideQRCode

This hides the QR code image from tickets

hideBarcode

This hides the barcode image from tickets

isDynamicBarcode

This generates EAN barcode from tickets code

staticBarcodeImage

The URL of the offer ticket EAN barcode

isUsableMultipleTimes

This allows tickets to be scanned multiple times

isUsableEachDay

This allows tickets to be scanned once time per day

isUsableSingleDay

This allows tickets to be scanned multiple time during a single day

isUsableEachShop

This allows tickets to be scanned one time by each scan desk

numberOfUsages

The number of scan allowed for each tickets

isSelfScannable

This allows tickets to be self-scanned by members. This display a camera to scan a QR (e.g: at shop entry)

isDebitable

This allow ticket to be debitable and triggers a debit popup on app when scanning tickets

creditAmountInitial

The debitable amount on each ticket. The ticket is refused if there is no more credit.

reductionRate

The reduction amount rate provided bby ticket. The amount is calculated at each ticket scan.

spentAmountMin

The minimum amount spent to debit this ticket

ticketHeaderImage

The offer ticket header image

ticketValidColorCode

The color code used by the app when scaning one of this offer tickets

ticketValidShop

The shop where these offer tickets are valid for

ticketBackgroundColor

The background color used when displaying the offer tickets

ticketBorderColor

The color used for borders when displaying the offer tickets

ticketTextColor

The color used for text when displaying the offer tickets

ticketLinkColor

The color used for text links when displaying the offer tickets

main

If main is set to true, then it means that this offer is given when members are subscribing to Privilege

hasCodePool

If set to true, then it means that this offer has a predefined pool of codes defined

hasScanSettings

If set to true, then it means that this offer has a predefined SMS text content for each ticket scan result type

scanExpiredColorCode

The color used by the app scan when scaning an expired ticket of this offer

scanValidColorCode

The color used by the app scan when scaning an valid ticket of this offer

scanOutOfStockColorCode

The color used by the app scan when scaning a ticket of this offer after stock is depleated

scanConsumedColorCode

The color used by the app scan when scaning an already consumed ticket of this offer

scanInvalidColorCode

The color used by the app scan when scaning a ticket of this offer using an invalid shop desk

maxTickets

The maximum number of ticket generated for this offer

maxBurnedTickets

The maximum number of ticket scanned for this offer

maxKey

The maximum key to manage stock of tickets generated/burned for this offer

ticketValidityMinDate

The date starting which the offer tickets are valid

ticketValidityMaxDate

The date until which the offer tickets are valid

ticketValidityMinDelay

The delay starting which the offer tickets are valid

ticketValidityMaxDelay

The delay until which the offer tickets are valid

displaySlider

If set to true, this display a slider on form page

sliderImage

The offer image used to display it on form page slider

generatedTicketsCount

The number of generated tickets with this offer

burnedTicketsCount

The number of scanned tickets with this offer

displayOrder

The position of the ticket offer among others campaign offers tickets

merchant

The merchant related to this offer

campaign

The campaign related to this offer

ticketActivationCampaign

The campaign used to activate tickets of this offer

translations

{langue}

name

The name of the offer. It is displayed on the offer ticket

translations

{langue}

informations

The information related to the offer. It is displayed on the offer ticket

translations

{langue}

conditions

The conditions related to the offer. It is displayed on the offer ticket

translations

{langue}

restrictions

The usage restriction related to the offer. It is displayed on the offer ticket

translations

{langue}

scanExpiredText

The text content of message popup displayed on the app scan when scaning ticket expired of this offer.

translations

{langue}

scanValidText

The text content of message popup displayed on the app scan when scaning valid ticket of this offer.

translations

{langue}

scanOutOfStockText

The text content of message popup displayed on the app scan when scaning ticket of this offer once stock is depleated.

translations

{langue}

scanInvalidShopText

The text content of message popup displayed on the app scan when scaning ticket of this offer using invalid shop desk.

translations

{langue}

scanConsumedText

The text content of message popup displayed on the app scan when scaning ticket already consumed of this offer.

translations

{langue}

sliderTitle

The slide title displayed on the form page

translations

{langue}

sliderDescription

The slider description displayed on the form page

translations

{langue}

gameDescription

The text introduction used for game

translations

{langue}

smsGameWinConfirm

The text content of SMS sent when wining a game

campaign

The campaign id of the offer

merchant

The merchant ID of the offer

page

The page number for paginated results

limit

The numbers of results by page for paginated results

list of offers

The offers result list

merchant

The Club (merchant) code which the member is subscribing for

mobile

The member phone number (e.g: 077777777)

country

The member phone number prefix (e.g: +41 for Switzerland, +33 for France, ...)

langue

The member langue

firstname

The member firstname

lastname

The member laststname

gender

The member gender (e.g: male)

postalCode

The member postal code (e.g.: 1012)

active

The member subscription status (0 to unsubscribe, 1 to subscribe)

tokenReceived

The token of the member who sponsored this member

source

The member subscription source (e.g: LeMatin.ch), you will latter be able to target members by source if necessary

userAgent

The member browser user agent (e.g.: Mozilla 5.0+ iPhone CPU iPhone OS 13)

ip

The member IP (e.g.: 178.197.239.119)

id

The member internal ID from Privilege database

token

The member token. If you need to allow member to sponsor others members, then you have to send the token parameter in your share URLs, so you be able to retrieve it when a new member subscribe and send it to the API (as the tokenReceived parameter). Example: https://www.clubprivilege.ch/club/nestleshop/fr?t=tok-a86875015cf0becc9dfc64d9d6d2ac5f

id

The member ID which you need to retrieve information for

merchant

The merchant Mbuy customer ID related to this member

mobile

The member mobile

limit

Number of results

page

The result page number

id

The member internal ID from Privilege database

firstname

The member firstname

lastname

The member lastname

email

The member email

langue

The member language

mobile

The member phone number (e.g: 4178888888)

gender

The member gender (1 for female, 2 for male)

creationDate

The member subscription date

modificationDate

The member last modification date

tokenOwned

The member token. It is used in share links, so we can reward the member when he sponsors a new member

tokenReceived

The godfather token. In case this members has been sponsored by another member

status

"1" if the member is subscribed and "0" if he is unsubscribed

sharesCount

The number of member shares

sharesHitsCount

The number of member shares hits

age

The member age

messageType

The type of message received (1: SMS)

userAgent

The member user agent

ip

The member IP

target

The last campaign which this member was targeted for

status

The last date this member was targeted

godfather

The member who sponsored this member

godchilds

The members sponsored by this member

tickets

The tickets received by this member

ticketsBurned

The tickets consumed by this member

customerUser

The unique mobile ID related to this member

SMSs

The IDs of SMSs received by this member

customersFields

The members data fields with values

id

The member ID which you need to retrieve information for

merchant

The merchant Mbuy customer ID related to this member

mobile

The member mobile

sort

The sort order string

page

The page number for paginated results

limit

The numbers of results by page for paginated results

list of customers

The members (customers) result list

merchant

The Club (merchant) code which you need to retrieve statistics for

campaign

The campaign identifier which you need to retrieve statistics for

day

The statistics date

shop

The statistics shop label

nbTickets

The number of tickets generated

nbTicketsBurned

The number of tickets burned/consumed

nbCampaignTicketsCustomers

The number of customers who received a tickets of this campaign

nbCampaignTicketsViewedCustomers

The number of customers who received and viewed a tickets of this campaign and consumed it

nbCampaignTicketsConsumedCustomers

The number of customers who received a tickets of this campaign and consumed it

merchant

The merchant code

code

The ticket code

mobile

The mobile of member consuming the ticket

country

The mobile coutnry of member consuming the ticket

countryAuto

Indicates if international mobile format is used

shop

The shop desk used to scan this ticket

amountsSpentByOffers

A json string containing amount spent for each offer, to get all applicable ongoing reductions

langue

The langue to use to notify member after consuming the ticket

dryRun

Indicates if it is a try or real consumation

result

error

The error code

error_description

The error description

id

The ticket ID which you need to retrieve information for

merchant

The merchant code related to the tickets

mobile

The member mobile

startDate

The minimum ticket creation date

endDate

The maximum ticket creation date

offer

The offer internal ID

campaign

The campaign internal ID

limit

Number of results

page

The result page number

id

The member internal ID from database

creationDate

The ticket creation date

code

The code string

manifestation

The manifestation ID

customerUser

The mobile ID

partlog

The ticket ID

merchant

The Mbuy customer ID

validity

The ticket validity type (deprecated)

transaction

(deprecated)

class

The ticket class (deprecated)

category

The ticket category (deprecated)

customerType

The ticket customer type (deprecated)

text

The ticket text title displayed on member ticket

comment

The ticket comment displayed on member ticket

consumedDate

The ticket consumed date (if ticket is already consumed)

shop

The ticket Shop label

subShop

The ticket Shop sub-level label

email

(deprecated)

mailSubject

(deprecated)

views

The ticket views count

privilege

Flag to indicate if it is a Privilege or simple ticket

status

Flag to indicate if it is an active ticket (deprecated)

amountInitial

The initial amount credited on the ticket (if it is a debitable Privilege ticket)

amountResidual

The remaning amount on the ticket (if it is a debitable Privilege ticket)

offer

The offer related to this ticket (if it is a Privilege ticket)

campaign

The campaign related to this ticket (if it is a Privilege ticket)

customer

The member related to this ticket

fields

The custom fields related to this ticket

id

The ticket ID which you need to retrieve information for

merchant

The merchant code related to the tickets

mobile

The member mobile

startDate

The minimum ticket creation date

endDate

The maximum ticket creation date

offer

The offer internal ID

campaign

The campaign internal ID

limit

Number of results

page

The result page number

list of consumed tickets

The consumed tickets result list

merchant

The merchant code

page

The page number for paginated results

limit

The numbers of results by page for paginated results

id

The shop internal ID from database

identifier

The shop desk identifier string

subIdentifier

The shop desk sub-level identifier string

merchant

The merchant Mbuy ID

startHour

The shop desk opening hour

endHour

The shop desk closing hour

maxBurnedTickets

The shop desk max consumed tickets

burnedTicketsCount

The shop desk consumed tickets count

exitShop

The auto exit shop desk

url

The shop desk url information

accessCampaign

The access campaign

mobile

The member mobile related to this SMS

merchant

The merchant code related to the SMS

startDate

The minimum sent date of SMS

endDate

The maximum sent date of SMS

page

The page number for paginated results

limit

The numbers of results by page for paginated results

id

The SMS internal ID from database

creationDate

The SMS creation date

sentDate

The SMS sent date

mobile

The mobile related to this SMS

langue

The SMS content language

message

The SMS text content

messagePartsCount

The SMS message parts count

type

The SMS type (deprecated)

messageId

The SMS third party internal ID (from MNC)

typeOperation

The SMS operation type (deprecated)

merchant

The Mbuy customer ID related to this SMS

customer

The member related to this SMS

mobile

The member mobile related to this SMS

country

The member mobile country prefix related to this SMS

countryAuto

Detects mobile country automatically

merchant

The merchant code related to the SMS

smsContent

The SMS content

_locale

The member language related to this SMS

id

The SMS internal ID from database