Modules

Abonnés à la newsletter

Retourne la configuration du module newsletter GET
/v1/sites/{code_site}/prefs/newsletter.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "registration_success_msg": "string",
    "unregistration_success_msg": "string",
    "registration_error_msg": "string",
    "unregistration_error_msg": "string"
}
NomTypeDescription
registration_success_msgstringMessage de confirmation si l'inscription est validée
unregistration_success_msgstringMessage de confirmation si la désinscription est validée
registration_error_msgstringMessage de d'erreur si l'utilisateur est déjà inscrit
unregistration_error_msgstringMessage de d'erreur si l'utilisateur n'est pas inscrit
Modifie la configuration du module newsletter PUT
/v1/sites/{code_site}/prefs/newsletter.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
registration_success_msgstringMessage de confirmation si l'inscription est validée
unregistration_success_msgstringMessage de confirmation si la désinscription est validée
registration_error_msgstringMessage de d'erreur si l'utilisateur est déjà inscrit
unregistration_error_msgstringMessage de d'erreur si l'utilisateur n'est pas inscrit
Liste les abonnés à la newsletter GET
/v1/sites/{code_site}/subscribers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_registeredbooleanFiltre par inscription
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
email / -emailTri selon l'email de l'abonné
date / -dateTri selon la date d'inscription

Format de sortie :

data:[
    {
        "subscriber_id": "integer",
        "email": "string",
        "is_registered": "boolean",
        "subscription_date": "string",
        "subscription_date_f": "string",
        "subscription_date_timestamp": "integer"
    }
]
NomTypeDescription
subscriber_idintegerIdentifiant de l'abonné
emailstringEmail de l'abonné
is_registeredbooleanEtat de l'abonnement
subscription_datestringdate de l'abonnement
subscription_date_fstringdate formatée de l'abonnement
subscription_date_timestampintegertimestamp de la date de l'abonnement
Ajoute un abonné POST
/v1/sites/{code_site}/subscribers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
emailObligatoirestringMail de l'abonné
is_registeredObligatoirebooleanInscrit l'abonné (défaut : true)

Format de sortie :

data:[]
NomTypeDescription
Modifie un abonné PUT
/v1/sites/{code_site}/subscribers/{subscriber_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
subscriber_idObligatoireintegerIndetifiant l'abonné
is_registeredObligatoirebooleanInscrit l'abonné

Format de sortie :

data:{
    "subscriber_id": "integer",
    "email": "string",
    "is_registered": "boolean",
    "subscription_date": "string",
    "subscription_date_f": "string",
    "subscription_date_timestamp": "integer"
}
NomTypeDescription
subscriber_idintegerIdentifiant de l'abonné
emailstringEmail de l'abonné
is_registeredbooleanEtat de l'abonnement
subscription_datestringdate de l'abonnement
subscription_date_fstringdate formatée de l'abonnement
subscription_date_timestampintegertimestamp de la date de l'abonnement
Supprime un abonné DELETE
/v1/sites/{code_site}/subscribers/{subscriber_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
subscriber_idObligatoireintegerIndetifiant de l'abonné

Google Analytics

Retourne la configuration de Google Analytics GET
/v1/sites/{code_site}/modules/analytics.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "UA": "string",
    "is_enabled": "boolean",
    "type": "string",
    "target": "string",
    "options": "string"
}
NomTypeDescription
UAstringNuméro de tracker sous la forme UA-xxxxxx-x
is_enabledbooleanActive ou non le tracker Analytics
typestringType de tracker
targetstringPosition du tracker
optionsstringParamètres supplémentaires du tracker
Modifie la configuration de Google Analytics PUT
/v1/sites/{code_site}/modules/analytics.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
UAstringNuméro de tracker sous la forme UA-xxxxxx-x
is_enabledbooleanActive ou non le tracker Analytics
typestringType de tracker
Les valeurs attendues sont : sync, async, universal
targetstringPosition du tracker, parmis les valeurs suivantes :
headAvant </head>
bodyAvant </body>

Les valeurs attendues sont : head, body
optionsstringParamètres supplémentaires du tracker

Points de fidelité

Retourne la configuration des points de fidélité GET
/v1/sites/{code_site}/prefs/fidelity.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "gain_rate": "integer",
    "reward_first_order": "integer",
    "reward_subscriber": "integer",
    "is_creation_enabled": "boolean",
    "creation_cost": "integer",
    "voucher_mail_subject": "string",
    "voucher_value": "float",
    "voucher_validity": "integer",
    "voucher_threshold": "float",
    "is_voucher_restricted": "boolean"
}
NomTypeDescription
gain_rateintegerGain par commande
reward_first_orderintegerBonus à la première commande
reward_subscriberintegerBonus à l'inscription à la newsletter lors de l'ouverture de compte
is_creation_enabledbooleanEnvoi du bon de réduction
creation_costintegerQuantité de points pour un bon de réduction
voucher_mail_subjectstringSujet de l'email
voucher_valuefloatMontant du bon de réduction
voucher_validityintegerDurée de validité du bon de réduction en mois
voucher_thresholdfloatSeuil du bon de réduction
is_voucher_restrictedbooleanLimiter l'utilisation du bon au membre qui le détient
Modifie la configuration des points de fidélité PUT
/v1/sites/{code_site}/prefs/fidelity.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
gain_rateintegerGain par commande
reward_first_orderintegerBonus à la première commande
reward_subscriberintegerBonus à l'inscription à la newsletter lors de l'ouverture de compte
is_creation_enabledbooleanEnvoi du bon de réduction
creation_costintegerQuantité de points pour un bon de réduction
voucher_mail_subjectstringSujet de l'email
voucher_valuefloatMontant du bon de réduction
voucher_validityintegerDurée de validité du bon de réduction en mois
voucher_thresholdfloatSeuil du bon de réduction
is_voucher_restrictedbooleanLimiter l'utilisation du bon au membre qui le détient

