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 :

NomTypeDescription
code_siteObligatoirestringCode site
show_deprecatedbooleanInclut les thèmes dépréciés

Format de sortie :

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"
            }
        ]
    }
]
NomTypeDescription
codestringCode du theme
author_namestringAuteur du theme
author_emailstringEmail de l'auteur du theme
author_urlstringSite de l'auteur du theme
is_currentbooleanTheme courant
namestringNom du theme
stylestringStyle du theme
versionstringVersion du theme
datestringDate de publication du theme
statusstringStatut du theme
variantsFacultatifobjectVariantes
idstringCode du theme
cssstringFichier CSS
colorsListJeu de couleurs
is_enabledFacultatifbooleanVariante 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 :

NomTypeDescription
code_siteObligatoirestringCode site
codestringCode du thème de base
namestringNom du thème
versionstringVersion du thème
stylestringStyle du thème
reuse_layoutsbooleanRéutilisé
author_namestringAuteur du thème
author_urlstringSite de l'auteur du thème
author_emailstringEmail de l'auteur du thème

Format de sortie :

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"
        }
    ]
}
NomTypeDescription
codestringCode du theme
author_namestringAuteur du theme
author_emailstringEmail de l'auteur du theme
author_urlstringSite de l'auteur du theme
is_currentbooleanTheme courant
namestringNom du theme
stylestringStyle du theme
versionstringVersion du theme
datestringDate de publication du theme
statusstringStatut du theme
variantsFacultatifobjectVariantes
idstringCode du theme
cssstringFichier CSS
colorsListJeu de couleurs
is_enabledFacultatifbooleanVariante active
Détail du thème en cours GET
/v1/sites/{code_site}/themes/current.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

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"
        }
    ]
}
NomTypeDescription
codestringCode du theme
author_namestringAuteur du theme
author_emailstringEmail de l'auteur du theme
author_urlstringSite de l'auteur du theme
is_currentbooleanTheme courant
namestringNom du theme
stylestringStyle du theme
versionstringVersion du theme
datestringDate de publication du theme
statusstringStatut du theme
variantsFacultatifobjectVariantes
idstringCode du theme
cssstringFichier CSS
colorsListJeu de couleurs
is_enabledFacultatifbooleanVariante active
Change de thèmes graphique PUT
/v1/sites/{code_site}/themes/current.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
codestringCode du thème
variantstringVariante du thème

Format de sortie :

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"
        }
    ]
}
NomTypeDescription
codestringCode du theme
author_namestringAuteur du theme
author_emailstringEmail de l'auteur du theme
author_urlstringSite de l'auteur du theme
is_currentbooleanTheme courant
namestringNom du theme
stylestringStyle du theme
versionstringVersion du theme
datestringDate de publication du theme
statusstringStatut du theme
variantsFacultatifobjectVariantes
idstringCode du theme
cssstringFichier CSS
colorsListJeu de couleurs
is_enabledFacultatifbooleanVariante 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 :

NomTypeDescription
code_siteObligatoirestringCode site
pageObligatoirestringType 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 :

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": "List"
        }
    }
]
NomTypeDescription
layout_idintegerIdentifiant de la mise en page
namestringIntitulé de la mise en page
is_defaultbooleanMise en page par défaut
is_multi_layoutsbooleanAutorise les mises en pages secondaires
servicestringIntitulé du service
page_titlestringIntitulé du type de page
pagestringType de page
usage_countintegerNombre d'éléments utilisant cette mise en page
modification_datestringDate de dernière modification
modelobjectModèle
idstringIdentifiant du modèle
structureFacultatifstringStructure
nameFacultatifstringIntitulé du modèle
zonesFacultatifListStructure
Création d'une mise en page POST
/v1/sites/{code_site}/appearance/layouts/{page}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
pageObligatoirestringType 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_idintegerIdentifiant de la mise en page à copier
draft_idintegerIdentifiant d'une mise en page de travail
apply_tointegerElement 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 :

NomTypeDescription
code_siteObligatoirestringCode site
pageObligatoirestringType de page
layout_idObligatoireintegerIdentifiant de la mise en page
namestringIntitulé de la mise en page
draft_idintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
pageObligatoirestringType de page
layout_idObligatoireintegerIdentifiant 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

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
pageObligatoirestringType de page
layout_idintegerIdentifiant de la mise en page à copier
modelstringModele de mise en page
namestringNom de la mise en page

Format de sortie :

