Catalogue

Résumé

Résumé du catalogue GET
/v1/sites/{code_site}/catalog.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "products_count": "integer"
}
NomTypeDescription
products_countintegerNombre total de produits

Catégories

Liste les catégories GET
/v1/sites/{code_site}/catalog/categories.json

Paramètres supportés par ce endpoint :

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

Format de sortie :

data:[
    {
        "category_id": "integer",
        "name": "string",
        "description": "string",
        "media_id": "integer",
        "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_description": "string",
        "meta_keywords": "string",
        "js_head": "string",
        "js_body": "string",
        "layout_id": "integer"
    }
]
NomTypeDescription
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
descriptionstringDescription de la catégorie
media_idFacultatifintegerIdentifiant de l'image
is_visiblebooleanAffichage dans le menu
is_mainbooleanCatégorie principale
slugstringNom optimisé
product_countintegerNombre de produits
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
Ajoute une catégorie POST
/v1/sites/{code_site}/catalog/categories.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
namestringIntitulé de la catégorie
slugstringNom optimisé de la catégorie
is_visiblebooleanAffiche la catégorie dans le menu
media_idintegerIdentifiant de l'illustration de la catégorie
descriptionstringDescription de la catégorie
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head> de la page
js_bodystringCode avant la balise </body> de la page
layout_idintegerIdentifiant de la mise en page de la catégorie
after_idintegerPositionne la catégorie après celle ayant cet identifiant
before_idintegerPositionne 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 :

data:[]
NomTypeDescription
Détail d'une catégorie GET
/v1/sites/{code_site}/catalog/categories/{category_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
category_idObligatoireintegerIdentifiant de la catégorie
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
defaultsReferencement par défaut

Format de sortie :

data:{
    "category_id": "integer",
    "name": "string",
    "description": "string",
    "media_id": "integer",
    "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_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer"
}
NomTypeDescription
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
descriptionstringDescription de la catégorie
media_idFacultatifintegerIdentifiant de l'image
is_visiblebooleanAffichage dans le menu
is_mainbooleanCatégorie principale
slugstringNom optimisé
product_countintegerNombre de produits
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
Modifie une catégorie PUT
/v1/sites/{code_site}/catalog/categories/{category_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
category_idObligatoireintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
slugstringNom optimisé de la catégorie
is_visiblebooleanAffiche la catégorie dans le menu
media_idintegerIdentifiant de l'illustration de la catégorie
descriptionstringDescription de la catégorie
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head> de la page
js_bodystringCode avant la balise </body> de la page
layout_idintegerIdentifiant de la mise en page de la catégorie
after_idintegerPositionne la catégorie après celle ayant cet identifiant
before_idintegerPositionne 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 :

data:{
    "category_id": "integer",
    "name": "string",
    "description": "string",
    "media_id": "integer",
    "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_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer"
}
NomTypeDescription
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
descriptionstringDescription de la catégorie
media_idFacultatifintegerIdentifiant de l'image
is_visiblebooleanAffichage dans le menu
is_mainbooleanCatégorie principale
slugstringNom optimisé
product_countintegerNombre de produits
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
Supprime une catégorie DELETE
/v1/sites/{code_site}/catalog/categories/{category_id}.json

Paramètres supportés par ce endpoint :

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

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
defaultsReferencement par défaut

Format de sortie :

data:{
    "name": "string",
    "is_visible": "boolean",
    "modification_date": "string",
    "meta_title": "string",
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string",
    "layout_id": "integer"
}
NomTypeDescription
namestringIntitulé de la catégorie
is_visiblebooleanAffichage dans le menu
modification_dateFacultatifstringDate de dernière modification
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
Modifie la page d'accueil du catalogue PUT
/v1/sites/{code_site}/catalog/home.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
namestringIntitulé de la catégorie
is_visiblebooleanAffiche la catégorie dans le menu
descriptionstringDescription de la catégorie
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head> de la page
js_bodystringCode avant la balise </body> de la page
layout_idintegerIdentifiant de la mise en page de la catégorie

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 :

NomTypeDescription
code_siteObligatoirestringCode site
category_idObligatoireintegerIdentifiant de la catégorie
tag_idstringIdentifiant du tag
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
name / -nameTri selon l'intitulé du produit
price_min / -price_minTri selon le prix minimal du produit
price_max / -price_maxTri selon le prix maximal du produit
modification / -modificationTri selon la date de modification du produit

Format de sortie :

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",
        "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_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"
            }
        ]
    }
]
NomTypeDescription
product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
available_date_fstringDate de disponibilité formatée
is_visiblebooleanProduit affiché sur le site
stockstringProduit en stock. Les valeurs possibles sont : yes, no, partial
view_countintegerNombre de vus
is_virtualbooleanProduit virtuel
brand_idFacultatifintegerIdentifiant de la marque
brand_nameFacultatifstringIntitulé de la marque
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
extra_shippingFacultatiffloatFrais de port supplémentaire
comments_countintegerNombre de commentaires
ratefloatNote du produit
bought_countintegerNombre d'achat
variants_countintegerNombre de variantes
soldout_countintegerNombre de variantes en rupture
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
namestringIntitulé du produit
descriptionstringDescription du produit
headerstringEntête du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15
tagsFacultatifobject
tag_idintegerIdentifiant du tag
namestringIntitulé du tag
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
variantsFacultatifobjectVariantes
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
imagesFacultatifobjectIllustrations
media_idintegerIdentifiant du média
positionintegerPosition du média dans la liste
namestringIntitulé du média
original_namestringNom d'origine du fichier
Liste les produits GET
/v1/sites/{code_site}/catalog/products.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
category_idintegerIdentifiant de la catégorie
tag_idintegerIdentifiant du tag
termstringRecherche par libellé
brand_idintegerIdentifiant de la marque
price_minfloatPrix minimum
price_maxfloatPrix maximum
stockstringProduits en stock parmis les valeurs suivantes :
yesToutes les variantes sont en stock
noAucune variante n'est en stock
partialAu moins une variante est en stock