Google Merchant Center

Retourne la configuration de Merchant Center GET
/v1/sites/{code_site}/prefs/merchantcenter.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "categories": "List",
    "export_url": "string",
    "last_export": "string"
}
NomTypeDescription
is_enabledbooleanEnvoi du bon de réduction
categoriesListCatégories du flux d'export
export_urlFacultatifstringURL du flux d'export
last_exportFacultatifstringDate du dernier génération du flux d'export
Modifie la configuration de Merchant Center PUT
/v1/sites/{code_site}/prefs/merchantcenter.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActivation du flux
categoriesarrayCatégories du flux d'export
Retourne la configuration de Merchant Center GET
/v1/sites/{code_site}/prefs/merchantcenter/categories.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringRecherche par libellé
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "category_id": "integer",
        "name": "string"
    }
]
NomTypeDescription
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie

Google reCaptcha

Retourne les préférences du captcha GET
/v1/sites/{code_site}/prefs/captcha.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "type": "string",
    "recaptcha_key": "string",
    "recaptcha_secret": "string"
}
NomTypeDescription
typestringType de captcha
recaptcha_keyFacultatifstringClé reCaptcha du site
recaptcha_secretFacultatifstringClé reCaptcha secrète
Modifie les préférences du captcha PUT
/v1/sites/{code_site}/prefs/captcha.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
typestringType de captcha
Les valeurs attendues sont : kiubi, recaptcha
recaptcha_keystringClé reCaptcha du site
recaptcha_secretstringClé reCaptcha secrète

Avis vérifiés

Retourne la configuration de Avis-vérifiés GET
/v1/sites/{code_site}/prefs/avisverifies.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "id": "string",
    "plateform": "string",
    "secret": "string",
    "offset": "integer",
    "is_sending_products": "boolean",
    "is_enabled": "boolean"
}
NomTypeDescription
idstringIdentifiant
plateformstringPlateforme
secretstringClé secrète
offsetintegerDélai d'attente avant demande d'avis
is_sending_productsbooleanRécolter les également les avis produits
is_enabledbooleanActive ou non Avis-vérifiés
Modifie la configuration de Avis-vérifiés PUT
/v1/sites/{code_site}/prefs/avisverifies.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
idstringIdentifiant
plateformstringPlateforme
Les valeurs attendues sont : FR, ES, DE, IT, NL, UK, US, BR, PT, CO, PL, PE, CL, AU, NZ, MX
secretstringClé secrète
offsetintegerDélai d'attente avant demande d'avis
is_sending_productsbooleanRécolter les également les avis produits
is_enabledbooleanActive ou non Avis-vérifiés

IAdvize

Retourne la configuration de iAdvize GET
/v1/sites/{code_site}/prefs/iadvize.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "id": "string",
    "is_enabled": "boolean"
}
NomTypeDescription
idstringNuméro de compte
is_enabledbooleanActive ou non iAdvize
Modifie la configuration de iAdvize PUT
/v1/sites/{code_site}/prefs/iadvize.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
idstringNuméro de compte
is_enabledbooleanActive ou non iAdvize

Lengow

Retourne la configuration de Lengow GET
/v1/sites/{code_site}/prefs/lengow.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "categories": "List",
    "id": "string",
    "is_tracker_enabled": "boolean",
    "export_url": "string",
    "last_export": "string"
}
NomTypeDescription
is_enabledbooleanActive le flux d'export
categoriesListCatégories du flux d'export
idstringIdentifiant
is_tracker_enabledbooleanActive le tracker
export_urlFacultatifstringURL du flux d'export
last_exportFacultatifstringDate du dernier génération du flux d'export
Modifie la configuration de Lengow PUT
/v1/sites/{code_site}/prefs/lengow.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActive le flux d'export
categoriesarrayCatégories du flux d'export
idstringIdentifiant
is_tracker_enabledbooleanActive le tracker