data:{
    "draft_id": "integer",
    "tree": "List",
    "name": "string",
    "model": {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": "List"
    },
    "type": {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
}
NomTypeDescription
draft_idintegerIdentifiant du draft
treeListMise en page
namestringNom de la mise en page
modelobjectModèle
idstringIdentifiant du modèle
structureFacultatifstringStructure
nameFacultatifstringIntitulé du modèle
zonesFacultatifListStructure
typeobjectType de page
servicestringIntitulé du service
shortstringIntitulé court du type
namestringIntitulé du type
pagestringIdentifiant du type
is_multi_layoutsbooleanSupporte 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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail

Format de sortie :

data:{
    "draft_id": "integer",
    "tree": "List",
    "name": "string",
    "model": {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": "List"
    },
    "type": {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
}
NomTypeDescription
draft_idintegerIdentifiant du draft
treeListMise en page
namestringNom de la mise en page
modelobjectModèle
idstringIdentifiant du modèle
structureFacultatifstringStructure
nameFacultatifstringIntitulé du modèle
zonesFacultatifListStructure
typeobjectType de page
servicestringIntitulé du service
shortstringIntitulé court du type
namestringIntitulé du type
pagestringIdentifiant du type
is_multi_layoutsbooleanSupporte 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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
modelstringModele de mise en page
namestringNom 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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
nb_colstringIdentifiant d'une mise en page de travail
Les valeurs attendues sont : 1, 2, 2g, 2d, 3
zoneObligatoirestringZone
Supprime un bloc DELETE
/v1/sites/{code_site}/appearance/builder/{draft_id}/blocs/{bloc_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
bloc_idObligatoireintegerIdentifiant d'un bloc
Place un widget POST
/v1/sites/{code_site}/appearance/builder/{draft_id}/widgets.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
cell_idObligatoireintegerIdentifiant d'une cellule
widgetObligatoirestringWidget
sibling_idintegerInsert à côté d'un widget
positionstringMode de d'insertion : avant ou après
Les valeurs attendues sont : before, after

Format de sortie :

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "desc": "string",
    "category": "string",
    "settings": "List"
}
NomTypeDescription
widget_idintegerIdentifiant du widget
typestringType du widget
namestringIntitulé du widget
descstringDescription du widget
categorystringCatégorie du widget
settingsListParamè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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
widget_idObligatoireintegerIdentifiant du widget

Format de sortie :

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "desc": "string",
    "category": "string",
    "settings": "List"
}
NomTypeDescription
widget_idintegerIdentifiant du widget
typestringType du widget
namestringIntitulé du widget
descstringDescription du widget
categorystringCatégorie du widget
settingsListParamè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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
widget_idObligatoireintegerIdentifiant du widget
cell_idObligatoireintegerDéplace dans une autre cellule
sibling_idintegerDéplace à côté d'un widget
positionstringMode de déplacement : avant ou après
Les valeurs attendues sont : before, after
settingsarrayParamètres du widget

Format de sortie :

data:{
    "widget_id": "integer",
    "type": "string",
    "name": "string",
    "desc": "string",
    "category": "string",
    "settings": "List"
}
NomTypeDescription
widget_idintegerIdentifiant du widget
typestringType du widget
namestringIntitulé du widget
descstringDescription du widget
categorystringCatégorie du widget
settingsListParamè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 :

NomTypeDescription
code_siteObligatoirestringCode site
draft_idObligatoireintegerIdentifiant d'une mise en page de travail
widget_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "id": "string",
        "structure": "string",
        "name": "string",
        "zones": "List"
    }
]
NomTypeDescription
idstringIdentifiant du modèle
structureFacultatifstringStructure
nameFacultatifstringIntitulé du modèle
zonesFacultatifListStructure
Liste les types de pages GET
/v1/sites/{code_site}/appearance/types.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "service": "string",
        "short": "string",
        "name": "string",
        "page": "string",
        "is_multi_layouts": "boolean"
    }
]
NomTypeDescription
servicestringIntitulé du service
shortstringIntitulé court du type
namestringIntitulé du type
pagestringIdentifiant du type
is_multi_layoutsbooleanSupporte 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 :

NomTypeDescription
code_siteObligatoirestringCode site
typeObligatoirestringType

Format de sortie :

data:{
    "service": "string",
    "short": "string",
    "name": "string",
    "page": "string",
    "is_multi_layouts": "boolean"
}
NomTypeDescription
servicestringIntitulé du service
shortstringIntitulé court du type
namestringIntitulé du type
pagestringIdentifiant du type
is_multi_layoutsbooleanSupporte les mises en pages secondaires
Liste les widgets GET
/v1/sites/{code_site}/appearance/widgets.json

Liste les widgets utilisable dans le type de page indiqué.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
pagestringType de page

Format de sortie :

data:[
    {
        "name": "string",
        "categories": "List"
    }
]
NomTypeDescription
namestringIntitulé du dossier
categoriesList