Les valeurs attendues sont : yes, no, partial
available_date_minstringDisponible après cette date
available_date_maxstringDisponible avant cette date
is_visiblebooleanAffiché sur le site
is_spotlightbooleanProduit vedette
typestringType de produit
variant_namestringIntitulé de la variante
variant_conditionstringEtat de la variante parmis les valeurs suivantes :
newNeuf
usedOccasion
refurbishedReconditionné

Les valeurs attendues sont : new, used, refurbished
variant_gtinstringEAN de la variante
variant_referencestringRéférence de la variante
linked_count_minintegerAvec un minimum de produits associés
linked_count_maxintegerAvec un maximum de produits associés
rate_minfloatAvec une note minimum
rate_maxfloatAvec une note maximum
comments_minintegerAvec un minimum de commentaires
comments_maxintegerAvec un maximum de commantaires
weight_minintegerAvec un poids minimum (en grammes)
weight_maxintegerAvec un poids maximum (en grammes)
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
name / -nameTri selon l'intitulé du produit
price_min / -price_minTri selon le prix minimal du produit
price_max / -price_maxTri selon le prix maximal du produit
modification / -modificationTri selon la date de modification du produit
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
textsChamps texte1 à texte15
tagsListe des tags
categoriesListe des catégories
variantsVariantes
price_labelPrix dans la devise du site

