Thème graphique

Thèmes

Liste les thèmes GET

`/v1/sites/{code_site}/themes.json`

Liste les thèmes disponibles sur la plateforme.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`show_deprecated`		boolean	Inclut les thèmes dépréciés

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "code": "string",
        "author_name": "string",
        "author_email": "string",
        "author_url": "string",
        "is_current": "boolean",
        "name": "string",
        "style": "string",
        "version": "string",
        "date": "string",
        "status": "string",
        "variants": [
            {
                "id": "string",
                "css": "string",
                "colors": "List",
                "is_enabled": "boolean"
            }
        ]
    }
]

Nom	Type	Description
`code`	string	Code du theme
`author_name`	string	Auteur du theme
`author_email`	string	Email de l'auteur du theme
`author_url`	string	Site de l'auteur du theme
`is_current`	boolean	Theme courant
`name`	string	Nom du theme
`style`	string	Style du theme
`version`	string	Version du theme
`date`	string	Date de publication du theme
`status`	string	Statut du theme
`variants`Facultatif	object	Variantes
`id`	string	Code du theme
`css`	string	Fichier CSS
`colors`	List	Jeu de couleurs
`is_enabled`Facultatif	boolean	Variante active

Crée le thème personnalisé POST

`/v1/sites/{code_site}/themes.json`

Crée le thème personnalisé à partir d'un thème existant.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`code`		string	Code du thème de base
`name`		string	Nom du thème
`version`		string	Version du thème
`style`		string	Style du thème
`reuse_layouts`		boolean	Réutilisé
`author_name`		string	Auteur du thème
`author_url`		string	Site de l'auteur du thème
`author_email`		string	Email de l'auteur du thème

Format de sortie :

Schéma JSON
Modèle

data:{
    "code": "string",
    "author_name": "string",
    "author_email": "string",
    "author_url": "string",
    "is_current": "boolean",
    "name": "string",
    "style": "string",
    "version": "string",
    "date": "string",
    "status": "string",
    "variants": [
        {
            "id": "string",
            "css": "string",
            "colors": "List",
            "is_enabled": "boolean"
        }
    ]
}

Nom	Type	Description
`code`	string	Code du theme
`author_name`	string	Auteur du theme
`author_email`	string	Email de l'auteur du theme
`author_url`	string	Site de l'auteur du theme
`is_current`	boolean	Theme courant
`name`	string	Nom du theme
`style`	string	Style du theme
`version`	string	Version du theme
`date`	string	Date de publication du theme
`status`	string	Statut du theme
`variants`Facultatif	object	Variantes
`id`	string	Code du theme
`css`	string	Fichier CSS
`colors`	List	Jeu de couleurs
`is_enabled`Facultatif	boolean	Variante active

Détail du thème en cours GET

`/v1/sites/{code_site}/themes/current.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "code": "string",
    "author_name": "string",
    "author_email": "string",
    "author_url": "string",
    "is_current": "boolean",
    "name": "string",
    "style": "string",
    "version": "string",
    "date": "string",
    "status": "string",
    "variants": [
        {
            "id": "string",
            "css": "string",
            "colors": "List",
            "is_enabled": "boolean"
        }
    ]
}

Nom	Type	Description
`code`	string	Code du theme
`author_name`	string	Auteur du theme
`author_email`	string	Email de l'auteur du theme
`author_url`	string	Site de l'auteur du theme
`is_current`	boolean	Theme courant
`name`	string	Nom du theme
`style`	string	Style du theme
`version`	string	Version du theme
`date`	string	Date de publication du theme
`status`	string	Statut du theme
`variants`Facultatif	object	Variantes
`id`	string	Code du theme
`css`	string	Fichier CSS
`colors`	List	Jeu de couleurs
`is_enabled`Facultatif	boolean	Variante active

Change de thèmes graphique PUT

`/v1/sites/{code_site}/themes/current.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`code`		string	Code du thème
`variant`		string	Variante du thème

Format de sortie :

Schéma JSON
Modèle

