Sample request

curl --GET
     --data 'countryCode=in' \
     --data 'q=laptop' \
     --url 'https://api.shopalyst.com/v1/products' \  
     --header 'accept: application/json' \
     --header 'apikey: <your API Key>'

Request fields

Field	Description	Data Type
countryCode	Country code (us - USA, in - India), List of country codes	string
index	Start index for pagination. You can use this parameter to retrieve specific pages of search results	number
limit	Number of results per page. This parameter allows you to control the number of results displayed on each page	number
q	Query string for product search. You can use this parameter to specify keywords or search terms for product searches	string
merchantFilter	Merchant (Retailer) filter. You can use this parameter to filter products by a specific merchant	string
brandFilter	Brand filter. You can use this parameter to filter products by a specific brand	string
categoryFilter	Category filter. You can use this parameter to filter products by a specific category	string
divisionFilter	Division filter. You can use this parameter to filter products by a specific division	string
mode	Response mode Available options are :- lite - retrieves limited set of product attributes full - retrieves all product attributes	string

Sample response

Sample response for lite mode

{
  "productList": [
    {
      "active": true,
      "category": "Skin Care",
      "categoryRank": 254,
      "changed": false,
      "discount": 0,
      "division": "beauty",
      "extAttributes": {},
      "imageUrl": "https://m.media-amazon.com/images/I/71ySaKSfuVL._SL1500_.jpg",
      "lastChangedTime": 0,
      "merchant": "amazon",
      "newArrival": false,
      "offerPrice": 4.69,
      "productId": "12B25C555DE21FCC5471C32A36AC9A1C",
      "productUrl": "http://www.shortlyst.com/stores/#/product/12B25C555DE21FCC5471C32A36AC9A1C",
      "salePrice": 4.69,
      "seoTitle": "dove-beauty-bar-more-moisturizing-than-bar-soap-for-softer-skin-fragrance-free-hypoallergenic-sensitive-skin-with-gentle-cleanser-3-75-oz-2-bars",
      "title": "Dove Beauty Bar More Moisturizing Than Bar Soap for Softer Skin, Fragrance Free, Hypoallergenic Sensitive Skin With Gentle Cleanser 3.75 oz, 2 Bars",
      "trendingRank": 0,
      "trueDiscount": 0
    }
  ],
  "facets": [
    {
      "name": "gender",
      "value": {
        "men": 31,
        "women": 8
      }
    },
    {
      "name": "silhouette",
      "value": {
        "bath & shower": 40,
        "fragrance": 30,
        "hair care & styling": 21,
        "skin care": 13
      }
    },
    {
      "name": "merchant",
      "value": {
        "amazon": 122
      }
    },
    {
      "name": "brand",
      "value": {
        "dove": 122
      }
    },
    {
      "name": "pattern",
      "value": {}
    },
    {
      "name": "primaryColor",
      "value": {}
    },
    {
      "name": "fabric",
      "value": {}
    },
    {
      "name": "occasion",
      "value": {}
    },
    {
      "name": "price",
      "value": {
        "0 - 999": 122
      }
    },
    {
      "name": "discount",
      "value": {
        "10": 3,
        "20": 5,
        "30": 3,
        "40": 6,
        "50": 5,
        "60": 3,
        "70": 3,
        "80": 6,
        "90": 5
      }
    },
    {
      "name": "size",
      "value": {}
    },
    {
      "name": "subSilhouette",
      "value": {
        "deodorants & antiperspirants": 30,
        "body washes": 19,
        "hair care": 19,
        "soaps": 10,
        "body": 9,
        "body scrubs": 8,
        "face": 4,
        "bath sets & kits": 2,
        "styling": 2,
        "bath additives": 1
      }
    }
  ],
  "success": true,
  "numFound": 122,
  "q": "fq=merchant:(\"amazon\")&fq=brand:(\"dove\")&fq=division:(\"beauty\")&start=0&rows=1&fl=productId,merchant,productUrl,salePrice,offerPrice,title,imageUrl,active,trueDiscount,bestsellersRank,division,category,categoryRank&json.facet={\"brand\":{\"terms\":{\"field\":\"brand\",\"limit\":50,\"mincount\":1}},\"discount_facet\":{\"terms\":{\"field\":\"discount_facet\",\"limit\":50,\"mincount\":1}},\"fabric_facet\":{\"terms\":{\"field\":\"fabric_facet\",\"limit\":50,\"mincount\":1}},\"gender_facet\":{\"terms\":{\"field\":\"gender_facet\",\"limit\":50,\"mincount\":1}},\"merchant\":{\"terms\":{\"field\":\"merchant\",\"limit\":50,\"mincount\":1}},\"occasion_facet\":{\"terms\":{\"field\":\"occasion_facet\",\"limit\":50,\"mincount\":1}},\"pattern_facet\":{\"terms\":{\"field\":\"pattern_facet\",\"limit\":50,\"mincount\":1}},\"price_facet\":{\"terms\":{\"field\":\"price_facet\",\"limit\":50,\"mincount\":1}},\"primaryColor_facet\":{\"terms\":{\"field\":\"primaryColor_facet\",\"limit\":50,\"mincount\":1}},\"silhouette_facet\":{\"terms\":{\"field\":\"silhouette_facet\",\"limit\":50,\"mincount\":1}},\"size\":{\"terms\":{\"field\":\"size\",\"limit\":50,\"mincount\":1}},\"subSilhouette_facet\":{\"terms\":{\"field\":\"subSilhouette_facet\",\"limit\":50,\"mincount\":1}}}",
  "shuffle": false,
  "featuredFacets": {
    "gender": "men,women",
    "silhouette": "bath & shower,fragrance",
    "subSilhouette": "deodorants & antiperspirants,body washes"
  }
}

