Recherche

Pages du site web

Recherche site web GET

`/api/v1/search/cms/pages.json`

Effectue une recherche dans les pages du site web

Paramètres supportés par ce endpoint :

Nom Type Description

term Obligatoire string Terme de recherche

fields array Liste de champs dans lesquels restreindre la recherche du terme. Parmis les valeurs suivantes : title, subtitle, text1 à text15

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)

sort

array

Ordres de tri parmis les critères suivants :

page / -page	Tri par page
date / -date	Tri selon la date de dernière mise à jour du billet

extra_fields

array

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

texts

Inclut les champs text1 à text15 de chaque billet de page

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "title": "string",
        "subtitle": "string",
        "group": "string",
        "type": "string",
        "page_title": "string",
        "page_slug": "string",
        "url": "string",
        "is_home": "boolean",
        "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"
    }
]

Nom	Type	Description
`id`	integer	Identifiant de la page
`title`	string	Titre du billet
`subtitle`	string	Sous titre du billet
`group`	string	Groupe du billet
`type`	string	Type du billet
`page_title`	string	Titre de la page
`page_slug`	string	Nom optimisé de la page
`url`	string	URL de la page
`is_home`	boolean	Page d'accueil
`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

Billets du blog

Recherche blog GET

`/api/v1/search/blog/posts.json`

Effectue une recherche dans les billets du blog

Paramètres supportés par ce endpoint :

Nom Type Description

term Obligatoire string Terme de recherche

fields array Liste de champs dans lesquels restreindre la recherche du terme. Parmis les valeurs suivantes : title, header, content

is_pinned boolean Billets épinglés

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)

sort

array

Ordres de tri parmis les critères suivants :

date / -date	Tri selon la date de création du billet
title / -title	Tri par titre de billet
category / -category	Tri selon l'intitulé de la categorie
author / -author	Tri selon l'auteur du billet

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "title": "string",
        "type": "string",
        "is_pinned": "boolean",
        "header": "string",
        "has_comments_open": "boolean",
        "comments_count": "integer",
        "content": "string",
        "thumb": {
            "id": "integer",
            "title": "string",
            "description": "string",
            "url": "string",
            "url_miniature": "string",
            "url_vignette": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string"
        },
        "excerpt": "string",
        "author": "string",
        "slug": "string",
        "url": "string",
        "permalink": "string",
        "category_id": "integer",
        "category_slug": "string",
        "category_name": "string",
        "category_url": "string",
        "publication_date": "string",
        "publication_date_f": "string",
        "publication_date_timestamp": "integer"
    }
]

Nom	Type	Description
`id`	integer	Identifiant du billet
`title`	string	Titre du billet
`type`	string	Type du billet
`is_pinned`	boolean	Billet épinglé
`header`	string	Chapô
`has_comments_open`	boolean	Commentaires ouverts
`comments_count`	integer	Nombre de commentaires
`content`	string	Contenu du billet
`thumb`Facultatif	object	Illustration
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`excerpt`	string	Accroche
`author`	string	Auteur
`slug`	string	Nom optimisé
`url`	string	Chemin du billet
`permalink`	string	URL canonique du billet
`category_id`	integer	Identifiant de la catégorie
`category_slug`	string	Nom optimisé de la catégorie
`category_name`	string	Nom de la catégorie
`category_url`	string	URL de la catégorie
`publication_date`	string	Date de publication
`publication_date_f`	string	Date de publication formatée
`publication_date_timestamp`	integer	Timestamp de la date de publication

Produits du catalogue

Recherche catalogue GET

`/api/v1/search/catalog/products.json`

Effectue une recherche dans les produits du catalogue

Paramètres supportés par ce endpoint :

Nom Type Description

term string Terme de recherche

price_min float Prix minimum des produits

price_max float Prix maximum des produits

category_id array Identifiants de catégories

tags array Liste de tags

types array Types de produits

fields array Liste de champs dans lesquels restreindre la recherche du terme. Parmis les valeurs suivantes : name, header, description, brand_name, text1 à text15

availability_start_month integer Date de début de disponibilité

availability_end_month integer Date de fin de disponibilité

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)

sort

array

Ordres de tri parmis les critères suivants :

price / -price	Tri selon le prix du produit
name / -name	Tri selon l'intitulé du produit
rate / -rate	Tri selon la note moyenne du produit
date / -date	Tri selon la date de disponibilité du produit
spotlight / -spotlight	Tri les produits vedette

extra_fields

array

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

texts	Inclut les champs text1 à text15 de chaque produit
price_label	Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "type": "string",
        "name": "string",
        "slug": "string",
        "excerpt": "string",
        "header": "string",
        "description": "string",
        "is_virtual": "boolean",
        "is_spotlight": "boolean",
        "is_discounted": "boolean",
        "rate": "float",
        "price_min_ex_vat": "float",
        "price_min_inc_vat": "float",
        "price_max_ex_vat": "float",
        "price_max_inc_vat": "float",
        "price_base_ex_vat": "float",
        "price_base_inc_vat": "float",
        "price_min_ex_vat_label": "string",
        "price_min_inc_vat_label": "string",
        "price_max_ex_vat_label": "string",
        "price_max_inc_vat_label": "string",
        "price_base_ex_vat_label": "string",
        "price_base_inc_vat_label": "string",
        "variants_count": "integer",
        "comments_count": "integer",
        "bought_count": "integer",
        "views_count": "integer",
        "soldout_count": "integer",
        "tags": "string",
        "url": "string",
        "category_id": "integer",
        "category_name": "string",
        "category_slug": "string",
        "category_url": "string",
        "brand_id": "integer",
        "brand_name": "string",
        "media_id": "integer",
        "media_extension": "string",
        "thumb": {
            "id": "integer",
            "title": "string",
            "description": "string",
            "url": "string",
            "url_miniature": "string",
            "url_vignette": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string"
        },
        "availability_date": "string",
        "availability_date_f": "string",
        "availability_date_timestamp": "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"
    }
]

Nom	Type	Description
`id`	integer	Identifiant du produit
`type`	string	Type du produit
`name`	string	Intitulé du produit
`slug`	string	Nom optimisé du produit
`excerpt`	string	Accroche du produit
`header`	string	Chapô du produit
`description`	string	Description du produit
`is_virtual`	boolean	Produit virtuel
`is_spotlight`	boolean	Produit vedette
`is_discounted`	boolean	Produit en promotion
`rate`	float	Note moyenne
`price_min_ex_vat`	float	Prix minimal HT
`price_min_inc_vat`	float	Prix minimal TTC
`price_max_ex_vat`	float	Prix maximal HT
`price_max_inc_vat`	float	Prix maximal TTC
`price_base_ex_vat`Facultatif	float	Prix non remisé HT pour les produits en promotion
`price_base_inc_vat`Facultatif	float	Prix non remisé TTC pour les produits en promotion
`price_min_ex_vat_label`Facultatif	string	Prix minimal HT formaté
`price_min_inc_vat_label`Facultatif	string	Prix minimal TTC formaté
`price_max_ex_vat_label`Facultatif	string	Prix maximal HT formaté
`price_max_inc_vat_label`Facultatif	string	Prix maximal TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix non remisé HT formaté pour les produits en promotion
`price_base_inc_vat_label`Facultatif	string	Prix non remisé TTC formaté pour les produits en promotion
`variants_count`	integer	Nombre de variantes
`comments_count`	integer	Nombre d'évaluations
`bought_count`	integer
`views_count`	integer
`soldout_count`	integer
`tags`	string	Tags
`url`	string	URL du produit
`category_id`	integer	Identifiant de la catégorie
`category_name`	string	Nom de la catégorie
`category_slug`	string	Nom optimisé de la catégorie
`category_url`	string	URL de la catégorie
`brand_id`Facultatif	integer	Identifiant de la marque
`brand_name`Facultatif	string	Nom de la marque
`media_id`Facultatif	integer	Identifiant de l'illustration principale du produit
`media_extension`Facultatif	string	Extension de l'illustration principale
`thumb`Facultatif	object	Illustration principale
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`availability_date`	string	Date de disponibilité
`availability_date_f`	string	Date de disponibilité formatée
`availability_date_timestamp`	integer	Timestamp de la date de disponibilité
`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