data:{
    "code": "string",
    "author_name": "string",
    "author_email": "string",
    "author_url": "string",
    "is_current": "boolean",
    "name": "string",
    "style": "string",
    "version": "string",
    "date": "string",
    "status": "string",
    "variants": [
        {
            "id": "string",
            "css": "string",
            "colors": "List",
            "is_enabled": "boolean"
        }
    ]
}

Nom	Type	Description
`code`	string	Code du theme
`author_name`	string	Auteur du theme
`author_email`	string	Email de l'auteur du theme
`author_url`	string	Site de l'auteur du theme
`is_current`	boolean	Theme courant
`name`	string	Nom du theme
`style`	string	Style du theme
`version`	string	Version du theme
`date`	string	Date de publication du theme
`status`	string	Statut du theme
`variants`Facultatif	object	Variantes
`id`	string	Code du theme
`css`	string	Fichier CSS
`colors`	List	Jeu de couleurs
`is_enabled`Facultatif	boolean	Variante active

Ensembles de mises en page

Liste les mises en page GET

`/v1/sites/{code_site}/appearance/layouts.json`

Liste les mises en page du theme courant

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`	Obligatoire	string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "layout_id": "integer",
        "name": "string",
        "is_default": "boolean",
        "is_multi_layouts": "boolean",
        "service": "string",
        "page_title": "string",
        "page": "string",
        "usage_count": "integer",
        "modification_date": "string",
        "model": {
            "id": "string",
            "structure": "string",
            "name": "string",
            "zones": [
                {
                    "id": "string",
                    "name": "string",
                    "colmax": "integer",
                    "defaut": "string",
                    "is_content": "boolean"
                }
            ]
        }
    }
]

Nom	Type	Description
`layout_id`	integer	Identifiant de la mise en page
`name`	string	Intitulé de la mise en page
`is_default`	boolean	Mise en page par défaut
`is_multi_layouts`	boolean	Autorise les mises en pages secondaires
`service`	string	Intitulé du service
`page_title`	string	Intitulé du type de page
`page`	string	Type de page
`usage_count`	integer	Nombre d'éléments utilisant cette mise en page
`modification_date`	string	Date de dernière modification
`model`	object	Modèle
`id`	string	Identifiant du modèle
`structure`Facultatif	string	Structure
`name`Facultatif	string	Intitulé du modèle
`zones`Facultatif	object	Liste des zones
`id`	string	Identifiant de la zone
`name`	string	Intitulé de la zone
`colmax`Facultatif	integer	Nombre maximal de colonnes
`defaut`Facultatif	string	Colonnage par défaut. Les valeurs possibles sont : 1, 2, 2g, 2d, 3
`is_content`Facultatif	boolean	Zone de contenu

Création d'une mise en page POST

`/v1/sites/{code_site}/appearance/layouts/{page}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`	Obligatoire	string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation
`layout_id`		integer	Identifiant de la mise en page à copier
`draft_id`		integer	Identifiant d'une mise en page de travail
`apply_to`		integer	Element auquel appliquer la nouvelle mise en page

Mise à jour d'une mise en page PUT

`/v1/sites/{code_site}/appearance/layouts/{page}/{layout_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`	Obligatoire	string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation, symbol
`layout_id`	Obligatoire	integer	Identifiant de la mise en page
`name`		string	Intitulé de la mise en page
`draft_id`		integer	Identifiant d'une mise en page de travail

Suppression une mise en page DELETE

`/v1/sites/{code_site}/appearance/layouts/{page}/{layout_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`	Obligatoire	string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation
`layout_id`	Obligatoire	integer	Identifiant de la mise en page

Création de mise en page

Création d'une mise en page de travail POST

`/v1/sites/{code_site}/appearance/builder.json`

La création d'une mise en page de travail pour symbole nécessite la gestion des composants.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`	Obligatoire	string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation, symbol
`layout_id`		integer	Identifiant de la mise en page à copier
`model`		string	Modele de mise en page
`name`		string	Nom de la mise en page

Format de sortie :

Schéma JSON
Modèle

data:{
    "draft_id": "integer",
    "tree": "List",
    "name": "string",
    "model": {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": [
            {
                "id": "string",
                "name": "string",
                "colmax": "integer",
                "defaut": "string",
                "is_content": "boolean"
            }
        ]
    },
    "type": {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
}

Nom	Type	Description
`draft_id`	integer	Identifiant du draft
`tree`	List	Mise en page
`name`	string	Nom de la mise en page
`model`	object	Modèle
`id`	string	Identifiant du modèle
`structure`Facultatif	string	Structure
`name`Facultatif	string	Intitulé du modèle
`zones`Facultatif	object	Liste des zones
`id`	string	Identifiant de la zone
`name`	string	Intitulé de la zone
`colmax`Facultatif	integer	Nombre maximal de colonnes
`defaut`Facultatif	string	Colonnage par défaut. Les valeurs possibles sont : 1, 2, 2g, 2d, 3
`is_content`Facultatif	boolean	Zone de contenu
`type`	object	Type de page
`service`	string	Intitulé du service
`short`	string	Intitulé court du type
`name`	string	Intitulé du type
`page`	string	Identifiant du type
`is_multi_layouts`	boolean	Supporte les mises en pages secondaires

Détail d'une mise en page de travail GET

`/v1/sites/{code_site}/appearance/builder/{draft_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail

Format de sortie :

Schéma JSON
Modèle

data:{
    "draft_id": "integer",
    "tree": "List",
    "name": "string",
    "model": {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": [
            {
                "id": "string",
                "name": "string",
                "colmax": "integer",
                "defaut": "string",
                "is_content": "boolean"
            }
        ]
    },
    "type": {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
}

Nom	Type	Description
`draft_id`	integer	Identifiant du draft
`tree`	List	Mise en page
`name`	string	Nom de la mise en page
`model`	object	Modèle
`id`	string	Identifiant du modèle
`structure`Facultatif	string	Structure
`name`Facultatif	string	Intitulé du modèle
`zones`Facultatif	object	Liste des zones
`id`	string	Identifiant de la zone
`name`	string	Intitulé de la zone
`colmax`Facultatif	integer	Nombre maximal de colonnes
`defaut`Facultatif	string	Colonnage par défaut. Les valeurs possibles sont : 1, 2, 2g, 2d, 3
`is_content`Facultatif	boolean	Zone de contenu
`type`	object	Type de page
`service`	string	Intitulé du service
`short`	string	Intitulé court du type
`name`	string	Intitulé du type
`page`	string	Identifiant du type
`is_multi_layouts`	boolean	Supporte les mises en pages secondaires

Modifie une mise en page de travail PUT

`/v1/sites/{code_site}/appearance/builder/{draft_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`model`		string	Modele de mise en page
`name`		string	Nom de la mise en page

Supprime une mise en page de travail DELETE

`/v1/sites/{code_site}/appearance/builder/{draft_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail

Ajoute un bloc POST

`/v1/sites/{code_site}/appearance/builder/{draft_id}/blocs.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`nb_col`		string	Identifiant d'une mise en page de travail Les valeurs attendues sont : 1, 2, 2g, 2d, 3
`zone`	Obligatoire	string	Zone

Supprime un bloc DELETE

`/v1/sites/{code_site}/appearance/builder/{draft_id}/blocs/{bloc_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`bloc_id`	Obligatoire	integer	Identifiant d'un bloc

Place un widget POST

`/v1/sites/{code_site}/appearance/builder/{draft_id}/widgets.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`cell_id`	Obligatoire	integer	Identifiant d'une cellule
`widget`	Obligatoire	string	Type de widget
`sibling_id`		integer	Insert à côté d'un widget
`position`		string	Mode de d'insertion : avant ou après Les valeurs attendues sont : before, after

Format de sortie :

Schéma JSON
Modèle

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "is_enabled": "boolean",
    "desc": "string",
    "category": "string",
    "settings": "List"
}

Nom	Type	Description
`widget_id`	integer	Identifiant du widget
`type`	string	Type du widget
`name`	string	Intitulé du widget
`is_enabled`	boolean	Affichage du widget
`desc`	string	Description du widget
`category`	string	Catégorie du widget
`settings`	List	Paramètres du widdget

Détail d'un widget GET

`/v1/sites/{code_site}/appearance/builder/{draft_id}/widgets/{widget_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`widget_id`	Obligatoire	integer	Identifiant du widget

Format de sortie :

Schéma JSON
Modèle

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "is_enabled": "boolean",
    "desc": "string",
    "category": "string",
    "settings": "List"
}

Nom	Type	Description
`widget_id`	integer	Identifiant du widget
`type`	string	Type du widget
`name`	string	Intitulé du widget
`is_enabled`	boolean	Affichage du widget
`desc`	string	Description du widget
`category`	string	Catégorie du widget
`settings`	List	Paramètres du widdget

Modifie un widget PUT

`/v1/sites/{code_site}/appearance/builder/{draft_id}/widgets/{widget_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`widget_id`	Obligatoire	integer	Identifiant du widget
`cell_id`		integer	Déplace dans une autre cellule
`sibling_id`		integer	Déplace à côté d'un widget
`position`		string	Mode de déplacement : avant ou après Les valeurs attendues sont : before, after
`settings`		array	Paramètres du widget
`is_enabled`		boolean	Widget actif

Format de sortie :

Schéma JSON
Modèle

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "is_enabled": "boolean",
    "desc": "string",
    "category": "string",
    "settings": "List"
}

Nom	Type	Description
`widget_id`	integer	Identifiant du widget
`type`	string	Type du widget
`name`	string	Intitulé du widget
`is_enabled`	boolean	Affichage du widget
`desc`	string	Description du widget
`category`	string	Catégorie du widget
`settings`	List	Paramètres du widdget

Supprime un widget DELETE

`/v1/sites/{code_site}/appearance/builder/{draft_id}/widgets/{widget_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`draft_id`	Obligatoire	integer	Identifiant d'une mise en page de travail
`widget_id`	Obligatoire	integer	Identifiant du widget

Divers

Liste les modèles GET

`/v1/sites/{code_site}/appearance/models.json`

Liste les modèles de templates du thème graphique courant.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": [
            {
                "id": "string",
                "name": "string",
                "colmax": "integer",
                "defaut": "string",
                "is_content": "boolean"
            }
        ]
    }
]

Nom	Type	Description
`id`	string	Identifiant du modèle
`structure`Facultatif	string	Structure
`name`Facultatif	string	Intitulé du modèle
`zones`Facultatif	object	Liste des zones
`id`	string	Identifiant de la zone
`name`	string	Intitulé de la zone
`colmax`Facultatif	integer	Nombre maximal de colonnes
`defaut`Facultatif	string	Colonnage par défaut. Les valeurs possibles sont : 1, 2, 2g, 2d, 3
`is_content`Facultatif	boolean	Zone de contenu

Liste les types de pages GET

`/v1/sites/{code_site}/appearance/types.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
]

Nom	Type	Description
`service`	string	Intitulé du service
`short`	string	Intitulé court du type
`name`	string	Intitulé du type
`page`	string	Identifiant du type
`is_multi_layouts`	boolean	Supporte les mises en pages secondaires

Détail d'un type de pages GET

`/v1/sites/{code_site}/appearance/types/{type}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`type`	Obligatoire	string	Type Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation

Format de sortie :

Schéma JSON
Modèle

data:{
    "service": "string",
    "short": "string",
    "name": "string",
    "page": "string",
    "is_multi_layouts": "boolean"
}

Nom	Type	Description
`service`	string	Intitulé du service
`short`	string	Intitulé court du type
`name`	string	Intitulé du type
`page`	string	Identifiant du type
`is_multi_layouts`	boolean	Supporte les mises en pages secondaires

Liste les widgets GET

`/v1/sites/{code_site}/appearance/widgets.json`

Liste les widgets utilisables dans le type de page indiqué. Les widgets "Contenu" et "Symbole" nécessites la gestion des composants.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`page`		string	Type de page Les valeurs attendues sont : cms-home, cms-page, contact-form, blog-category, blog-post, account-login, account-signup, account-customer, catalog-home, catalog-category, catalog-product, search-blog, search-catalog, search-cms, checkout-basket, checkout-delivery, checkout-payment, checkout-validation, symbol

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "name": "string",
        "categories": "List"
    }
]

Nom	Type	Description
`name`	string	Intitulé du dossier
`categories`	List