Catalogue

Résumé

Résumé du catalogue GET

`/v1/sites/{code_site}/catalog.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:{
    "products_count": "integer"
}

Nom	Type	Description
`products_count`	integer	Nombre total de produits

Catégories

Liste les catégories GET

`/v1/sites/{code_site}/catalog/categories.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`term`		string	Recherche par libellé
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "category_id": "integer",
        "name": "string",
        "description": "string",
        "media_id": "integer",
        "thumb": {
            "id": "integer",
            "ext": "string",
            "url": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string",
            "url_miniature": "string",
            "url_vignette": "string",
            "url_public": "string"
        },
        "is_visible": "boolean",
        "is_main": "boolean",
        "slug": "string",
        "product_count": "integer",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "meta_title": "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"
        },
        "meta_description": "string",
        "meta_keywords": "string",
        "js_head": "string",
        "js_body": "string",
        "layout_id": "integer",
        "service_path": "string"
    }
]

Nom	Type	Description
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`description`	string	Description de la catégorie
`media_id`Facultatif	integer	Identifiant de l'image
`thumb`Facultatif	object
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`is_visible`	boolean	Affichage dans le menu
`is_main`	boolean	Catégorie principale
`slug`	string	Nom optimisé
`product_count`	integer	Nombre de produits
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`service_path`Facultatif	string	Chemin du service Catalogue

Ajoute une catégorie POST

`/v1/sites/{code_site}/catalog/categories.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`		string	Intitulé de la catégorie
`slug`		string	Nom optimisé de la catégorie
`is_visible`		boolean	Affiche la catégorie dans le menu
`media_id`		integer	Identifiant de l'illustration de la catégorie
`description`		string	Description de la catégorie
`meta_title`		string	Balise meta title
`meta_image`		integer	Balise meta image
`meta_description`		string	Balise meta description
`meta_keywords`		string	Balise meta keywords
`js_head`		string	Code avant la balise </head> de la page
`js_body`		string	Code avant la balise </body> de la page
`layout_id`		integer	Identifiant de la mise en page de la catégorie
`after_id`		integer	Positionne la catégorie après celle ayant cet identifiant
`before_id`		integer	Positionne la catégorie avant celle ayant cet identifiant. Si la valeur vaut 0 la catégorie sera placé au début de la liste

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime un lot de catégories DELETE

`/v1/sites/{code_site}/catalog/categories.json`

Permet de regrouper la suppression de jusqu'à 100 catégories du catalogue en un seul appel à l'API. À noter cependant que la catalogue doit toujours contenir au moins une catégorie.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`categories`		array	Identifiants de catégories (max:100)

Détail d'une catégorie GET