Format de sortie :

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",
        "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_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"
            }
        ]
    }
]
NomTypeDescription
product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
available_date_fstringDate de disponibilité formatée
is_visiblebooleanProduit affiché sur le site
stockstringProduit en stock. Les valeurs possibles sont : yes, no, partial
view_countintegerNombre de vus
is_virtualbooleanProduit virtuel
brand_idFacultatifintegerIdentifiant de la marque
brand_nameFacultatifstringIntitulé de la marque
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
extra_shippingFacultatiffloatFrais de port supplémentaire
comments_countintegerNombre de commentaires
ratefloatNote du produit
bought_countintegerNombre d'achat
variants_countintegerNombre de variantes
soldout_countintegerNombre de variantes en rupture
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
namestringIntitulé du produit
descriptionstringDescription du produit
headerstringEntête du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15
tagsFacultatifobject
tag_idintegerIdentifiant du tag
namestringIntitulé du tag
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
variantsFacultatifobjectVariantes
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
imagesFacultatifobjectIllustrations
media_idintegerIdentifiant du média
positionintegerPosition du média dans la liste
namestringIntitulé du média
original_namestringNom d'origine du fichier
Crée un produit POST
/v1/sites/{code_site}/catalog/products.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
typeObligatoirestringType de produit
namestringIntitulé du produit
is_visiblebooleanAffichage du produit
is_virtualbooleanProduit virtuel
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
categoriesarrayListe des identifiants des catégories du produit, le premier identifiant correspond à la catégorie principale
brand_idintegerIdentifiant de la marque
headerstringChapô du produit
descriptionstringDescription du produit
extra_shippingfloatFrais de port supplémentaire
text1stringChamp texte1 produit
text2stringChamp texte2 produit
text3stringChamp texte3 produit
text4stringChamp texte4 produit
text5stringChamp texte5 produit
text6stringChamp texte6 produit
text7stringChamp texte7 produit
text8stringChamp texte8 produit
text9stringChamp texte9 produit
text10stringChamp texte10 produit
text11stringChamp texte11 produit
text12stringChamp texte12 produit
text13stringChamp texte13 produit
text14stringChamp texte14 produit
text15stringChamp texte15 produit
media_idarrayListe d'identifiants des médias du produit, le premier identifiant correspond à l'image principale
tagsarrayListe des tags du produit
tags_idarrayListe des identifiants des tags du produit
slugstringNom optimisé du produit
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head> de la page
js_bodystringCode avant la balise </body> de la page
layout_idintegerIdentifiant de la mise en page du produit
tax_idintegerIdentifiant de la taxe de la variante
price_ex_vatfloatPrix HT de la variante
price_inc_vatfloatPrix TTC de la variante
price_discount_ex_vatfloatPrix promo HT de la variante
price_discount_inc_vatfloatPrix promo TTC de la variante
price_ecotaxfloatEco-taxe de la variante
stockintegerNombre de produit en stock. Ne pas spécifier le champ pour définir un stock illimité
weightintegerPoids en gramme de la variante
referencestringRéférence de la variante
gtinstringCode EAN de la variante
conditionstringEtat de la variante
variant_media_idintegerIdentifiant du média de la variante
variant_namestringIntitulé de la variante
file_idintegerIdentifiant du fichier à télécharger de la variante

Format de sortie :

data:[]
NomTypeDescription
Modifie un produit PUT
/v1/sites/{code_site}/catalog/products/{product_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
typestringType de produit
namestringIntitulé du produit
is_visiblebooleanAffichage du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
categoriesarrayListe des identifiants des catégories du produit, le premier identifiant correspond à la catégorie principale
brand_idintegerIdentifiant de la marque
headerstringChapô du produit
descriptionstringDescription du produit
extra_shippingfloatFrais de port supplémentaire
text1stringChamp texte1 produit
text2stringChamp texte2 produit
text3stringChamp texte3 produit
text4stringChamp texte4 produit
text5stringChamp texte5 produit
text6stringChamp texte6 produit
text7stringChamp texte7 produit
text8stringChamp texte8 produit
text9stringChamp texte9 produit
text10stringChamp texte10 produit
text11stringChamp texte11 produit
text12stringChamp texte12 produit
text13stringChamp texte13 produit
text14stringChamp texte14 produit
text15stringChamp texte15 produit
tagsarrayListe des tags du produit
tags_idarrayListe des identifiants des tags du produit
slugstringNom optimisé du produit
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head> de la page
js_bodystringCode avant la balise </body> de la page
layout_idintegerIdentifiant de la mise en page du produit

Format de sortie :

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",
    "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_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"
        }
    ]
}
NomTypeDescription
product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
available_date_fstringDate de disponibilité formatée
is_visiblebooleanProduit affiché sur le site
stockstringProduit en stock. Les valeurs possibles sont : yes, no, partial
view_countintegerNombre de vus
is_virtualbooleanProduit virtuel
brand_idFacultatifintegerIdentifiant de la marque
brand_nameFacultatifstringIntitulé de la marque
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
extra_shippingFacultatiffloatFrais de port supplémentaire
comments_countintegerNombre de commentaires
ratefloatNote du produit
bought_countintegerNombre d'achat
variants_countintegerNombre de variantes
soldout_countintegerNombre de variantes en rupture
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
namestringIntitulé du produit
descriptionstringDescription du produit
headerstringEntête du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15
tagsFacultatifobject
tag_idintegerIdentifiant du tag
namestringIntitulé du tag
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
variantsFacultatifobjectVariantes
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
imagesFacultatifobjectIllustrations
media_idintegerIdentifiant du média
positionintegerPosition du média dans la liste
namestringIntitulé du média
original_namestringNom d'origine du fichier
Duplique un produit POST
/v1/sites/{code_site}/catalog/products/{product_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
category_idintegerIdentifiant de la catégorie
namestringNom du produit

Format de sortie :

data:[]
NomTypeDescription
Supprime un produit DELETE
/v1/sites/{code_site}/catalog/products/{product_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
Détail d'un produit GET
/v1/sites/{code_site}/catalog/products/{product_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
variantsVariantes du produit
textsChamps texte1 à texte15
price_labelPrix dans la devise du site
imagesIllustrations du produit
defaultsValeurs par défaut du référencement

Format de sortie :

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",
    "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_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"
        }
    ]
}
NomTypeDescription
product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
available_date_fstringDate de disponibilité formatée
is_visiblebooleanProduit affiché sur le site
stockstringProduit en stock. Les valeurs possibles sont : yes, no, partial
view_countintegerNombre de vus
is_virtualbooleanProduit virtuel
brand_idFacultatifintegerIdentifiant de la marque
brand_nameFacultatifstringIntitulé de la marque
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
extra_shippingFacultatiffloatFrais de port supplémentaire
comments_countintegerNombre de commentaires
ratefloatNote du produit
bought_countintegerNombre d'achat
variants_countintegerNombre de variantes
soldout_countintegerNombre de variantes en rupture
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
namestringIntitulé du produit
descriptionstringDescription du produit
headerstringEntête du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
layout_idFacultatifintegerIdentifiant de la mise en page
text1FacultatifstringChamp texte1
text2FacultatifstringChamp texte2
text3FacultatifstringChamp texte3
text4FacultatifstringChamp texte4
text5FacultatifstringChamp texte5
text6FacultatifstringChamp texte6
text7FacultatifstringChamp texte7
text8FacultatifstringChamp texte8
text9FacultatifstringChamp texte9
text10FacultatifstringChamp texte10
text11FacultatifstringChamp texte11
text12FacultatifstringChamp texte12
text13FacultatifstringChamp texte13
text14FacultatifstringChamp texte14
text15FacultatifstringChamp texte15
tagsFacultatifobject
tag_idintegerIdentifiant du tag
namestringIntitulé du tag
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
variantsFacultatifobjectVariantes
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
imagesFacultatifobjectIllustrations
media_idintegerIdentifiant du média
positionintegerPosition du média dans la liste
namestringIntitulé du média
original_namestringNom d'origine du fichier
Liste les illustrations produits GET
/v1/sites/{code_site}/catalog/products/{product_id}/images.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit

Format de sortie :

data:[
    {
        "media_id": "integer",
        "position": "integer",
        "name": "string",
        "original_name": "string"
    }
]
NomTypeDescription
media_idintegerIdentifiant du média
positionintegerPosition du média dans la liste
namestringIntitulé du média
original_namestringNom 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 :

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

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
orderObligatoirearrayListe 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
media_idObligatoireintegerIentifiant de l'image
is_mainbooleanImage 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
media_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
categoriesListe des catégories
price_labelPrix dans la devise du site

Format de sortie :

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"
    }
]
NomTypeDescription
linked_product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
is_visiblebooleanProduit affiché sur le site
is_virtualbooleanProduit virtuel
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
namestringIntitulé du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
linkFacultatifstringType 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
linked_productsObligatoirearrayListe des identifiants des produit à lier
linkObligatoirestringDétermine le type de la liaison :
atobLe produit associé s'affiche sur la fiche du produit principal
btoaLe produit principal s'affiche sur la fiche du produit associé
bothAffichage 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
linked_product_idObligatoireintegerIdentifiant du produit lié
linkObligatoirestringDétermine le type de la liaison :
atobLe produit associé s'affiche sur la fiche du produit principal
btoaLe produit principal s'affiche sur la fiche du produit associé
bothAffichage réciproque

Les valeurs attendues sont : atob, btoa, both

