Préférences

Retourne les préférences générales GET

/v1/sites/{code_site}/prefs.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "site_title": "string",
    "is_site_open": "boolean",
    "is_contact_enabled": "boolean",
    "is_blog_enabled": "boolean",
    "is_catalog_enabled": "boolean",
    "is_checkout_enabled": "boolean",
    "is_api_enabled": "boolean",
    "front_login": "string",
    "front_password": "string",
    "breadcrumb": "List"
}

Modifie les préférences générales PUT

/v1/sites/{code_site}/prefs.json

Paramètres supportés par ce endpoint :

Retourne les coordonnées GET

/v1/sites/{code_site}/prefs/contact.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "firstname": "string",
    "lastname": "string",
    "civility": "string",
    "email": "string",
    "address": "string",
    "zipcode": "string",
    "city": "string",
    "country_id": "integer",
    "country": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "company_name": "string",
    "company_forme": "string",
    "company_cnil": "string",
    "company_capital": "string",
    "company_siret": "string",
    "company_rcs": "string",
    "company_naf": "string",
    "company_tva": "string"
}

Modifie les coordonnées PUT

/v1/sites/{code_site}/prefs/contact.json

Paramètres supportés par ce endpoint :

Retourne les préférences RGPD GET

/v1/sites/{code_site}/prefs/gdpr.json

Liste les préférences sur la protection des données personnelles.

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "is_customers_consent_required": "boolean",
    "is_comments_consent_required": "boolean",
    "is_evaluations_consent_required": "boolean",
    "is_newsletter_consent_required": "boolean",
    "is_checkout_consent_required": "boolean"
}

Modifie les préférences RGPD PUT

/v1/sites/{code_site}/prefs/gdpr.json

Modifie les préférences sur la protection des données personnelles.

Paramètres supportés par ce endpoint :

Retourne les paramètres du blog GET

/v1/sites/{code_site}/prefs/blog.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "is_enabled": "boolean",
    "comments_allowed": "boolean",
    "comments_captcha": "boolean",
    "comments_anonymous": "boolean",
    "comments_autopublish": "boolean",
    "is_rss_enabled": "boolean",
    "rss_post_count": "integer"
}

Modifie les paramètres du blog PUT

/v1/sites/{code_site}/prefs/blog.json

Paramètres supportés par ce endpoint :

Retourne les paramètres des commandes GET

/v1/sites/{code_site}/prefs/checkout.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "is_enabled": "boolean",
    "order_prefix": "string",
    "min_order_amount": "float",
    "stockout_selling": "boolean",
    "stockout_threshold": "integer",
    "refill_threshold": "integer",
    "decrement_stock": "string",
    "mail_recipients": "string",
    "mail_pending": "string",
    "mail_processing": "string",
    "mail_processed": "string",
    "mail_shipped": "string",
    "mail_cancelled": "string"
}

Modifie les paramètres des commandes PUT

/v1/sites/{code_site}/prefs/checkout.json

Paramètres supportés par ce endpoint :

Retourne les paramètres du catalogue GET

/v1/sites/{code_site}/prefs/catalog.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "is_enabled": "boolean",
    "currency": "string",
    "display_taxes": "boolean",
    "is_duty_free": "boolean",
    "comments_allowed": "boolean",
    "comments_captcha": "boolean",
    "comments_anonymous": "boolean",
    "comments_autopublish": "boolean",
    "require_auth": "boolean"
}

Modifie les paramètres du catalogue PUT

/v1/sites/{code_site}/prefs/catalog.json

Paramètres supportés par ce endpoint :

Retourne les paramètres des membres GET

/v1/sites/{code_site}/prefs/customers.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "allow_registration": "boolean",
    "allow_login": "boolean",
    "validation": "string",
    "default_group_id": "integer",
    "default_group_label": "string",
    "terms": "string",
    "processing_purposes": "string"
}

Modifie les paramètres des membres PUT

/v1/sites/{code_site}/prefs/customers.json

Paramètres supportés par ce endpoint :

Retourne la configuration des tailles des images GET

/v1/sites/{code_site}/prefs/medias.json