`/v1/sites/{code_site}/catalog/categories/{category_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

category_id Obligatoire integer Identifiant de la catégorie

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

defaults

Referencement par défaut

Format de sortie :

Schéma JSON
Modèle

data:{
    "category_id": "integer",
    "name": "string",
    "description": "string",
    "media_id": "integer",
    "thumb": {
        "id": "integer",
        "ext": "string",
        "url": "string",
        "url_g_miniature": "string",
        "url_g_vignette": "string",
        "url_miniature": "string",
        "url_vignette": "string",
        "url_public": "string"
    },
    "is_visible": "boolean",
    "is_main": "boolean",
    "slug": "string",
    "product_count": "integer",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "service_path": "string"
}

Nom	Type	Description
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`description`	string	Description de la catégorie
`media_id`Facultatif	integer	Identifiant de l'image
`thumb`Facultatif	object
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`is_visible`	boolean	Affichage dans le menu
`is_main`	boolean	Catégorie principale
`slug`	string	Nom optimisé
`product_count`	integer	Nombre de produits
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`service_path`Facultatif	string	Chemin du service Catalogue

Modifie une catégorie PUT

`/v1/sites/{code_site}/catalog/categories/{category_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`category_id`	Obligatoire	integer	Identifiant de la catégorie
`name`		string	Intitulé de la catégorie
`slug`		string	Nom optimisé de la catégorie
`is_visible`		boolean	Affiche la catégorie dans le menu
`media_id`		integer	Identifiant de l'illustration de la catégorie
`description`		string	Description de la catégorie
`meta_title`		string	Balise meta title
`meta_image`		integer	Balise meta image
`meta_description`		string	Balise meta description
`meta_keywords`		string	Balise meta keywords
`js_head`		string	Code avant la balise </head> de la page
`js_body`		string	Code avant la balise </body> de la page
`layout_id`		integer	Identifiant de la mise en page de la catégorie
`after_id`		integer	Positionne la catégorie après celle ayant cet identifiant
`before_id`		integer	Positionne la catégorie avant celle ayant cet identifiant. Si la valeur vaut 0 la catégorie sera placé au début de la liste

Format de sortie :

Schéma JSON
Modèle

data:{
    "category_id": "integer",
    "name": "string",
    "description": "string",
    "media_id": "integer",
    "thumb": {
        "id": "integer",
        "ext": "string",
        "url": "string",
        "url_g_miniature": "string",
        "url_g_vignette": "string",
        "url_miniature": "string",
        "url_vignette": "string",
        "url_public": "string"
    },
    "is_visible": "boolean",
    "is_main": "boolean",
    "slug": "string",
    "product_count": "integer",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "service_path": "string"
}

Nom	Type	Description
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`description`	string	Description de la catégorie
`media_id`Facultatif	integer	Identifiant de l'image
`thumb`Facultatif	object
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`is_visible`	boolean	Affichage dans le menu
`is_main`	boolean	Catégorie principale
`slug`	string	Nom optimisé
`product_count`	integer	Nombre de produits
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`service_path`Facultatif	string	Chemin du service Catalogue

Supprime une catégorie DELETE

`/v1/sites/{code_site}/catalog/categories/{category_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`category_id`	Obligatoire	integer	Identifiant de la catégorie

Détail de la page d'accueil du catalogue GET

`/v1/sites/{code_site}/catalog/home.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

defaults

Referencement par défaut

Format de sortie :

Schéma JSON
Modèle

data:{
    "name": "string",
    "is_visible": "boolean",
    "modification_date": "string",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "service_path": "string"
}

Nom	Type	Description
`name`	string	Intitulé de la catégorie
`is_visible`	boolean	Affichage dans le menu
`modification_date`Facultatif	string	Date de dernière modification
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`service_path`Facultatif	string	Chemin du service Catalogue

Modifie la page d'accueil du catalogue PUT

`/v1/sites/{code_site}/catalog/home.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`		string	Intitulé de la catégorie
`is_visible`		boolean	Affiche la catégorie dans le menu
`description`		string	Description de la catégorie
`meta_title`		string	Balise meta title
`meta_image`		integer	Balise meta image
`meta_description`		string	Balise meta description
`meta_keywords`		string	Balise meta keywords
`js_head`		string	Code avant la balise </head> de la page
`js_body`		string	Code avant la balise </body> de la page
`layout_id`		integer	Identifiant de la mise en page de la catégorie

Format de sortie :

Schéma JSON
Modèle

data:{
    "name": "string",
    "is_visible": "boolean",
    "modification_date": "string",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "service_path": "string"
}

Nom	Type	Description
`name`	string	Intitulé de la catégorie
`is_visible`	boolean	Affichage dans le menu
`modification_date`Facultatif	string	Date de dernière modification
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`service_path`Facultatif	string	Chemin du service Catalogue

Produits

Liste les produits d'une catégorie GET

`/v1/sites/{code_site}/catalog/categories/{category_id}/products.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

category_id Obligatoire integer Identifiant de la catégorie

tag_id string Identifiant du tag

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 60)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

name / -name	Tri selon l'intitulé du produit
price_min / -price_min	Tri selon le prix minimal du produit
price_max / -price_max	Tri selon le prix maximal du produit
modification / -modification	Tri selon la date de modification du produit

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "product_id": "integer",
        "is_spotlight": "boolean",
        "available_date": "string",
        "available_date_f": "string",
        "is_visible": "boolean",
        "stock": "string",
        "view_count": "integer",
        "is_virtual": "boolean",
        "brand_id": "integer",
        "brand_name": "string",
        "price_ex_vat_min": "float",
        "price_ex_vat_max": "float",
        "price_inc_vat_min": "float",
        "price_inc_vat_max": "float",
        "price_ex_vat_min_label": "string",
        "price_ex_vat_max_label": "string",
        "price_inc_vat_min_label": "string",
        "price_inc_vat_max_label": "string",
        "extra_shipping": "float",
        "comments_count": "integer",
        "rate": "float",
        "bought_count": "integer",
        "variants_count": "integer",
        "soldout_count": "integer",
        "refill_count": "integer",
        "refill_tracking": "boolean",
        "is_discount": "boolean",
        "price_base_ex_vat": "float",
        "price_base_inc_vat": "float",
        "price_base_ex_vat_label": "string",
        "price_base_inc_vat_label": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "name": "string",
        "description": "string",
        "header": "string",
        "type": "string",
        "main_media_id": "integer",
        "slug": "string",
        "meta_title": "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"
        },
        "meta_description": "string",
        "meta_keywords": "string",
        "js_head": "string",
        "js_body": "string",
        "layout_id": "integer",
        "text1": "string",
        "text2": "string",
        "text3": "string",
        "text4": "string",
        "text5": "string",
        "text6": "string",
        "text7": "string",
        "text8": "string",
        "text9": "string",
        "text10": "string",
        "text11": "string",
        "text12": "string",
        "text13": "string",
        "text14": "string",
        "text15": "string",
        "tags": [
            {
                "tag_id": "integer",
                "name": "string"
            }
        ],
        "categories": [
            {
                "category_id": "integer",
                "name": "string",
                "is_main": "boolean"
            }
        ],
        "variants": [
            {
                "variant_id": "integer",
                "name": "string",
                "reference": "string",
                "gtin": "string",
                "condition": "string",
                "weight": "integer",
                "tax_id": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_discount_ex_vat": "float",
                "price_discount_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_discount_ex_vat_label": "string",
                "price_discount_inc_vat_label": "string",
                "price_ecotax": "float",
                "price_ecotax_label": "string",
                "is_stock_unlimited": "boolean",
                "stock": "integer",
                "position": "integer",
                "media_id": "integer",
                "file_id": "integer",
                "creation_date": "string",
                "modification_date": "string"
            }
        ],
        "images": [
            {
                "media_id": "integer",
                "position": "integer",
                "name": "string",
                "original_name": "string"
            }
        ],
        "service_path": "string",
        "tier_prices_id": "integer",
        "tier_prices_name": "string"
    }
]

Nom	Type	Description
`product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`available_date_f`	string	Date de disponibilité formatée
`is_visible`	boolean	Produit affiché sur le site
`stock`	string	Produit en stock. Les valeurs possibles sont : yes, no, partial
`view_count`	integer	Nombre de vus
`is_virtual`	boolean	Produit virtuel
`brand_id`Facultatif	integer	Identifiant de la marque
`brand_name`Facultatif	string	Intitulé de la marque
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`extra_shipping`Facultatif	float	Frais de port supplémentaire
`comments_count`	integer	Nombre de commentaires
`rate`	float	Note du produit
`bought_count`	integer	Nombre d'achat
`variants_count`	integer	Nombre de variantes
`soldout_count`	integer	Nombre de variantes en rupture
`refill_count`	integer	Nombre de variantes à réapprovisionner
`refill_tracking`	boolean	Suivi du réapprovisionnement
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`name`	string	Intitulé du produit
`description`	string	Description du produit
`header`	string	Entête du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ texte15
`tags`Facultatif	object
`tag_id`	integer	Identifiant du tag
`name`	string	Intitulé du tag
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`variants`Facultatif	object	Variantes
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`images`Facultatif	object	Illustrations
`media_id`	integer	Identifiant du média
`position`	integer	Position du média dans la liste
`name`	string	Intitulé du média
`original_name`	string	Nom d'origine du fichier
`service_path`Facultatif	string	Chemin du service Catalogue
`tier_prices_id`Facultatif	integer	Identifiant de la grille de tarifs dégressifs
`tier_prices_name`Facultatif	string	Nom de la grille de tarifs dégressifs

Liste les produits GET

`/v1/sites/{code_site}/catalog/products.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

category_id integer Identifiant de la catégorie

tag_id integer Identifiant du tag

term string Recherche par libellé

brand_id integer Identifiant de la marque

price_min float Prix minimum

price_max float Prix maximum

stock

string

Produits en stock parmis les valeurs suivantes :

yes	Toutes les variantes sont en stock
low	au moins une variante à réapprovisionner
no	Aucune variante n'est en stock
partial	Au moins une variante est en stock

Les valeurs attendues sont : yes, no, partial, low

refill_tracking boolean Suivi du réapprovisionnement

available_date_min string Disponible après cette date

available_date_max string Disponible avant cette date

is_visible boolean Affiché sur le site

is_spotlight boolean Produit vedette

type string Type de produit

variant_name string Intitulé de la variante

variant_condition

string

Etat de la variante parmis les valeurs suivantes :

new	Neuf
used	Occasion
refurbished	Reconditionné

Les valeurs attendues sont : new, used, refurbished

variant_gtin string EAN de la variante

variant_reference string Référence de la variante

linked_count_min integer Avec un minimum de produits associés

linked_count_max integer Avec un maximum de produits associés

rate_min float Avec une note minimum

rate_max float Avec une note maximum

comments_min integer Avec un minimum de commentaires

comments_max integer Avec un maximum de commantaires

weight_min integer Avec un poids minimum (en grammes)

weight_max integer Avec un poids maximum (en grammes)

tier_prices_id integer Grille de tarifs dégressifs

slug string Nom optimisé

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 60)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

name / -name	Tri selon l'intitulé du produit
price_min / -price_min	Tri selon le prix minimal du produit
price_max / -price_max	Tri selon le prix maximal du produit
modification / -modification	Tri selon la date de modification du produit

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

texts	Champs texte1 à texte15
tags	Liste des tags
categories	Liste des catégories
variants	Variantes
price_label	Prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "product_id": "integer",
        "is_spotlight": "boolean",
        "available_date": "string",
        "available_date_f": "string",
        "is_visible": "boolean",
        "stock": "string",
        "view_count": "integer",
        "is_virtual": "boolean",
        "brand_id": "integer",
        "brand_name": "string",
        "price_ex_vat_min": "float",
        "price_ex_vat_max": "float",
        "price_inc_vat_min": "float",
        "price_inc_vat_max": "float",
        "price_ex_vat_min_label": "string",
        "price_ex_vat_max_label": "string",
        "price_inc_vat_min_label": "string",
        "price_inc_vat_max_label": "string",
        "extra_shipping": "float",
        "comments_count": "integer",
        "rate": "float",
        "bought_count": "integer",
        "variants_count": "integer",
        "soldout_count": "integer",
        "refill_count": "integer",
        "refill_tracking": "boolean",
        "is_discount": "boolean",
        "price_base_ex_vat": "float",
        "price_base_inc_vat": "float",
        "price_base_ex_vat_label": "string",
        "price_base_inc_vat_label": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "name": "string",
        "description": "string",
        "header": "string",
        "type": "string",
        "main_media_id": "integer",
        "slug": "string",
        "meta_title": "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"
        },
        "meta_description": "string",
        "meta_keywords": "string",
        "js_head": "string",
        "js_body": "string",
        "layout_id": "integer",
        "text1": "string",
        "text2": "string",
        "text3": "string",
        "text4": "string",
        "text5": "string",
        "text6": "string",
        "text7": "string",
        "text8": "string",
        "text9": "string",
        "text10": "string",
        "text11": "string",
        "text12": "string",
        "text13": "string",
        "text14": "string",
        "text15": "string",
        "tags": [
            {
                "tag_id": "integer",
                "name": "string"
            }
        ],
        "categories": [
            {
                "category_id": "integer",
                "name": "string",
                "is_main": "boolean"
            }
        ],
        "variants": [
            {
                "variant_id": "integer",
                "name": "string",
                "reference": "string",
                "gtin": "string",
                "condition": "string",
                "weight": "integer",
                "tax_id": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_discount_ex_vat": "float",
                "price_discount_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_discount_ex_vat_label": "string",
                "price_discount_inc_vat_label": "string",
                "price_ecotax": "float",
                "price_ecotax_label": "string",
                "is_stock_unlimited": "boolean",
                "stock": "integer",
                "position": "integer",
                "media_id": "integer",
                "file_id": "integer",
                "creation_date": "string",
                "modification_date": "string"
            }
        ],
        "images": [
            {
                "media_id": "integer",
                "position": "integer",
                "name": "string",
                "original_name": "string"
            }
        ],
        "service_path": "string",
        "tier_prices_id": "integer",
        "tier_prices_name": "string"
    }
]

Nom	Type	Description
`product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`available_date_f`	string	Date de disponibilité formatée
`is_visible`	boolean	Produit affiché sur le site
`stock`	string	Produit en stock. Les valeurs possibles sont : yes, no, partial
`view_count`	integer	Nombre de vus
`is_virtual`	boolean	Produit virtuel
`brand_id`Facultatif	integer	Identifiant de la marque
`brand_name`Facultatif	string	Intitulé de la marque
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`extra_shipping`Facultatif	float	Frais de port supplémentaire
`comments_count`	integer	Nombre de commentaires
`rate`	float	Note du produit
`bought_count`	integer	Nombre d'achat
`variants_count`	integer	Nombre de variantes
`soldout_count`	integer	Nombre de variantes en rupture
`refill_count`	integer	Nombre de variantes à réapprovisionner
`refill_tracking`	boolean	Suivi du réapprovisionnement
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`name`	string	Intitulé du produit
`description`	string	Description du produit
`header`	string	Entête du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ texte15
`tags`Facultatif	object
`tag_id`	integer	Identifiant du tag
`name`	string	Intitulé du tag
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`variants`Facultatif	object	Variantes
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`images`Facultatif	object	Illustrations
`media_id`	integer	Identifiant du média
`position`	integer	Position du média dans la liste
`name`	string	Intitulé du média
`original_name`	string	Nom d'origine du fichier
`service_path`Facultatif	string	Chemin du service Catalogue
`tier_prices_id`Facultatif	integer	Identifiant de la grille de tarifs dégressifs
`tier_prices_name`Facultatif	string	Nom de la grille de tarifs dégressifs

Crée un produit POST

`/v1/sites/{code_site}/catalog/products.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`type`	Obligatoire	string	Type de produit
`name`		string	Intitulé du produit
`is_visible`		boolean	Affichage du produit
`is_virtual`		boolean	Produit virtuel
`is_spotlight`		boolean	Produit vedette
`available_date`		string	Date de disponibilité
`categories`		array	Liste des identifiants des catégories du produit, le premier identifiant correspond à la catégorie principale
`brand_id`		integer	Identifiant de la marque
`header`		string	Chapô du produit
`description`		string	Description du produit
`extra_shipping`		float	Frais de port supplémentaire
`refill_tracking`		float	Suivi du réapprovisionnement
`text1`		string	Champ texte1 produit
`text2`		string	Champ texte2 produit
`text3`		string	Champ texte3 produit
`text4`		string	Champ texte4 produit
`text5`		string	Champ texte5 produit
`text6`		string	Champ texte6 produit
`text7`		string	Champ texte7 produit
`text8`		string	Champ texte8 produit
`text9`		string	Champ texte9 produit
`text10`		string	Champ texte10 produit
`text11`		string	Champ texte11 produit
`text12`		string	Champ texte12 produit
`text13`		string	Champ texte13 produit
`text14`		string	Champ texte14 produit
`text15`		string	Champ texte15 produit
`media_id`		array	Liste d'identifiants des médias du produit, le premier identifiant correspond à l'image principale
`tags`		array	Liste des tags du produit
`tags_id`		array	Liste des identifiants des tags du produit
`slug`		string	Nom optimisé du produit
`meta_title`		string	Balise meta title
`meta_description`		string	Balise meta description
`meta_keywords`		string	Balise meta keywords
`js_head`		string	Code avant la balise </head> de la page
`js_body`		string	Code avant la balise </body> de la page
`layout_id`		integer	Identifiant de la mise en page du produit
`tax_id`		integer	Identifiant de la taxe de la variante
`price_ex_vat`		float	Prix HT de la variante
`price_inc_vat`		float	Prix TTC de la variante
`price_discount_ex_vat`		float	Prix promo HT de la variante
`price_discount_inc_vat`		float	Prix promo TTC de la variante
`price_ecotax`		float	Eco-taxe de la variante
`stock`		integer	Nombre de produit en stock. Ne pas spécifier le champ pour définir un stock illimité
`weight`		integer	Poids en gramme de la variante
`reference`		string	Référence de la variante
`gtin`		string	Code EAN de la variante
`condition`		string	Etat de la variante
`variant_media_id`		integer	Identifiant du média de la variante
`variant_name`		string	Intitulé de la variante
`file_id`		integer	Identifiant du fichier à télécharger de la variante

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime un lot de produits DELETE

`/v1/sites/{code_site}/catalog/products.json`

Permet de regrouper la suppression de jusqu'à 100 produits du catalogue en un seul appel à l'API.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`products`		array	Identifiants de produits (max:100)

Détail d'un produit GET

`/v1/sites/{code_site}/catalog/products/{product_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

product_id Obligatoire integer Identifiant du produit

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

variants	Variantes du produit
texts	Champs texte1 à texte15
price_label	Prix dans la devise du site
images	Illustrations du produit
defaults	Valeurs par défaut du référencement
tier_prices	Tarifs dégressifs

Format de sortie :

Schéma JSON
Modèle

data:{
    "product_id": "integer",
    "is_spotlight": "boolean",
    "available_date": "string",
    "available_date_f": "string",
    "is_visible": "boolean",
    "stock": "string",
    "view_count": "integer",
    "is_virtual": "boolean",
    "brand_id": "integer",
    "brand_name": "string",
    "price_ex_vat_min": "float",
    "price_ex_vat_max": "float",
    "price_inc_vat_min": "float",
    "price_inc_vat_max": "float",
    "price_ex_vat_min_label": "string",
    "price_ex_vat_max_label": "string",
    "price_inc_vat_min_label": "string",
    "price_inc_vat_max_label": "string",
    "extra_shipping": "float",
    "comments_count": "integer",
    "rate": "float",
    "bought_count": "integer",
    "variants_count": "integer",
    "soldout_count": "integer",
    "refill_count": "integer",
    "refill_tracking": "boolean",
    "is_discount": "boolean",
    "price_base_ex_vat": "float",
    "price_base_inc_vat": "float",
    "price_base_ex_vat_label": "string",
    "price_base_inc_vat_label": "string",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "name": "string",
    "description": "string",
    "header": "string",
    "type": "string",
    "main_media_id": "integer",
    "slug": "string",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "text1": "string",
    "text2": "string",
    "text3": "string",
    "text4": "string",
    "text5": "string",
    "text6": "string",
    "text7": "string",
    "text8": "string",
    "text9": "string",
    "text10": "string",
    "text11": "string",
    "text12": "string",
    "text13": "string",
    "text14": "string",
    "text15": "string",
    "tags": [
        {
            "tag_id": "integer",
            "name": "string"
        }
    ],
    "categories": [
        {
            "category_id": "integer",
            "name": "string",
            "is_main": "boolean"
        }
    ],
    "variants": [
        {
            "variant_id": "integer",
            "name": "string",
            "reference": "string",
            "gtin": "string",
            "condition": "string",
            "weight": "integer",
            "tax_id": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_discount_ex_vat": "float",
            "price_discount_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_discount_ex_vat_label": "string",
            "price_discount_inc_vat_label": "string",
            "price_ecotax": "float",
            "price_ecotax_label": "string",
            "is_stock_unlimited": "boolean",
            "stock": "integer",
            "position": "integer",
            "media_id": "integer",
            "file_id": "integer",
            "creation_date": "string",
            "modification_date": "string"
        }
    ],
    "images": [
        {
            "media_id": "integer",
            "position": "integer",
            "name": "string",
            "original_name": "string"
        }
    ],
    "service_path": "string",
    "tier_prices_id": "integer",
    "tier_prices_name": "string"
}

Nom	Type	Description
`product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`available_date_f`	string	Date de disponibilité formatée
`is_visible`	boolean	Produit affiché sur le site
`stock`	string	Produit en stock. Les valeurs possibles sont : yes, no, partial
`view_count`	integer	Nombre de vus
`is_virtual`	boolean	Produit virtuel
`brand_id`Facultatif	integer	Identifiant de la marque
`brand_name`Facultatif	string	Intitulé de la marque
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`extra_shipping`Facultatif	float	Frais de port supplémentaire
`comments_count`	integer	Nombre de commentaires
`rate`	float	Note du produit
`bought_count`	integer	Nombre d'achat
`variants_count`	integer	Nombre de variantes
`soldout_count`	integer	Nombre de variantes en rupture
`refill_count`	integer	Nombre de variantes à réapprovisionner
`refill_tracking`	boolean	Suivi du réapprovisionnement
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`name`	string	Intitulé du produit
`description`	string	Description du produit
`header`	string	Entête du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ texte15
`tags`Facultatif	object
`tag_id`	integer	Identifiant du tag
`name`	string	Intitulé du tag
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`variants`Facultatif	object	Variantes
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`images`Facultatif	object	Illustrations
`media_id`	integer	Identifiant du média
`position`	integer	Position du média dans la liste
`name`	string	Intitulé du média
`original_name`	string	Nom d'origine du fichier
`service_path`Facultatif	string	Chemin du service Catalogue
`tier_prices_id`Facultatif	integer	Identifiant de la grille de tarifs dégressifs
`tier_prices_name`Facultatif	string	Nom de la grille de tarifs dégressifs

Modifie un produit PUT

`/v1/sites/{code_site}/catalog/products/{product_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`type`		string	Type de produit
`name`		string	Intitulé du produit
`is_visible`		boolean	Affichage du produit
`is_spotlight`		boolean	Produit vedette
`available_date`		string	Date de disponibilité
`categories`		array	Liste des identifiants des catégories du produit, le premier identifiant correspond à la catégorie principale
`brand_id`		integer	Identifiant de la marque
`header`		string	Chapô du produit
`description`		string	Description du produit
`extra_shipping`		float	Frais de port supplémentaire
`refill_tracking`		float	Suivi du réapprovisionnement
`text1`		string	Champ texte1 produit
`text2`		string	Champ texte2 produit
`text3`		string	Champ texte3 produit
`text4`		string	Champ texte4 produit
`text5`		string	Champ texte5 produit
`text6`		string	Champ texte6 produit
`text7`		string	Champ texte7 produit
`text8`		string	Champ texte8 produit
`text9`		string	Champ texte9 produit
`text10`		string	Champ texte10 produit
`text11`		string	Champ texte11 produit
`text12`		string	Champ texte12 produit
`text13`		string	Champ texte13 produit
`text14`		string	Champ texte14 produit
`text15`		string	Champ texte15 produit
`tags`		array	Liste des tags du produit
`tags_id`		array	Liste des identifiants des tags du produit
`slug`		string	Nom optimisé du produit
`meta_title`		string	Balise meta title
`meta_image`		integer	Balise meta image
`meta_description`		string	Balise meta description
`meta_keywords`		string	Balise meta keywords
`js_head`		string	Code avant la balise </head> de la page
`js_body`		string	Code avant la balise </body> de la page
`layout_id`		integer	Identifiant de la mise en page du produit
`tier_prices_id`		integer	Identifiant de la grille de tarifs dégressifs

Format de sortie :

Schéma JSON
Modèle

data:{
    "product_id": "integer",
    "is_spotlight": "boolean",
    "available_date": "string",
    "available_date_f": "string",
    "is_visible": "boolean",
    "stock": "string",
    "view_count": "integer",
    "is_virtual": "boolean",
    "brand_id": "integer",
    "brand_name": "string",
    "price_ex_vat_min": "float",
    "price_ex_vat_max": "float",
    "price_inc_vat_min": "float",
    "price_inc_vat_max": "float",
    "price_ex_vat_min_label": "string",
    "price_ex_vat_max_label": "string",
    "price_inc_vat_min_label": "string",
    "price_inc_vat_max_label": "string",
    "extra_shipping": "float",
    "comments_count": "integer",
    "rate": "float",
    "bought_count": "integer",
    "variants_count": "integer",
    "soldout_count": "integer",
    "refill_count": "integer",
    "refill_tracking": "boolean",
    "is_discount": "boolean",
    "price_base_ex_vat": "float",
    "price_base_inc_vat": "float",
    "price_base_ex_vat_label": "string",
    "price_base_inc_vat_label": "string",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "name": "string",
    "description": "string",
    "header": "string",
    "type": "string",
    "main_media_id": "integer",
    "slug": "string",
    "meta_title": "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"
    },
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer",
    "text1": "string",
    "text2": "string",
    "text3": "string",
    "text4": "string",
    "text5": "string",
    "text6": "string",
    "text7": "string",
    "text8": "string",
    "text9": "string",
    "text10": "string",
    "text11": "string",
    "text12": "string",
    "text13": "string",
    "text14": "string",
    "text15": "string",
    "tags": [
        {
            "tag_id": "integer",
            "name": "string"
        }
    ],
    "categories": [
        {
            "category_id": "integer",
            "name": "string",
            "is_main": "boolean"
        }
    ],
    "variants": [
        {
            "variant_id": "integer",
            "name": "string",
            "reference": "string",
            "gtin": "string",
            "condition": "string",
            "weight": "integer",
            "tax_id": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_discount_ex_vat": "float",
            "price_discount_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_discount_ex_vat_label": "string",
            "price_discount_inc_vat_label": "string",
            "price_ecotax": "float",
            "price_ecotax_label": "string",
            "is_stock_unlimited": "boolean",
            "stock": "integer",
            "position": "integer",
            "media_id": "integer",
            "file_id": "integer",
            "creation_date": "string",
            "modification_date": "string"
        }
    ],
    "images": [
        {
            "media_id": "integer",
            "position": "integer",
            "name": "string",
            "original_name": "string"
        }
    ],
    "service_path": "string",
    "tier_prices_id": "integer",
    "tier_prices_name": "string"
}

Nom	Type	Description
`product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`available_date_f`	string	Date de disponibilité formatée
`is_visible`	boolean	Produit affiché sur le site
`stock`	string	Produit en stock. Les valeurs possibles sont : yes, no, partial
`view_count`	integer	Nombre de vus
`is_virtual`	boolean	Produit virtuel
`brand_id`Facultatif	integer	Identifiant de la marque
`brand_name`Facultatif	string	Intitulé de la marque
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`extra_shipping`Facultatif	float	Frais de port supplémentaire
`comments_count`	integer	Nombre de commentaires
`rate`	float	Note du produit
`bought_count`	integer	Nombre d'achat
`variants_count`	integer	Nombre de variantes
`soldout_count`	integer	Nombre de variantes en rupture
`refill_count`	integer	Nombre de variantes à réapprovisionner
`refill_tracking`	boolean	Suivi du réapprovisionnement
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`name`	string	Intitulé du produit
`description`	string	Description du produit
`header`	string	Entête du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`meta_title`	string	Balise meta title
`meta_image`Facultatif	object	Balise meta image
`id`Facultatif	integer	Identifiant du media
`ext`	string	Extension du media
`url`	string	Url du media
`url_g_miniature`Facultatif	string	Url de la grande miniature
`url_g_vignette`Facultatif	string	Url de la grande vignette
`url_miniature`Facultatif	string	Url de la miniature
`url_vignette`Facultatif	string	Url de la vignette
`url_public`Facultatif	string	Url front-office du média
`meta_description`	string	Balise meta description
`meta_keywords`	string	Balise meta keywords
`js_head`	string	Code avant la balise </head>
`js_body`	string	Code avant la balise </body>
`layout_id`Facultatif	integer	Identifiant de la mise en page
`text1`Facultatif	string	Champ texte1
`text2`Facultatif	string	Champ texte2
`text3`Facultatif	string	Champ texte3
`text4`Facultatif	string	Champ texte4
`text5`Facultatif	string	Champ texte5
`text6`Facultatif	string	Champ texte6
`text7`Facultatif	string	Champ texte7
`text8`Facultatif	string	Champ texte8
`text9`Facultatif	string	Champ texte9
`text10`Facultatif	string	Champ texte10
`text11`Facultatif	string	Champ texte11
`text12`Facultatif	string	Champ texte12
`text13`Facultatif	string	Champ texte13
`text14`Facultatif	string	Champ texte14
`text15`Facultatif	string	Champ texte15
`tags`Facultatif	object
`tag_id`	integer	Identifiant du tag
`name`	string	Intitulé du tag
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`variants`Facultatif	object	Variantes
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`images`Facultatif	object	Illustrations
`media_id`	integer	Identifiant du média
`position`	integer	Position du média dans la liste
`name`	string	Intitulé du média
`original_name`	string	Nom d'origine du fichier
`service_path`Facultatif	string	Chemin du service Catalogue
`tier_prices_id`Facultatif	integer	Identifiant de la grille de tarifs dégressifs
`tier_prices_name`Facultatif	string	Nom de la grille de tarifs dégressifs

Duplique un produit POST

`/v1/sites/{code_site}/catalog/products/{product_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`category_id`		integer	Identifiant de la catégorie
`name`		string	Nom du produit

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime un produit DELETE

`/v1/sites/{code_site}/catalog/products/{product_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit

Liste les illustrations produits GET

`/v1/sites/{code_site}/catalog/products/{product_id}/images.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "media_id": "integer",
        "position": "integer",
        "name": "string",
        "original_name": "string"
    }
]

Nom	Type	Description
`media_id`	integer	Identifiant du média
`position`	integer	Position du média dans la liste
`name`	string	Intitulé du média
`original_name`	string	Nom d'origine du fichier

Supprime toutes les illustrations produit DELETE

`/v1/sites/{code_site}/catalog/products/{product_id}/images.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit

Réordonne les illustrations produit PUT

`/v1/sites/{code_site}/catalog/products/{product_id}/images.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`order`	Obligatoire	array	Liste des identifiants des images

Ajoute une illustration produit PUT

`/v1/sites/{code_site}/catalog/products/{product_id}/images/{media_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`media_id`	Obligatoire	integer	Ientifiant de l'image
`is_main`		boolean	Image principale

Supprime une illustration produit DELETE

`/v1/sites/{code_site}/catalog/products/{product_id}/images/{media_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`media_id`	Obligatoire	integer	Identifiant de l'image

Liste les produits associés GET

`/v1/sites/{code_site}/catalog/products/{product_id}/linked.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

product_id Obligatoire integer Identifiant du produit

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

categories	Liste des catégories
price_label	Prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "linked_product_id": "integer",
        "is_spotlight": "boolean",
        "available_date": "string",
        "is_visible": "boolean",
        "is_virtual": "boolean",
        "price_ex_vat_min": "float",
        "price_ex_vat_max": "float",
        "price_inc_vat_min": "float",
        "price_inc_vat_max": "float",
        "price_ex_vat_min_label": "string",
        "price_ex_vat_max_label": "string",
        "price_inc_vat_min_label": "string",
        "price_inc_vat_max_label": "string",
        "price_discount_ex_vat": "float",
        "price_discount_inc_vat": "float",
        "price_discount_ex_vat_label": "string",
        "price_discount_inc_vat_label": "string",
        "is_discount": "boolean",
        "price_base_ex_vat": "float",
        "price_base_inc_vat": "float",
        "price_base_ex_vat_label": "string",
        "price_base_inc_vat_label": "string",
        "creation_date": "string",
        "modification_date": "string",
        "name": "string",
        "type": "string",
        "main_media_id": "integer",
        "slug": "string",
        "categories": [
            {
                "category_id": "integer",
                "name": "string",
                "is_main": "boolean"
            }
        ],
        "link": "string"
    }
]

Nom	Type	Description
`linked_product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`is_visible`	boolean	Produit affiché sur le site
`is_virtual`	boolean	Produit virtuel
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`name`	string	Intitulé du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`link`Facultatif	string	Type d'association du produit. Les valeurs possibles sont : atob, btoa, both

Associe un produit POST

`/v1/sites/{code_site}/catalog/products/{product_id}/linked.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

product_id Obligatoire integer Identifiant du produit

linked_products Obligatoire array Liste des identifiants des produit à lier

link

Obligatoire

string

Détermine le type de la liaison :

atob	Le produit associé s'affiche sur la fiche du produit principal
btoa	Le produit principal s'affiche sur la fiche du produit associé
both	Affichage réciproque

Les valeurs attendues sont : atob, btoa, both

Modifie une association de produits PUT

`/v1/sites/{code_site}/catalog/products/{product_id}/linked/{linked_product_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

product_id Obligatoire integer Identifiant du produit

linked_product_id Obligatoire integer Identifiant du produit lié

link

Obligatoire

string

Détermine le type de la liaison :

atob	Le produit associé s'affiche sur la fiche du produit principal
btoa	Le produit principal s'affiche sur la fiche du produit associé
both	Affichage réciproque

Les valeurs attendues sont : atob, btoa, both

Format de sortie :

Schéma JSON
Modèle

data:{
    "linked_product_id": "integer",
    "is_spotlight": "boolean",
    "available_date": "string",
    "is_visible": "boolean",
    "is_virtual": "boolean",
    "price_ex_vat_min": "float",
    "price_ex_vat_max": "float",
    "price_inc_vat_min": "float",
    "price_inc_vat_max": "float",
    "price_ex_vat_min_label": "string",
    "price_ex_vat_max_label": "string",
    "price_inc_vat_min_label": "string",
    "price_inc_vat_max_label": "string",
    "price_discount_ex_vat": "float",
    "price_discount_inc_vat": "float",
    "price_discount_ex_vat_label": "string",
    "price_discount_inc_vat_label": "string",
    "is_discount": "boolean",
    "price_base_ex_vat": "float",
    "price_base_inc_vat": "float",
    "price_base_ex_vat_label": "string",
    "price_base_inc_vat_label": "string",
    "creation_date": "string",
    "modification_date": "string",
    "name": "string",
    "type": "string",
    "main_media_id": "integer",
    "slug": "string",
    "categories": [
        {
            "category_id": "integer",
            "name": "string",
            "is_main": "boolean"
        }
    ],
    "link": "string"
}

Nom	Type	Description
`linked_product_id`	integer	Identifiant du produit
`is_spotlight`	boolean	Produit vedette
`available_date`	string	Date de disponibilité
`is_visible`	boolean	Produit affiché sur le site
`is_virtual`	boolean	Produit virtuel
`price_ex_vat_min`	float	Prix minimum hors TVA
`price_ex_vat_max`	float	Prix maximum hors TVA
`price_inc_vat_min`	float	Prix minimum avec TVA
`price_inc_vat_max`	float	Prix maximum avec TVA
`price_ex_vat_min_label`Facultatif	string	Prix minimum hors TVA avec devise
`price_ex_vat_max_label`Facultatif	string	Prix maximum hors TVA avec devise
`price_inc_vat_min_label`Facultatif	string	Prix minimum avec TVA avec devise
`price_inc_vat_max_label`Facultatif	string	Prix maximum avec TVA avec devise
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`is_discount`	boolean	Produit en promotion
`price_base_ex_vat`Facultatif	float	Prix barré hors TVA
`price_base_inc_vat`Facultatif	float	Prix barré avec TVA
`price_base_ex_vat_label`Facultatif	string	Prix barré hors TVA avec devise
`price_base_inc_vat_label`Facultatif	string	Prix barré avec TVA avec devise
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`name`	string	Intitulé du produit
`type`	string	Type de fiche produit
`main_media_id`Facultatif	integer	Identifiant de l'illustration principale
`slug`	string	Nom optimisé
`categories`Facultatif	object	Catégories
`category_id`	integer	Identifiant de la catégorie
`name`	string	Intitulé de la catégorie
`is_main`	boolean	Catégorie principale
`link`Facultatif	string	Type d'association du produit. Les valeurs possibles sont : atob, btoa, both

Supprime une association de produits DELETE

`/v1/sites/{code_site}/catalog/products/{product_id}/linked/{linked_product_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`linked_product_id`	Obligatoire	integer	Identifiant du produit lié

Crée une variante POST

`/v1/sites/{code_site}/catalog/products/{product_id}/variants.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`name`		string	Intitulé de la variante
`tax_id`		integer	Identifiant de la taxe de la variante
`price_ex_vat`		float	Prix HT de la variante
`price_inc_vat`		float	Prix TTC de la variante
`price_discount_ex_vat`		float	Prix promo HT de la variante
`price_discount_inc_vat`		float	Prix promo TTC de la variante
`price_ecotax`		float	Eco-taxe de la variante
`stock`		integer	Nombre de produit en stock. Ne pas spécifier le champ pour définir un stock illimité
`weight`		integer	Poids en gramme de la variante
`reference`		string	Référence de la variante
`gtin`		string	Code EAN de la variante
`condition`		string	Etat de la variante
`media_id`		integer	Identifiant du média de la variante
`file_id`		integer	Identifiant du fichier à télécharger de la variante
`variant_id`		integer	Identifiant de la variante à dupliquer

Format de sortie :

Schéma JSON
Modèle

data:{
    "variant_id": "integer",
    "name": "string",
    "reference": "string",
    "gtin": "string",
    "condition": "string",
    "weight": "integer",
    "tax_id": "integer",
    "price_ex_vat": "float",
    "price_inc_vat": "float",
    "price_discount_ex_vat": "float",
    "price_discount_inc_vat": "float",
    "price_ex_vat_label": "string",
    "price_inc_vat_label": "string",
    "price_discount_ex_vat_label": "string",
    "price_discount_inc_vat_label": "string",
    "price_ecotax": "float",
    "price_ecotax_label": "string",
    "is_stock_unlimited": "boolean",
    "stock": "integer",
    "position": "integer",
    "media_id": "integer",
    "file_id": "integer",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Réordonne les variantes PUT

`/v1/sites/{code_site}/catalog/products/{product_id}/variants.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`order`	Obligatoire	array	Liste des identifiants des variantes

Modifie une variante PUT

`/v1/sites/{code_site}/catalog/products/{product_id}/variants/{variant_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`variant_id`	Obligatoire	integer	Identifiant de la variante
`name`		string	Intitulé de la variante
`tax_id`		integer	Identifiant de la taxe de la variante
`price_ex_vat`		float	Prix HT de la variante
`price_inc_vat`		float	Prix TTC de la variante
`price_discount_ex_vat`		float	Prix promo HT de la variante
`price_discount_inc_vat`		float	Prix promo TTC de la variante
`price_ecotax`		float	Eco-taxe de la variante
`stock`		integer	Quantité à ajouter ou retirer du stock
`is_stock_unlimited`		boolean	Définit le stock comme illimité
`weight`		integer	Poids en gramme de la variante
`reference`		string	Référence de la variante
`gtin`		string	Code EAN de la variante
`condition`		string	Etat de la variante
`media_id`		integer	Identifiant du média de la variante
`file_id`		integer	Identifiant du fichier à télécharger de la variante

Format de sortie :

Schéma JSON
Modèle

data:{
    "variant_id": "integer",
    "name": "string",
    "reference": "string",
    "gtin": "string",
    "condition": "string",
    "weight": "integer",
    "tax_id": "integer",
    "price_ex_vat": "float",
    "price_inc_vat": "float",
    "price_discount_ex_vat": "float",
    "price_discount_inc_vat": "float",
    "price_ex_vat_label": "string",
    "price_inc_vat_label": "string",
    "price_discount_ex_vat_label": "string",
    "price_discount_inc_vat_label": "string",
    "price_ecotax": "float",
    "price_ecotax_label": "string",
    "is_stock_unlimited": "boolean",
    "stock": "integer",
    "position": "integer",
    "media_id": "integer",
    "file_id": "integer",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`variant_id`	integer	Identifiant de la variante
`name`	string	Intitulé de la variante
`reference`	string	Référence
`gtin`	string	Code EAN
`condition`	string	Etat de conditionnement
`weight`	integer	Poids en gramme
`tax_id`	integer	Identifiant de la taxe
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_discount_ex_vat`Facultatif	float	Prix promo hors TVA
`price_discount_inc_vat`Facultatif	float	Prix promo avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`price_discount_ex_vat_label`Facultatif	string	Prix promo hors TVA avec devise
`price_discount_inc_vat_label`Facultatif	string	Prix promo avec TVA avec devise
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_stock_unlimited`	boolean	Stock illimité
`stock`	integer	Quantité en stock
`position`	integer	Position dans la liste des variantes
`media_id`	integer	Identifiant de l'illustration
`file_id`Facultatif	integer	Identifiant du fichier à télécharger (pour les produits virutels)
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Supprime une variante DELETE

`/v1/sites/{code_site}/catalog/products/{product_id}/variants/{variant_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`variant_id`	Obligatoire	integer	Identifiant de la variante

Liste des types de produits GET

`/v1/sites/{code_site}/catalog/products_types.json`

Les types de produits sont définis dans le thème graphique courant.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

structure

Détail des structures des types

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "type": "string",
        "name": "string",
        "position": "integer",
        "fields": [
            {
                "field": "string",
                "type": "string",
                "name": "string",
                "help": "string",
                "options": [
                    {
                        "label": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    }
]

Nom	Type	Description
`type`	string	Identifiant du type de schéma
`name`	string	Intitulé du type de schéma
`position`	integer	Ordre du type de schéma
`fields`Facultatif	object	Structure des champs
`field`	string	Nom du champ. Les valeurs possibles sont : title, subtitle, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15
`type`	string	Type de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, fichier
`name`	string	Intitulé du champ
`help`Facultatif	string	Aide à la saisie
`options`Facultatif	object	Options pour un champ de type select
`label`	string	Intitulé de l'option
`value`	string	Valeur de l'option

Liste les intitulés de variantes GET

`/v1/sites/{code_site}/catalog/variants.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`term`		string	Recherche par intitulé
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 15, maximum : 30)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "name": "string"
    }
]

Nom	Type	Description
`name`	string	Intitulé de la variante

Liste les intitulés de variantes PUT

`/v1/sites/{code_site}/catalog/variants.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`from`		string	Intitulé d'origine
`to`		string	Nouvel intitulé

Tarifs dégressifs

Tarifs dégressifs GET

`/v1/sites/{code_site}/catalog/tier_prices.json`

Liste les grilles de tarifs dégressifs.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

name string Filtre par nom

is_enabled boolean Filtre par état

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 50)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

name / -name	Tri selon le nom de la grille
product_count / -product_count	Tri selon le nombre de produits

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "grid_id": "integer",
        "name": "string",
        "is_enabled": "boolean",
        "product_count": "integer",
        "steps": [
            {
                "qt": "integer",
                "discount": "float"
            }
        ]
    }
]

Nom	Type	Description
`grid_id`	integer	Identifiant de la grille
`name`	string	Nom de la grille
`is_enabled`	boolean	Grille activée
`product_count`	integer	Estimation du nombre de produits utilisant cette grille
`steps`Facultatif	object	Catégories
`qt`	integer	Quantité de produits
`discount`	float	Remise en pourcentage

Crée une grille POST

`/v1/sites/{code_site}/catalog/tier_prices.json`

Crée une nouvelle grille de tarifs dégressifs.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`is_enabled`		boolean	Grille active
`name`	Obligatoire	string	Nom de la grille

Format de sortie :

Schéma JSON
Modèle

data:{
    "grid_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "product_count": "integer",
    "steps": [
        {
            "qt": "integer",
            "discount": "float"
        }
    ]
}

Nom	Type	Description
`grid_id`	integer	Identifiant de la grille
`name`	string	Nom de la grille
`is_enabled`	boolean	Grille activée
`product_count`	integer	Estimation du nombre de produits utilisant cette grille
`steps`Facultatif	object	Catégories
`qt`	integer	Quantité de produits
`discount`	float	Remise en pourcentage

Détail d'une grille GET

`/v1/sites/{code_site}/catalog/tier_prices/{grid_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`grid_id`	Obligatoire	integer	Identifiant de la grille

Format de sortie :

Schéma JSON
Modèle

data:{
    "grid_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "product_count": "integer",
    "steps": [
        {
            "qt": "integer",
            "discount": "float"
        }
    ]
}

Nom	Type	Description
`grid_id`	integer	Identifiant de la grille
`name`	string	Nom de la grille
`is_enabled`	boolean	Grille activée
`product_count`	integer	Estimation du nombre de produits utilisant cette grille
`steps`Facultatif	object	Catégories
`qt`	integer	Quantité de produits
`discount`	float	Remise en pourcentage

Modifie une grille PUT

`/v1/sites/{code_site}/catalog/tier_prices/{grid_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`grid_id`	Obligatoire	integer	Identifiant de la grille
`name`		string	Nom de la grille
`is_enabled`		boolean	Grille activée
`steps`		array	Tranches de remises

Format de sortie :

Schéma JSON
Modèle

data:{
    "grid_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "product_count": "integer",
    "steps": [
        {
            "qt": "integer",
            "discount": "float"
        }
    ]
}

Nom	Type	Description
`grid_id`	integer	Identifiant de la grille
`name`	string	Nom de la grille
`is_enabled`	boolean	Grille activée
`product_count`	integer	Estimation du nombre de produits utilisant cette grille
`steps`Facultatif	object	Catégories
`qt`	integer	Quantité de produits
`discount`	float	Remise en pourcentage

Supprime une grille DELETE

`/v1/sites/{code_site}/catalog/tier_prices/{grid_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`grid_id`	Obligatoire	integer	Identifiant de la grille

Taxes

Liste les taxes GET

`/v1/sites/{code_site}/catalog/taxes.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:[
    {
        "tax_id": "integer",
        "vat_rate": "float",
        "is_default": "boolean",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer"
    }
]

Nom	Type	Description
`tax_id`	integer	Identifiant de la taxe
`vat_rate`	float	Pourcentage de taxe
`is_default`	boolean	Taxe par défaut
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification

Ajoute une taxe POST

`/v1/sites/{code_site}/catalog/taxes.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`vat_rate`		float	Taux de la taxe
`is_default`		boolean	Taxe par défaut

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Détail d'une taxe GET

`/v1/sites/{code_site}/catalog/taxes/{tax_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`tax_id`	Obligatoire	integer	Identifiant de la taxe

Format de sortie :

Schéma JSON
Modèle

data:{
    "tax_id": "integer",
    "vat_rate": "float",
    "is_default": "boolean",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer"
}

Nom	Type	Description
`tax_id`	integer	Identifiant de la taxe
`vat_rate`	float	Pourcentage de taxe
`is_default`	boolean	Taxe par défaut
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification

Modifie une taxe PUT

`/v1/sites/{code_site}/catalog/taxes/{tax_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`tax_id`	Obligatoire	integer	Identifiant de la taxe
`vat_rate`		float	Taux de la taxe
`is_default`		boolean	Taxe par défaut

Supprime une taxe DELETE

`/v1/sites/{code_site}/catalog/taxes/{tax_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`tax_id`	Obligatoire	integer	Identifiant de la taxe

Marques

Liste les marques GET

`/v1/sites/{code_site}/catalog/brands.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`term`		string	Recherche par libellé
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "brand_id": "integer",
        "name": "string"
    }
]

Nom	Type	Description
`brand_id`	integer	Identifiant de la marque
`name`	string	Intitulé de la marque

Ajoute une marque POST

`/v1/sites/{code_site}/catalog/brands.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`	Obligatoire	string	Intitulé de la marque

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Détail d'une marque GET

`/v1/sites/{code_site}/catalog/brands/{brand_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`brand_id`	Obligatoire	integer	Identifiant de la marque

Format de sortie :

Schéma JSON
Modèle

data:{
    "brand_id": "integer",
    "name": "string"
}

Nom	Type	Description
`brand_id`	integer	Identifiant de la marque
`name`	string	Intitulé de la marque

Modifie une marque PUT

`/v1/sites/{code_site}/catalog/brands/{brand_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`brand_id`	Obligatoire	integer	Identifiant de la marque
`name`	Obligatoire	string	Intitulé de la marque

Supprime une marque DELETE

`/v1/sites/{code_site}/catalog/brands/{brand_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`brand_id`	Obligatoire	integer	Identifiant de la marque

Évaluations

Liste les évaluation GET

`/v1/sites/{code_site}/catalog/comments.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`customer_id`		integer	Identifiant du membre
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "comment_id": "integer",
        "is_visible": "boolean",
        "date": "string",
        "comment": "string",
        "origin": "string",
        "author": "string",
        "ip": "string",
        "rate": "integer",
        "reverse_host": "string",
        "product_id": "integer",
        "product_name": "string",
        "customer_id": "integer",
        "customer_name": "string",
        "customer_email": "string",
        "customer_nickname": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string"
    }
]

Nom	Type	Description
`comment_id`	integer	Identifiant du commentaire
`is_visible`	boolean	Affichage du commentaire
`date`	string	Date du commentaire
`comment`	string	Contenu du commentaire
`origin`	string	Origine du commentaire. Les valeurs possibles sont : customer, anonymous, admin
`author`	string	Nom de l'auteur
`ip`	string	Adresse IP de l'auteur
`rate`	integer	Note du produit
`reverse_host`	string	Reverse host de l'adresse IP
`product_id`	integer	Identifiant du produit
`product_name`	string	Intitulé du produit
`customer_id`Facultatif	integer	Identifiant du client
`customer_name`Facultatif	string	Nom du client
`customer_email`Facultatif	string	Email du client
`customer_nickname`Facultatif	string	Pseudo du client
`avatar_url`	string	Url de l'avatar du client
`avatar_thumb_url`	string	Url de l'avatar miniature du client

Ajoute une évaluation POST

`/v1/sites/{code_site}/catalog/comments.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`comment`	Obligatoire	string	Texte de l'évaluation
`is_visible`		boolean	Afficher l'évaluation
`rate`		integer	Note du produit
`date`		string	Date de l'évaluation
`origin`		string	Origine de l'évaluation Les valeurs attendues sont : anonymous, admin
`author`		string	Nom de l'auteur pour le type anonymous

Format de sortie :

Schéma JSON
Modèle

data:{
    "comment_id": "integer",
    "is_visible": "boolean",
    "date": "string",
    "comment": "string",
    "origin": "string",
    "author": "string",
    "ip": "string",
    "rate": "integer",
    "reverse_host": "string",
    "product_id": "integer",
    "product_name": "string",
    "customer_id": "integer",
    "customer_name": "string",
    "customer_email": "string",
    "customer_nickname": "string",
    "avatar_url": "string",
    "avatar_thumb_url": "string"
}

Nom	Type	Description
`comment_id`	integer	Identifiant du commentaire
`is_visible`	boolean	Affichage du commentaire
`date`	string	Date du commentaire
`comment`	string	Contenu du commentaire
`origin`	string	Origine du commentaire. Les valeurs possibles sont : customer, anonymous, admin
`author`	string	Nom de l'auteur
`ip`	string	Adresse IP de l'auteur
`rate`	integer	Note du produit
`reverse_host`	string	Reverse host de l'adresse IP
`product_id`	integer	Identifiant du produit
`product_name`	string	Intitulé du produit
`customer_id`Facultatif	integer	Identifiant du client
`customer_name`Facultatif	string	Nom du client
`customer_email`Facultatif	string	Email du client
`customer_nickname`Facultatif	string	Pseudo du client
`avatar_url`	string	Url de l'avatar du client
`avatar_thumb_url`	string	Url de l'avatar miniature du client

Supprime un lot d'évaluations DELETE

`/v1/sites/{code_site}/catalog/comments.json`

Permet de regrouper la suppression de jusqu'à 100 évaluations produits en un seul appel à l'API.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`comments`		array	Identifiants d'évaluations (max:100)

Détail d'une évaluation GET

`/v1/sites/{code_site}/catalog/comments/{comment_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`comment_id`	Obligatoire	integer	Identifiant de l'évaluation

Format de sortie :

Schéma JSON
Modèle

data:{
    "comment_id": "integer",
    "is_visible": "boolean",
    "date": "string",
    "comment": "string",
    "origin": "string",
    "author": "string",
    "ip": "string",
    "rate": "integer",
    "reverse_host": "string",
    "product_id": "integer",
    "product_name": "string",
    "customer_id": "integer",
    "customer_name": "string",
    "customer_email": "string",
    "customer_nickname": "string",
    "avatar_url": "string",
    "avatar_thumb_url": "string"
}

Nom	Type	Description
`comment_id`	integer	Identifiant du commentaire
`is_visible`	boolean	Affichage du commentaire
`date`	string	Date du commentaire
`comment`	string	Contenu du commentaire
`origin`	string	Origine du commentaire. Les valeurs possibles sont : customer, anonymous, admin
`author`	string	Nom de l'auteur
`ip`	string	Adresse IP de l'auteur
`rate`	integer	Note du produit
`reverse_host`	string	Reverse host de l'adresse IP
`product_id`	integer	Identifiant du produit
`product_name`	string	Intitulé du produit
`customer_id`Facultatif	integer	Identifiant du client
`customer_name`Facultatif	string	Nom du client
`customer_email`Facultatif	string	Email du client
`customer_nickname`Facultatif	string	Pseudo du client
`avatar_url`	string	Url de l'avatar du client
`avatar_thumb_url`	string	Url de l'avatar miniature du client

Modifie un évaluation PUT

`/v1/sites/{code_site}/catalog/comments/{comment_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`comment_id`	Obligatoire	integer	Identifiant de l'évaluation
`is_visible`		boolean	Afficher l'évaluation
`author`		string	Nom de l'auteur de l'évaluation pour le type anonymous
`comment`		string	Texte de l'évaluation
`rate`		integer	Note du produit
`date`		string	Date de l'évaluation

Supprime une évaluation DELETE

`/v1/sites/{code_site}/catalog/comments/{comment_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`comment_id`	Obligatoire	integer	Identifiant de l'évaluation

Liste les évaluation d'un produit GET

`/v1/sites/{code_site}/catalog/products/{product_id}/comments.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`product_id`	Obligatoire	integer	Identifiant du produit
`customer_id`		integer	Identifiant du membre
`limit`		integer	Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)
`page`		integer	Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "comment_id": "integer",
        "is_visible": "boolean",
        "date": "string",
        "comment": "string",
        "origin": "string",
        "author": "string",
        "ip": "string",
        "rate": "integer",
        "reverse_host": "string",
        "product_id": "integer",
        "product_name": "string",
        "customer_id": "integer",
        "customer_name": "string",
        "customer_email": "string",
        "customer_nickname": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string"
    }
]

Nom	Type	Description
`comment_id`	integer	Identifiant du commentaire
`is_visible`	boolean	Affichage du commentaire
`date`	string	Date du commentaire
`comment`	string	Contenu du commentaire
`origin`	string	Origine du commentaire. Les valeurs possibles sont : customer, anonymous, admin
`author`	string	Nom de l'auteur
`ip`	string	Adresse IP de l'auteur
`rate`	integer	Note du produit
`reverse_host`	string	Reverse host de l'adresse IP
`product_id`	integer	Identifiant du produit
`product_name`	string	Intitulé du produit
`customer_id`Facultatif	integer	Identifiant du client
`customer_name`Facultatif	string	Nom du client
`customer_email`Facultatif	string	Email du client
`customer_nickname`Facultatif	string	Pseudo du client
`avatar_url`	string	Url de l'avatar du client
`avatar_thumb_url`	string	Url de l'avatar miniature du client

Produits virtuels

Recherche des médias téléchargeables GET

`/v1/sites/{code_site}/catalog/downloads/files.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

folder_id integer Identifiant du dossier

term string Terme recherché

sort

string

Détermine l'ordre de tri parmis les critères suivants :

name	Tri selon le nom du fichier
-date	Tri selon la date de modification

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 20)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "media_id": "integer",
        "name": "string",
        "ext": "string",
        "folder_id": "integer",
        "description": "string",
        "original_name": "string",
        "type": "string",
        "mime": "string",
        "weight": "integer",
        "width": "integer",
        "height": "integer",
        "creation_date": "string",
        "modification_date": "string"
    }
]

Nom	Type	Description
`media_id`	integer	Identifiant du média
`name`	string	Intitulé du média
`ext`	string	Intitulé du média
`folder_id`Facultatif	integer	Identifiant du dossier
`description`Facultatif	string	Description du média
`original_name`Facultatif	string	Nom d'origine du fichier
`type`	string	Type du média
`mime`	string	Type mime du média
`weight`Facultatif	integer	Poids du média
`width`Facultatif	integer	Largeur du média, pour une image
`height`Facultatif	integer	Hauteur du média, pour une image
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Ajoute un media téléchargeable POST

`/v1/sites/{code_site}/catalog/downloads/files.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`		string	Intitulé du fichier
`description`		string	Description du fichier
`folder_id`		integer	Identifiant du dossier
`file`	Obligatoire	file	Fichier à envoyer

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Détail d'un média téléchargeable GET

`/v1/sites/{code_site}/catalog/downloads/files/{media_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`media_id`	Obligatoire	integer	Identifiant du média

Format de sortie :

Schéma JSON
Modèle

data:{
    "media_id": "integer",
    "name": "string",
    "ext": "string",
    "folder_id": "integer",
    "description": "string",
    "original_name": "string",
    "type": "string",
    "mime": "string",
    "weight": "integer",
    "width": "integer",
    "height": "integer",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`media_id`	integer	Identifiant du média
`name`	string	Intitulé du média
`ext`	string	Intitulé du média
`folder_id`Facultatif	integer	Identifiant du dossier
`description`Facultatif	string	Description du média
`original_name`Facultatif	string	Nom d'origine du fichier
`type`	string	Type du média
`mime`	string	Type mime du média
`weight`Facultatif	integer	Poids du média
`width`Facultatif	integer	Largeur du média, pour une image
`height`Facultatif	integer	Hauteur du média, pour une image
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Modifie un media téléchargeable PUT

`/v1/sites/{code_site}/catalog/downloads/files/{media_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`media_id`	Obligatoire	integer	Identifiant du média
`name`		string	Intitulé du fichier
`description`		string	Description du fichier
`file`		file	Fichier à envoyer

Supprime un media téléchargeable DELETE

`/v1/sites/{code_site}/catalog/downloads/files/{media_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`media_id`	Obligatoire	integer	Identifiant du média

Liste les dossiers racines GET

`/v1/sites/{code_site}/catalog/downloads/folders.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

recursive

Extrait toute l'arborescence

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "folder_id": "integer",
        "name": "string",
        "parent_folder_id": "integer",
        "folder_key": "string",
        "creation_date": "string",
        "modification_date": "string"
    }
]

Nom	Type	Description
`folder_id`	integer	Identifiant du dossier
`name`	string	Intitulé du dossier
`parent_folder_id`	integer	Identifiant du dossier parent
`folder_key`Facultatif	string	Clé API du dossier
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Crée un dossier dans les médias téléchargeables POST

`/v1/sites/{code_site}/catalog/downloads/folders.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`name`		string	Nom du dossier
`parent_folder_id`		integer	Identifiant du dossier parent

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Détail d'un dossier des médias téléchargeables GET

`/v1/sites/{code_site}/catalog/downloads/folders/{folder_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`folder_id`	Obligatoire	integer	Identifiant du dossier

Format de sortie :

Schéma JSON
Modèle

data:{
    "folder_id": "integer",
    "name": "string",
    "parent_folder_id": "integer",
    "folder_key": "string",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`folder_id`	integer	Identifiant du dossier
`name`	string	Intitulé du dossier
`parent_folder_id`	integer	Identifiant du dossier parent
`folder_key`Facultatif	string	Clé API du dossier
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Modifie un dossier des médias téléchargeables PUT

`/v1/sites/{code_site}/catalog/downloads/folders/{folder_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`folder_id`	Obligatoire	integer	Identifiant du dossier
`name`	Obligatoire	string	Nom du dossier

Supprime un dossier des médias téléchargeables DELETE

`/v1/sites/{code_site}/catalog/downloads/folders/{folder_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`folder_id`	Obligatoire	integer	Identifiant du dossier

Lister les médias téléchargeables d'un dossier GET

`/v1/sites/{code_site}/catalog/downloads/folders/{folder_id}/content.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

folder_id Obligatoire integer Identifiant du dossier

sort

array

Détermine l'ordre de tri parmis les critères suivants :

name	Tri selon le nom du fichier
-date	Tri selon la date de modification