Search Products

Some details on the API query params

advanced_search is an object containing an array must
The array must should contain one string query and a list of fields fields defining where the query should apply. Must acts as a AND between queries

• Filter types: must
• Supported fields : namePublicLong.data , composition.data , allergens.data , brand.label , kind.label , description.data
• Query object: {query: value, fields: []}

{
    "advanced_search": {
        "must": [
            {
                "query": "jam",
                "fields": [
                    "namePublicLong.data"
                ]
            }
        ]
    }
}

In the example below, the result contains products having:

• BOTH jam and organic words
• jam being in the product name OR the product kind OR the description
• organic being in the product name OR the description

{
    "advanced_search": {
        "must": [
            {
                "query": "jam",
                "fields": [
                    "namePublicLong.data",
                    "kind.label",
                    "description.data" 
                ]
            },
            {
                "query": "organic",
                "fields": [
                    "namePublicLong.data",
                    "description.data" 
                ]
            }
        ]
    }
}

Some details on the API response:

• All the available fields are documented Attributes documentation
• Most fields are only applicable to certain categories of products.
• The API only returns the fields that are filled for a product. If a field is not present in the output, the data has not yet been filled for this product.
• This API is paginated, to view the full data, you will have to make several calls, increasing the offset parameter each time.