Liste les tailles des vignettes et des mignatures générées à partir des images de la médiathèque.

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "g_vignette_width": "integer",
    "g_vignette_height": "integer",
    "vignette_width": "integer",
    "vignette_height": "integer",
    "g_miniature_width": "integer",
    "g_miniature_height": "integer",
    "miniature_width": "integer",
    "miniature_height": "integer",
    "max_height": "integer",
    "max_width": "integer",
    "is_resize_enabled": "boolean",
    "jpg_compression": "integer"
}

Modifie les tailles des images PUT

/v1/sites/{code_site}/prefs/medias.json

Modifie les tailles des vignettes et des mignatures générées à partir des images de la médiathèque.

Paramètres supportés par ce endpoint :

Retourne les identifiants FTP GET

/v1/sites/{code_site}/prefs/ftp.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "host": "string",
    "port": "integer",
    "login": "string",
    "password": "string"
}

Retourne la configuration du bloc marque GET

/v1/sites/{code_site}/prefs/theme.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "site_excerpt": "string",
    "is_excerpt_visible": "boolean",
    "site_description": "string",
    "is_description_visible": "boolean",
    "logo_media_id": "integer",
    "is_logo_visible": "boolean"
}

Modifie la configuration du bloc marque PUT

/v1/sites/{code_site}/prefs/theme.json

Paramètres supportés par ce endpoint :

Liste les noms de domaines GET

/v1/sites/{code_site}/domains.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:[
    {
        "domain_id": "integer",
        "is_main": "boolean",
        "is_provided": "boolean",
        "is_https_certified": "boolean",
        "name": "string"
    }
]

Ajoute un nom de domaine POST

/v1/sites/{code_site}/domains.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:[]

Modifie un nom de domaine PUT

/v1/sites/{code_site}/domains/{id}.json

Paramètres supportés par ce endpoint :

Supprime un nom de domaine DELETE

/v1/sites/{code_site}/domains/{id}.json

Paramètres supportés par ce endpoint :

Retourne les paramètres HTTPS GET

/v1/sites/{code_site}/prefs/https.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "is_enabled": "boolean",
    "status": "string",
    "domain_IP": "string"
}

Modifie les paramètres HTTPS PUT

/v1/sites/{code_site}/prefs/https.json

Paramètres supportés par ce endpoint :

Liste les balises métas par défaut GET

/v1/sites/{code_site}/seo/meta.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "meta_title": "string",
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "meta_image": {
        "id": "integer",
        "ext": "string",
        "url": "string",
        "url_g_miniature": "string",
        "url_g_vignette": "string",
        "url_miniature": "string",
        "url_vignette": "string",
        "url_public": "string"
    }
}

Modifie les balises métas par défaut PUT

/v1/sites/{code_site}/seo/meta.json

Paramètres supportés par ce endpoint :

Liste les redirections GET

/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:[
    {
        "uri": "string",
        "target": "string"
    }
]

Ajoute une redirection POST

/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

Modifie une redirection PUT

/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

Supprime une redirection DELETE

/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

Modifie les redirections PUT

/v1/sites/{code_site}/seo/redirections/bulk.json

Supprime et remplace toutes les redirections en une fois.

Paramètres supportés par ce endpoint :

Liste les traductions GET

/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:[
    {
        "msgid": "string",
        "msgstr": "string"
    }
]

Modifie une traduction PUT

/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "msgid": "string",
    "msgstr": "string"
}

Supprime les traductions DELETE

/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

Retourne le co-branding GET

/v1/cobranding.json

Récupère la configuration du co-branding pour la session en cours ou pour un site en particulier.

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "login": {
        "background": "string",
        "logo": "string"
    }
}

Liste les pays GET

/v1/geo/countries.json

Format de sortie :

data:[
    {
        "country_id": "integer",
        "name": "string",
        "code": "string",
        "group_id": "integer",
        "group_name": "string"
    }
]

Détail d'un pays GET

/v1/geo/countries/{code}.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "country_id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}

Détail d'un pays GET

/v1/geo/countries/{country_id}.json

Paramètres supportés par ce endpoint :

Format de sortie :

data:{
    "country_id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}

Cherche des codes postaux GET

/v1/geo/search.json

Retourne une liste de villes proches d'un code postal ou d'une autre ville (uniquement en France).

Paramètres supportés par ce endpoint :

Format de sortie :

data:[
    {
        "cities": "string",
        "distance": "float",
        "postal_code": "string"
    }
]