Format de sortie :

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"
}
NomTypeDescription
linked_product_idintegerIdentifiant du produit
is_spotlightbooleanProduit vedette
available_datestringDate de disponibilité
is_visiblebooleanProduit affiché sur le site
is_virtualbooleanProduit virtuel
price_ex_vat_minfloatPrix minimum hors TVA
price_ex_vat_maxfloatPrix maximum hors TVA
price_inc_vat_minfloatPrix minimum avec TVA
price_inc_vat_maxfloatPrix maximum avec TVA
price_ex_vat_min_labelFacultatifstringPrix minimum hors TVA avec devise
price_ex_vat_max_labelFacultatifstringPrix maximum hors TVA avec devise
price_inc_vat_min_labelFacultatifstringPrix minimum avec TVA avec devise
price_inc_vat_max_labelFacultatifstringPrix maximum avec TVA avec devise
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
is_discountbooleanProduit en promotion
price_base_ex_vatFacultatiffloatPrix barré hors TVA
price_base_inc_vatFacultatiffloatPrix barré avec TVA
price_base_ex_vat_labelFacultatifstringPrix barré hors TVA avec devise
price_base_inc_vat_labelFacultatifstringPrix barré avec TVA avec devise
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
namestringIntitulé du produit
typestringType de fiche produit
main_media_idFacultatifintegerIdentifiant de l'illustration principale
slugstringNom optimisé
categoriesFacultatifobjectCatégories
category_idintegerIdentifiant de la catégorie
namestringIntitulé de la catégorie
is_mainbooleanCatégorie principale
linkFacultatifstringType 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
linked_product_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
namestringIntitulé de la variante
tax_idintegerIdentifiant de la taxe de la variante
price_ex_vatfloatPrix HT de la variante
price_inc_vatfloatPrix TTC de la variante
price_discount_ex_vatfloatPrix promo HT de la variante
price_discount_inc_vatfloatPrix promo TTC de la variante
price_ecotaxfloatEco-taxe de la variante
stockintegerNombre de produit en stock. Ne pas spécifier le champ pour définir un stock illimité
weightintegerPoids en gramme de la variante
referencestringRéférence de la variante
gtinstringCode EAN de la variante
conditionstringEtat de la variante
media_idintegerIdentifiant du média de la variante
file_idintegerIdentifiant du fichier à télécharger de la variante
variant_idintegerIdentifiant de la variante à dupliquer

Format de sortie :

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"
}
NomTypeDescription
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
orderObligatoirearrayListe 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
variant_idObligatoireintegerIdentifiant de la variante
namestringIntitulé de la variante
tax_idintegerIdentifiant de la taxe de la variante
price_ex_vatfloatPrix HT de la variante
price_inc_vatfloatPrix TTC de la variante
price_discount_ex_vatfloatPrix promo HT de la variante
price_discount_inc_vatfloatPrix promo TTC de la variante
price_ecotaxfloatEco-taxe de la variante
stockintegerNombre de produit en stock
is_stock_unlimitedbooleanDéfinit le stock comme illimité
weightintegerPoids en gramme de la variante
referencestringRéférence de la variante
gtinstringCode EAN de la variante
conditionstringEtat de la variante
media_idintegerIdentifiant du média de la variante
file_idintegerIdentifiant du fichier à télécharger de la variante

Format de sortie :

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"
}
NomTypeDescription
variant_idintegerIdentifiant de la variante
namestringIntitulé de la variante
referencestringRéférence
gtinstringCode EAN
conditionstringEtat de conditionnement
weightintegerPoids en gramme
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_discount_ex_vatFacultatiffloatPrix promo hors TVA
price_discount_inc_vatFacultatiffloatPrix promo avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_discount_ex_vat_labelFacultatifstringPrix promo hors TVA avec devise
price_discount_inc_vat_labelFacultatifstringPrix promo avec TVA avec devise
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_stock_unlimitedbooleanStock illimité
stockintegerQuantité en stock
positionintegerPosition dans la liste des variantes
media_idintegerIdentifiant de l'illustration
file_idFacultatifintegerIdentifiant du fichier à télécharger (pour les produits virutels)
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
variant_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
structureDétail des structures des types

Format de sortie :

data:[
    {
        "type": "string",
        "name": "string",
        "position": "integer",
        "fields": [
            {
                "field": "string",
                "type": "string",
                "name": "string",
                "options": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    }
]
NomTypeDescription
typestringIdentifiant du type de schéma
namestringIntitulé du type de schéma
positionintegerOrdre du type de schéma
fieldsFacultatifobjectStructure des champs
fieldstringNom du champ. Les valeurs possibles sont : title, subtitle, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15
typestringType de champ. Les valeurs possibles sont : text, textarea, select, wysiwyg, image, fichier
namestringIntitulé du champ
optionsobjectOptions pour un champ de type select
namestringIntitulé de l'option
valuestringValeur de l'option
Liste les intitulés de variantes GET
/v1/sites/{code_site}/catalog/variants.json

Paramètres supportés par ce endpoint :

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

Format de sortie :

data:[
    {
        "name": "string"
    }
]
NomTypeDescription
namestringIntitulé de la variante
Liste les intitulés de variantes PUT
/v1/sites/{code_site}/catalog/variants.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
fromstringIntitulé d'origine
tostringNouvel intitulé

Taxes

Liste les taxes GET
/v1/sites/{code_site}/catalog/taxes.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

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"
    }
]
NomTypeDescription
tax_idintegerIdentifiant de la taxe
vat_ratefloatPourcentage de taxe
is_defaultbooleanTaxe par défaut
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp 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 :

