Versions Compared

Old Version 7

changes.mady.by.user Shree Harsha Sridharamurthy

Saved on

compared with

New Version 8

changes.mady.by.user Shree Harsha Sridharamurthy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API Response Examples below display what properties are returned for each element.

Pagination Object

Expand
titleClick to expand pagination object
Code Block
languagejson
"Pagination": {
      "NofResults": 173,
      "CurrentPage": 1,
      "Items": [
         {
            "Label": "12 Items Per Page",
            "PageSize": 12,
            "IsDefault": true,
            "Selected": true
         },
         {
            "Label": "24 Items Per Page",
            "PageSize": 24,
            "IsDefault": false,
            "Selected": false
         },
         {
            "Label": "36 Items Per Page",
            "PageSize": 36,
            "IsDefault": false,
            "Selected": false
         },
         {
            "Label": "72 Items Per Page",
            "PageSize": 72,
            "IsDefault": false,
            "Selected": false
         }
      ],
      "MaxPerPage": 12,
      "NofPages": 15
   }

Sorting Object

Expand
titleClick to expand sorting object
Code Block
"Sorting": {
      "Value": "score",
      "Items": [
         {
            "Label": "Best Match",
            "Value": "score",
            "IsDefault": true,
            "Selected": true
         },
         {
            "Label": "Price: Lowest to Highest",
            "Value": "salepriceasc",
            "IsDefault": false,
            "Selected": false
         },
         {
            "Label": "Price: Highest to Lowest",
            "Value": "salepricedesc",
            "IsDefault": false,
            "Selected": false
         }
      ]
   }

Results Object

Expand
titleClick to expand Results Object
Code Block
languagejson
"Results": [
      {
         "Score": 0.005307952,
         "ItemName": "Logo Hat - The North Face",
         "ImageURL": "/assets/1/14/DimThumbnail/{DE7A166C-24F5-453B-B970-A30BD746C21D}.jpg",
         "ImageAlt": "10187",
         "Id": "Item_74303",
         "CustomURL": "/products/logo-hat-the-north-face/",
         "TrackingId": "1213044",
         "Brand": "The North Face",
         "Price": "18",
         "SalePrice": "18",
         "IsOnSale": false,
         "BestFragment": "... - the <b>north<\/b> <b>face<\/b> the logo hat has the <b>north<\/b> <b>face<\/b> logo and &#39;1968&#39; embroidered on this washed cotton twill hat.&#60;br&#62; &#60;br&#62;   men accessories hats & headwear specials sat dec 15th kids women accessories hats & headwear women hats & headwear caps men hats & headwear caps the <b>north<\/b> ...",
         "MinPrice": "18",
         "MaxPrice": "18",
         "MinSalePrice": "0",
         "MaxSalePrice": "0"
      },
      {
         "Score": 7.017364E-4,
         "ItemName": "Baby Llama Beanie",
         "ImageURL": "/assets/1/14/DimThumbnail/The-North-Face-Baby-Llama-Beanie-jake-blue.jpg",
         "ImageAlt": "Llama",
         "Id": "Item_118551",
         "CustomURL": "/products/baby-llama-beanie-/",
         "TrackingId": "1213044",
         "Brand": "The North Face",
         "Price": "25",
         "SalePrice": "11.97",
         "IsOnSale": true,
         "BestFragment": "... design, the <b>north<\/b> <b>face<\/b> baby llama beanie is about the cutest thing you can pull on your baby&#39;s head. made from lightweight acrylic fibers, this <b>north<\/b> <b>face<\/b> hat has a fleece ear band for extra warmth and a soft feel against the skin.&#60;&#47;div&#62;&#60;div&#62;&#38;nbsp&#59;&#60;&#47;div&#62;&#60;&#47;div&#62;&#60;&#47;div&#62; ...",
         "MinPrice": "25",
         "MaxPrice": "25",
         "MinSalePrice": "11.97",
         "MaxSalePrice": "11.97"
      }
   ]

Facets Object

Expand
titleClick to expand the Facets object
Code Block
languagejson
"Facets": [
      {
         "FacetId": 114,
         "Name": "Search within",
         "Field": "",
         "FieldType": "search",
         "FacetType": "search",
         "DisplayType": "default",
         "MaxCount": 0,
         "MinHitCount": 0,
         "NofVisible": 0,
         "ParamName": "",
         "ExpandSelection": false,
         "IsNumeric": false,
         "IsCurrency": false,
         "IsSearch": false,
         "ScrollHeight": 0,
         "ScrollThreshold": 0,
         "TruncateThreshold": 0,
         "SearchThreshold": 0,
         "AlwaysVisible": true,
         "Values": []
      },
      {
         "FacetId": 272,
         "Name": "Brands",
         "Field": "brand",
         "FieldType": "string",
         "FacetType": "checkbox",
         "DisplayType": "scrolling",
         "MaxCount": 500,
         "MinHitCount": 1,
         "NofVisible": 10,
         "ParamName": "brand",
         "ExpandSelection": true,
         "IsNumeric": false,
         "IsCurrency": false,
         "IsSearch": true,
         "ScrollHeight": 150,
         "ScrollThreshold": 10,
         "TruncateThreshold": 0,
         "SearchThreshold": 10,
         "AlwaysVisible": true,
         "Values": [
            {
               "Label": "The North Face",
               "Value": "The North Face"
            },
            {
               "Label": "Patagonia",
               "Value": "Patagonia"
            }
         ]
  },
      {
         "FacetId": 95,
         "Name": "Department",
         "Field": "department",
         "FieldType": "string",
         "FacetType": "checkbox",
         "DisplayType": "scrolling",
         "MaxCount": 200,
         "MinHitCount": 1,
         "NofVisible": 5,
         "ParamName": "department",
         "ExpandSelection": true,
         "IsNumeric": true,
         "IsCurrency": false,
         "IsSearch": true,
         "ScrollHeight": 150,
         "ScrollThreshold": 5,
         "TruncateThreshold": 10,
         "SearchThreshold": 5,
         "AlwaysVisible": true,
         "Values": [
            {
               "Label": "Specials",
               "Value": "Specials"
            },
            {
               "Label": "Sale",
               "Value": "Sale"
            },
            {
               "Label": "Men",
               "Value": "Men"
            },
            {
               "Label": "Women",
               "Value": "Women"
            },
            {
               "Label": "Footwear",
               "Value": "Footwear"
            }
         ]
      }
] 

Selections Object

Code Block
     "Selections": {
      "department": {
         "Label": "Department",
         "Items": [
            {
               "Label": "Kids",
               "Value": "Kids"
            }
         ]
      }
   }

...