Products by Search

Using the /search-products you can search for products with the following query parameters:

• gtin show results matching the specified GTIN (Global Trade Item Number)
• name show results which contain the specified string in their name
• seller show only results from the seller specified, for a full list of sellers see the list of supported sellers
• brand show only results from the specified brand
• sort sort results by one of name, rating, price, review_count, seller (defaults to name)

Request:

curl https://shelfsignal.com/api/search-products?name=pasta \
--header "Authorization: Bearer <YOUR_API_KEY_HERE>"

Response:

{
    "credits_allocated": 100,
    "credits_used": 21,
    "data": [
        {
        "availability": "https://schema.org/InStock",
        "brand": "ASDA",
        "description": "",
        "gtin": 7701010,
        "image": "https://ui.assets-asda.com:443/dm/5063089221693",
        "name": "ASDA BBQ Chicken Pasta 250g",
        "price": 2.5,
        "rating": null,
        "review_count": 0,
        "seller": "asda",
        "sku": 1000383175759,
        "url": "https://groceries.asda.com/product/lunch-ideas/asda-bbq-chicken-pasta-250-g/1000383175759"
        },
        {
        "availability": "https://schema.org/InStock",
        "brand": "ASDA",
        "description": "",
        "gtin": 6698182,
        "image": "https://ui.assets-asda.com:443/dm/5057172341122",
        "name": "ASDA BBQ Chicken Pasta Salad",
        "price": 3.2,
        "rating": 3.68,
        "review_count": 25,
        "seller": "asda",
        "sku": 1000212268757,
        "url": "https://groceries.asda.com/product/prepared-side-salads/asda-bbq-chicken-pasta-salad/1000212268757"
        },
        ...
    ]
}