NomTypeDescription
code_siteObligatoirestringCode site
vat_ratefloatTaux de la taxe
is_defaultbooleanTaxe par défaut

Format de sortie :

data:[]
NomTypeDescription
Détail d'une taxe GET
/v1/sites/{code_site}/catalog/taxes/{tax_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tax_idObligatoireintegerIdentifiant de la taxe

Format de sortie :

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"
}
NomTypeDescription
tax_idintegerIdentifiant de la taxe
vat_ratefloatPourcentage de taxe
is_defaultbooleanTaxe par défaut
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp 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 :

NomTypeDescription
code_siteObligatoirestringCode site
tax_idObligatoireintegerIdentifiant de la taxe
vat_ratefloatTaux de la taxe
is_defaultbooleanTaxe par défaut
Supprime une taxe DELETE
/v1/sites/{code_site}/catalog/taxes/{tax_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tax_idObligatoireintegerIdentifiant de la taxe

Marques

Liste les marques GET
/v1/sites/{code_site}/catalog/brands.json

Paramètres supportés par ce endpoint :

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

Format de sortie :

data:[
    {
        "brand_id": "integer",
        "name": "string"
    }
]
NomTypeDescription
brand_idintegerIdentifiant de la marque
namestringIntitulé de la marque
Ajoute une marque POST
/v1/sites/{code_site}/catalog/brands.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
nameObligatoirestringIntitulé de la marque

Format de sortie :

data:[]
NomTypeDescription
Détail d'une marque GET
/v1/sites/{code_site}/catalog/brands/{brand_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
brand_idObligatoireintegerIdentifiant de la marque

Format de sortie :

data:{
    "brand_id": "integer",
    "name": "string"
}
NomTypeDescription
brand_idintegerIdentifiant de la marque
namestringIntitulé de la marque
Modifie une marque PUT
/v1/sites/{code_site}/catalog/brands/{brand_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
brand_idObligatoireintegerIdentifiant de la marque
nameObligatoirestringIntitulé de la marque
Supprime une marque DELETE
/v1/sites/{code_site}/catalog/brands/{brand_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
brand_idObligatoireintegerIdentifiant de la marque

Tags

Liste les tags GET
/v1/sites/{code_site}/catalog/tags.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringRecherche par libellé
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
name / -nameTri alphabétique

Format de sortie :

data:[
    {
        "tag_id": "integer",
        "name": "string"
    }
]
NomTypeDescription
tag_idintegerIdentifiant du tag
namestringIntitulé du tag
Supprime un tag DELETE
/v1/sites/{code_site}/catalog/tags/{tag_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tag_idObligatoireintegerIdentifiant du tag

Commentaires

Liste les commentaires GET
/v1/sites/{code_site}/catalog/comments.json

Paramètres supportés par ce endpoint :

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

Format de sortie :

data:[
    {
        "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"
    }
]
NomTypeDescription
comment_idintegerIdentifiant du commentaire
is_visiblebooleanAffichage du commentaire
datestringDate du commentaire
commentstringContenu du commentaire
originstringOrigine du commentaire. Les valeurs possibles sont : client, anonyme, admin
authorstringNom de l'auteur
ipstringAdresse IP de l'auteur
rateintegerNote du produit
reverse_hoststringReverse host de l'adresse IP
product_idintegerIdentifiant du produit
product_namestringIntitulé du produit
customer_idFacultatifintegerIdentifiant du client
customer_nameFacultatifstringNom du client
customer_emailFacultatifstringEmail du client
customer_nicknameFacultatifstringPseudo du client
avatar_urlstringUrl de l'avatar du client
avatar_thumb_urlstringUrl de l'avatar miniature du client
Ajoute un commentaire POST
/v1/sites/{code_site}/catalog/comments.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
product_idObligatoireintegerIdentifiant du produit
commentObligatoirestringTexte du commentaire
is_visiblebooleanAfficher le commentaire
rateintegerNote du produit
Détail d'un commentaire GET
/v1/sites/{code_site}/catalog/comments/{comment_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
comment_idObligatoireintegerIdentifiant du commentaire

Format de sortie :

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"
}
NomTypeDescription
comment_idintegerIdentifiant du commentaire
is_visiblebooleanAffichage du commentaire
datestringDate du commentaire
commentstringContenu du commentaire
originstringOrigine du commentaire. Les valeurs possibles sont : client, anonyme, admin
authorstringNom de l'auteur
ipstringAdresse IP de l'auteur
rateintegerNote du produit
reverse_hoststringReverse host de l'adresse IP
product_idintegerIdentifiant du produit
product_namestringIntitulé du produit
customer_idFacultatifintegerIdentifiant du client
customer_nameFacultatifstringNom du client
customer_emailFacultatifstringEmail du client
customer_nicknameFacultatifstringPseudo du client
avatar_urlstringUrl de l'avatar du client
avatar_thumb_urlstringUrl de l'avatar miniature du client
Modifie un commentaire PUT
/v1/sites/{code_site}/catalog/comments/{comment_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
comment_idObligatoireintegerIdentifiant du commentaire
is_visiblebooleanAfficher le commentaire
authorstringNom de l'auteur du commentaire
commentstringTexte du commentaire
Supprime un commentaire DELETE
/v1/sites/{code_site}/catalog/comments/{comment_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
comment_idObligatoireintegerIdentifiant du commentaire
Liste les commentaires d'un produit GET
/v1/sites/{code_site}/catalog/products/{product_id}/comments.json

Paramètres supportés par ce endpoint :

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

Format de sortie :

data:[
    {
        "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"
    }
]
NomTypeDescription
comment_idintegerIdentifiant du commentaire
is_visiblebooleanAffichage du commentaire
datestringDate du commentaire
commentstringContenu du commentaire
originstringOrigine du commentaire. Les valeurs possibles sont : client, anonyme, admin
authorstringNom de l'auteur
ipstringAdresse IP de l'auteur
rateintegerNote du produit
reverse_hoststringReverse host de l'adresse IP
product_idintegerIdentifiant du produit
product_namestringIntitulé du produit
customer_idFacultatifintegerIdentifiant du client
customer_nameFacultatifstringNom du client
customer_emailFacultatifstringEmail du client
customer_nicknameFacultatifstringPseudo du client
avatar_urlstringUrl de l'avatar du client
avatar_thumb_urlstringUrl 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 :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idintegerIdentifiant du dossier
termstringTerme recherché
sortstringDétermine l'ordre de tri parmis les critères suivants :
nameTri selon le nom du fichier
-dateTri selon la date de modification
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "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"
    }
]
NomTypeDescription
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
namestringIntitulé du fichier
descriptionstringDescription du fichier
folder_idintegerIdentifiant du dossier
fileObligatoirefileFichier à envoyer

Format de sortie :

data:[]
NomTypeDescription
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 :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média

Format de sortie :

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"
}
NomTypeDescription
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média
namestringIntitulé du fichier
descriptionstringDescription du fichier
filefileFichier à 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 :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média
Liste les dossiers racines GET
/v1/sites/{code_site}/catalog/downloads/folders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
recursiveExtrait toute l'arborescence

Format de sortie :

data:[
    {
        "folder_id": "integer",
        "name": "string",
        "parent_folder_id": "integer",
        "folder_key": "string",
        "creation_date": "string",
        "modification_date": "string"
    }
]
NomTypeDescription
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
folder_keyFacultatifstringClé API du dossier
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
namestringNom du dossier
parent_folder_idintegerIdentifiant du dossier parent

Format de sortie :

data:[]
NomTypeDescription
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 :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier

Format de sortie :

data:{
    "folder_id": "integer",
    "name": "string",
    "parent_folder_id": "integer",
    "folder_key": "string",
    "creation_date": "string",
    "modification_date": "string"
}
NomTypeDescription
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
folder_keyFacultatifstringClé API du dossier
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
nameObligatoirestringNom 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 :

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

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
sortarrayDétermine l'ordre de tri parmis les critères suivants :
nameTri selon le nom du fichier
-dateTri selon la date de modification