Sample response for full mode

{
  "productList": [
    {
      "active": true,
      "articleType": "Cleansers",
      "attributeNames": [],
      "avgRating": 4.7,
      "brand": "dove",
      "brandName": "dove",
      "breadCrumb": "Beauty & Personal Care/Skin Care/Body/Cleansers/Soaps",
      "category": "Skin Care",
      "categoryRank": 254,
      "changed": false,
      "creationDate": 1532950390911,
      "description": "<h3>Features</h3><ul id=\"features\"><li>GENTLE ON SENSITIVE SKIN: Nourish your skin with Dove Sensitive Skin Beauty Bar. With its fragrance free and hypoallergenic formula, it gently cleanses for softer skin than ordinary bar soap</li><li>DERMATOLOGIST RECOMMENDED: Formulated with ultra-mild cleansers and ¼ moisturizing cream, Dove moisturizing Beauty Bar leaves skin instantly soft and smooth with lasting nourishment</li><li>MILD AND MOISTURIZING: Help maintain your skin’s natural moisture barrier and hydration with this Beauty Bar for women, ideal to use as a gentle face cleanser and body soap for sensitive skin</li><li>EFFECTIVE CLEANSING: A Beauty Bar that washes away dirt and germs, but won’t dry skin as ordinary bath soap can. This hypoallergenic bar is gentle enough to use every day on your body and your face</li><li>THOUGHTFULLY MADE: This Beauty Bar contains no sulfate cleansers and is certified Cruelty-Free by PETA, so you can feel good about switching from an ordinary soap bar to a Dove Beauty Bar</li><li>CARE AS YOU CLEAN: The cleansing efficacy and care you need, all in one skin care product</li></ul>\n   Dove Sensitive Skin Beauty Bar combines classic Dove cleansers and ¼ moisturizing cream in a fragrance free, hypoallergenic bar that’s gentle enough for sensitive skin. And now, we are bringing you Dove's same great formula in an all-new look. Dermatologist recommended and suitable for daily use, it can be used as a hand soap, gentle facial cleanser and body soap. Proper sensitive skin care depends on having a cleanser that truly cares for your skin and won’t dry it out like an ordinary soap can. Washing with regular soap can cause skin to feel dry and tight. What makes Dove different. It’s the combination of gentle cleansers and moisturizing ingredients that help to nourish skin. With unscented, hypoallergenic cleansers and 1/4 moisturizing cream, Dove Beauty Bar can be used as a face cleanser, as well as a gentle cleanser for your body and hands, leaving you with instantly soft skin and lasting nourishment. The secret to beautiful skin is moisture, and no ordinary bar soap hydrates skin better than Dove. At Dove, our vision is of a world where beauty is a source of confidence, not anxiety. That’s why we are on a mission to help the next generation of women develop a positive relationship with the way they look—helping them raise their self-esteem and realize their full potential.  ",
      "discount": 0,
      "division": "beauty",
      "extAttributes": {},
      "gender": "",
      "imageUrl": "https://m.media-amazon.com/images/I/71ySaKSfuVL._SL1500_.jpg",
      "images": [
        "https://m.media-amazon.com/images/I/41S5dfN+33L..jpg",
        "https://m.media-amazon.com/images/I/41b7nF7ZguL..jpg",
        "https://m.media-amazon.com/images/I/51O6wT9cVPL..jpg",
        "https://m.media-amazon.com/images/I/41AI3HgIuxL..jpg",
        "https://m.media-amazon.com/images/I/31cnXnHcuaL..jpg",
        "https://m.media-amazon.com/images/I/41rA4-rfdPL..jpg"
      ],
      "lastChangedTime": 0,
      "lastModifiedDate": 1656067661995,
      "merchant": "amazon",
      "merchantDivision": "Beauty & Personal Care",
      "newArrival": false,
      "normalizedArticleType": "soaps",
      "normalizedCategory": "bath & shower",
      "normalizedSubCategory": "soaps",
      "offerPrice": 4.69,
      "productId": "12B25C555DE21FCC5471C32A36AC9A1C",
      "productUrl": "http://www.shortlyst.com/stores/#/product/12B25C555DE21FCC5471C32A36AC9A1C",
      "ratingScore": 0,
      "ratingsCount": 477,
      "reviewsCount": 18,
      "salePrice": 4.69,
      "seoTitle": "dove-beauty-bar-more-moisturizing-than-bar-soap-for-softer-skin-fragrance-free-hypoallergenic-sensitive-skin-with-gentle-cleanser-3-75-oz-2-bars",
      "skuSet": [
        {
          "attributes": {},
          "available": true,
          "ean": "",
          "hasAltUrl": false,
          "inventoryQuantity": 0,
          "offerPrice": 4.69,
          "rank": 0,
          "salePrice": 4.69,
          "skuId": "B000VAWYBM"
        }
      ],
      "subCategory": "Body",
      "title": "Dove Beauty Bar More Moisturizing Than Bar Soap for Softer Skin, Fragrance Free, Hypoallergenic Sensitive Skin With Gentle Cleanser 3.75 oz, 2 Bars",
      "trendingRank": 999999,
      "trueDiscount": 0,
      "vendor": "NA",
      "videos": [
        "https://m.media-amazon.com/images/S/vse-vms-transcoding-artifact-us-east-1-prod/d5a3f315-2752-40b7-b6a7-1c5edb6c143e/default.jobtemplate.mp4.480.mp4"
      ]
    }
  ],
  "facets": [
    {
      "name": "gender",
      "value": {
        "men": 31,
        "women": 8
      }
    },
    {
      "name": "silhouette",
      "value": {
        "bath & shower": 40,
        "fragrance": 30,
        "hair care & styling": 21,
        "skin care": 13
      }
    },
    {
      "name": "merchant",
      "value": {
        "amazon": 122
      }
    },
    {
      "name": "brand",
      "value": {
        "dove": 122
      }
    },
    {
      "name": "pattern",
      "value": {}
    },
    {
      "name": "primaryColor",
      "value": {}
    },
    {
      "name": "fabric",
      "value": {}
    },
    {
      "name": "occasion",
      "value": {}
    },
    {
      "name": "price",
      "value": {
        "0 - 999": 122
      }
    },
    {
      "name": "discount",
      "value": {
        "10": 3,
        "20": 5,
        "30": 3,
        "40": 6,
        "50": 5,
        "60": 3,
        "70": 3,
        "80": 6,
        "90": 5
      }
    },
    {
      "name": "size",
      "value": {}
    },
    {
      "name": "subSilhouette",
      "value": {
        "deodorants & antiperspirants": 30,
        "body washes": 19,
        "hair care": 19,
        "soaps": 10,
        "body": 9,
        "body scrubs": 8,
        "face": 4,
        "bath sets & kits": 2,
        "styling": 2,
        "bath additives": 1
      }
    }
  ],
  "success": true,
  "numFound": 122,
  "q": "fq=merchant:(\"amazon\")&fq=brand:(\"dove\")&fq=division:(\"beauty\")&start=0&rows=1&fl=productId,merchant,productUrl,salePrice,offerPrice,title,imageUrl,active,trueDiscount,bestsellersRank,division,category,categoryRank&json.facet={\"brand\":{\"terms\":{\"field\":\"brand\",\"limit\":50,\"mincount\":1}},\"discount_facet\":{\"terms\":{\"field\":\"discount_facet\",\"limit\":50,\"mincount\":1}},\"fabric_facet\":{\"terms\":{\"field\":\"fabric_facet\",\"limit\":50,\"mincount\":1}},\"gender_facet\":{\"terms\":{\"field\":\"gender_facet\",\"limit\":50,\"mincount\":1}},\"merchant\":{\"terms\":{\"field\":\"merchant\",\"limit\":50,\"mincount\":1}},\"occasion_facet\":{\"terms\":{\"field\":\"occasion_facet\",\"limit\":50,\"mincount\":1}},\"pattern_facet\":{\"terms\":{\"field\":\"pattern_facet\",\"limit\":50,\"mincount\":1}},\"price_facet\":{\"terms\":{\"field\":\"price_facet\",\"limit\":50,\"mincount\":1}},\"primaryColor_facet\":{\"terms\":{\"field\":\"primaryColor_facet\",\"limit\":50,\"mincount\":1}},\"silhouette_facet\":{\"terms\":{\"field\":\"silhouette_facet\",\"limit\":50,\"mincount\":1}},\"size\":{\"terms\":{\"field\":\"size\",\"limit\":50,\"mincount\":1}},\"subSilhouette_facet\":{\"terms\":{\"field\":\"subSilhouette_facet\",\"limit\":50,\"mincount\":1}}}",
  "shuffle": false,
  "featuredFacets": {
    "gender": "men,women",
    "silhouette": "bath & shower,fragrance",
    "subSilhouette": "deodorants & antiperspirants,body washes"
  }
}

Response Fields

Field	Description	Data Type
active	Indicates whether the product is currently active	bool
articleType	Describes the type of product (e.g., "Cleansers")	string
avgRating	Represents the average product rating	float
brand	The brand of the product	string
category	Product category	string
description	Product description, possibly including HTML content	string
discount	Discount (in percentage)	float
division	Product Division	string
gender	Gender	string
imageUrl	URL to the product's image	string
images	An array of URLs for additional images of the product	array`<string>`
merchant	Merchant (Retailer) name	string
offerPrice	The price at which the product is offered	float
productId	A unique identifier for the product	string
productUrl	Product URL	string
ratingScore	Product's overall rating score	float
ratingsCount	The number of ratings/reviews for the product	number
reviewsCount	The number of reviews for the product	number
salePrice	The sale price (MRP) of the product	float
seoTitle	The SEO-friendly title of the product	string
skuSet	An array of SKU (Stock Keeping Unit) details for the product	array`<SKU>`
subCategory	Product sub category	string
title	Product title	string
trendingRank	The trending rank of the product.	number
vendor	The product's vendor	string
videos	An array of URLs to product-related videos	array`<string>`

200successful operation