The Activate Search Item API allows for first party and third party integration of Activate Search features. This documentation will describe common usage scenarios so that an integrator can explore the API.
\nManagement application documentation can be found in our Customer Support: https://activatesearch.spotler.help/hc/en-gb
\nThe main requirements for using Activate Search are the following;
\nAn active account
\nAn imported catalogue
\nConfigured Basic and Custom Fields
\nConfigured Functionality (as needed):
\nSearch
\nSynonyms
\nRanking Rules
\nPromotion Rules
\nTag and Push Words
\nFilters
\nFilter Rules
\nSort Fields
\nSearch Fields
\nMerchandising
\nGeneric Ranking Rules
\nMerchandised Page
\nRecommendations
\nThe use-cases described in the next sections demonstrate the configuration of their examples, but not the overall configuration required for a live production-ready account.
Specific implementation details should be discussed with Spotify Activate Professional Services.
A simple search endpoint request for the search_term black.
Running errands or headed to the gym, you just want to be comfortable. The Olivia Light Jacket promises that, plus a laid-back look. This zip-up is designed with shoulder stripes for an athletic touch, and banded waist and contoured seams for a flattering silhouette.
• Loose fit.• Reflectivity.• Flat seams.• Machine wash/dry.
\"\n ],\n \"sqr:description\": [\n \"Running errands or headed to the gym, you just want to be comfortable. The Olivia Light Jacket promises that, plus a laid-back look. This zip-up is designed with shoulder stripes for an athletic touch, and banded waist and contoured seams for a flattering silhouette.
• Loose fit.• Reflectivity.• Flat seams.• Machine wash/dry.
\"\n ],\n \"image\": \"https://magento.sooqr.com/media/catalog/product/w/j/wj12-black_main_1.jpg\",\n \"double_normal_price\": 77,\n \"sqr:normal_price\": 77,\n \"sqr:normal_price_ex\": 77,\n \"price\": 77,\n \"sqr:price\": 77,\n \"sqr:price_ex\": 77,\n \"sqr:status\": [\n \"Disabled\"\n ],\n \"sqr:availability\": [\n \"in stock\"\n ],\n \"sqr:assoc_id\": [\n \"1396\"\n ],\n \"sqr:is_parent\": [\n \"false\"\n ],\n \"color\": [\n \"Black\"\n ],\n \"size\": [\n \"XS\"\n ],\n \"short_description\": [\n \"\"\n ],\n \"sqr:category1\": [\n \"Jackets\"\n ],\n \"sqr:category2\": [\n \"Women Sale\"\n ],\n \"sqr:category3\": [\n \"Performance Fabrics\"\n ],\n \"sqr:category4\": [\n \"Tops\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"777\",\n \"title\": \"Kratos Gym Pant-32-Black\",\n \"sqr:title\": [\n \"Kratos Gym Pant-32-Black\"\n ],\n \"sqr:sku\": \"MP05-32-Black\",\n \"detail_url\": \"https://magento.sooqr.com/index.php/kratos-gym-pant.html\",\n \"text_text\": [\n \"Like it's namesake god of strength, the Kratos Gym Pant help you bring your best to bear on weight-based, plyometric and endurance exercise. They stretch and support in all the right places while ultra-light construction and moisture-wicking technology provide comfort.
• Navy cotton straight leg pants.
• Relaxed fit.
• 2 side-seam pockets.
• Internal zip pocket.
• Drawstring waist.
• Machine wash/dry.
Like it's namesake god of strength, the Kratos Gym Pant help you bring your best to bear on weight-based, plyometric and endurance exercise. They stretch and support in all the right places while ultra-light construction and moisture-wicking technology provide comfort.
• Navy cotton straight leg pants.
• Relaxed fit.
• 2 side-seam pockets.
• Internal zip pocket.
• Drawstring waist.
• Machine wash/dry.
What more do you need than a sporty yoga short made with organic cotton and a little spandex for mobility? The Hawkeye Yoga Short brings a stylish, standard fit you can sport with confidence outside the studio.
• Dark gray shorts with red accents.
• 92% Organic Cotton 8% Spandex.
• Breathable stretch organic cotton.
• Medium=8.0\\\" (21.0cm) inseam.
What more do you need than a sporty yoga short made with organic cotton and a little spandex for mobility? The Hawkeye Yoga Short brings a stylish, standard fit you can sport with confidence outside the studio.
• Dark gray shorts with red accents.
• 92% Organic Cotton 8% Spandex.
• Breathable stretch organic cotton.
• Medium=8.0\\\" (21.0cm) inseam.
If you're constantly on the move, the Neve Studio Dance Jacket is for you. It's not just for dance, either, with a tight fit that works as a mid-layer. The reversible design makes it even more versatile.
• Bright blue 1/4 zip pullover.
• CoolTech™ liner is sweat-wicking.
• Sleeve thumbholes.
• Zipper garage to protect your chin.
• Stretchy collar drawcords.
If you're constantly on the move, the Neve Studio Dance Jacket is for you. It's not just for dance, either, with a tight fit that works as a mid-layer. The reversible design makes it even more versatile.
• Bright blue 1/4 zip pullover.
• CoolTech™ liner is sweat-wicking.
• Sleeve thumbholes.
• Zipper garage to protect your chin.
• Stretchy collar drawcords.
Part jacket, part shirt, the Proteus Fitness Jackshirt makes an ideal companion for outdoor training, camping or loafing on crisp days. Natural Cocona® technology brings breathable comfort and increased dryness along with UV protection and odor management. The drop-tail hem provides extra coverage when you're riding a bike or replacing a sink valve.
• 1/4 zip. Stand-up collar.
• Machine wash/dry.
• Quilted inner layer.
Part jacket, part shirt, the Proteus Fitness Jackshirt makes an ideal companion for outdoor training, camping or loafing on crisp days. Natural Cocona® technology brings breathable comfort and increased dryness along with UV protection and odor management. The drop-tail hem provides extra coverage when you're riding a bike or replacing a sink valve.
• 1/4 zip. Stand-up collar.
• Machine wash/dry.
• Quilted inner layer.
You don't need bells and whistles when performance speaks for itself. The full-zip Stark Fundamental Hoodie give just what you need. Hood and fleece lining keep you warm, while breathable fabric and wicking technology won't let you overheat.
• Navy specked full zip hoodie.
• Ribbed cuffs, banded waist.
• Side pockets.
• Machine wash/dry.
You don't need bells and whistles when performance speaks for itself. The full-zip Stark Fundamental Hoodie give just what you need. Hood and fleece lining keep you warm, while breathable fabric and wicking technology won't let you overheat.
• Navy specked full zip hoodie.
• Ribbed cuffs, banded waist.
• Side pockets.
• Machine wash/dry.
While you're getting fit, you need a fitted jacket to match. Striking color blocking patterns on hood, shoulders and arms are hallmarks of the Orion Two-Tone Fitted Jacket. They provide eye-catching contrast against the rich, torso tones of this 100% polyester, moisture-wicking essential.
• Red full zip fleece with gray insets.
• Double-knit construction.
• Full athletic cut.
• Set in sleeves.
• Front pouch pocket.
While you're getting fit, you need a fitted jacket to match. Striking color blocking patterns on hood, shoulders and arms are hallmarks of the Orion Two-Tone Fitted Jacket. They provide eye-catching contrast against the rich, torso tones of this 100% polyester, moisture-wicking essential.
• Red full zip fleece with gray insets.
• Double-knit construction.
• Full athletic cut.
• Set in sleeves.
• Front pouch pocket.
Protect yourself from wind and rain in the stylish Nadia Elements Shell. It repels water using hydro-resistant fabric, with fleece lining that adds a touch of warmth. It's finished with bold contrast zippers, adjustable cuffs and a hood.
• Zippered front.
• Zippered side pockets.
• Drawstring-adjustable waist and hood.
• Machine wash/line dry.
• Light blue 1/4 zip pullover.
Protect yourself from wind and rain in the stylish Nadia Elements Shell. It repels water using hydro-resistant fabric, with fleece lining that adds a touch of warmth. It's finished with bold contrast zippers, adjustable cuffs and a hood.
• Zippered front.
• Zippered side pockets.
• Drawstring-adjustable waist and hood.
• Machine wash/line dry.
• Light blue 1/4 zip pullover.
Need an everyday action tee that helps keep you dry? The Aero Daily Fitness Tee is made of 100% polyester wicking knit that funnels moisture away from your skin. Don't be fooled by its classic style; this tee hides premium performance technology beneath its unassuming look.
Relaxed fit.
Short-Sleeve.
Machine wash/dry.
Need an everyday action tee that helps keep you dry? The Aero Daily Fitness Tee is made of 100% polyester wicking knit that funnels moisture away from your skin. Don't be fooled by its classic style; this tee hides premium performance technology beneath its unassuming look.
Relaxed fit.
Short-Sleeve.
Machine wash/dry.
Perfect for hot bikram session or cool-down stretching. 8-percent stretch means you'll feel like anything is possible in the capri-style Diana Tights.
• Black legging with slate details.
• Flat-lock, chafe-free side seams.
• Vented gusset.
• Secret interior pocket.
• Sustainable and recycled fabric.
Perfect for hot bikram session or cool-down stretching. 8-percent stretch means you'll feel like anything is possible in the capri-style Diana Tights.
• Black legging with slate details.
• Flat-lock, chafe-free side seams.
• Vented gusset.
• Secret interior pocket.
• Sustainable and recycled fabric.
A basic search request that limits the item attributes returned.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"a93cc42b-33bc-4324-9049-121a7a701757","name":"2. Basic Search with specific attributes","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"price\",\n \"id\",\n \"title\",\n \"sqr:availability\"\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"3100"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:22:26 GMT"},{"key":"x-amzn-RequestId","value":"c883e93b-68f8-4422-84fa-c9b95bacf8ab"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qF_FTBFiAEdkw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-667956f2-1f2050735aa9d5c86d9d24ef;Parent=0187caa8019d1bc2;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3fad6888361bd8bcd9c5b458635f78d0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"wxos69bU2n14bn1txymmYU9AYsphvId7Cp2gc5e3kbJwallF-eH-Ag=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 99,\n \"step\": 1,\n \"count\": 2040\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 342\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 339\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 320\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 304\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 220\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 192\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 175\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 102\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 46\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 184\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"334\",\n \"title\": \"Lando Gym Jacket\",\n \"price\": 99,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"2033\",\n \"title\": \"Erika Running Short-30-Red\",\n \"price\": 45,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1928\",\n \"title\": \"Maxima Drawstring Short-30-Yellow\",\n \"price\": 28,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1318\",\n \"title\": \"Jade Yoga Jacket-XS-Gray\",\n \"price\": 32,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"618\",\n \"title\": \"Strike Endurance Tee-L-Red\",\n \"price\": 39,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1750\",\n \"title\": \"Chloe Compete Tank-XS-Red\",\n \"price\": 39,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"697\",\n \"title\": \"Sparta Gym Tank-M-Green\",\n \"price\": 29,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1455\",\n \"title\": \"Elisa EverCool™ Tee-L-Purple\",\n \"price\": 29,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1124\",\n \"title\": \"Phoebe Zipper Sweatshirt-L-Gray\",\n \"price\": 59,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1008\",\n \"title\": \"Arcadio Gym Short-33-Red\",\n \"price\": 20,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 2040\n },\n \"banners\": []\n }\n}"}],"_postman_id":"ddc0ff90-ea98-4c60-83ec-f2cfadd7b055"}],"id":"9279b09c-1472-4252-9d18-3a83f2883dd1","_postman_id":"9279b09c-1472-4252-9d18-3a83f2883dd1","description":""},{"name":"Filtering","item":[{"name":"3. Filter items for a specific price range","id":"f39fe531-98f1-42db-b714-c400343f6fc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\", \"price\", \"sqr:availability\"],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search","description":"A search request that filters results for a specific price range.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"7581155e-0597-4959-8967-7716e1b15844","name":"3. Filter items for a specific price range","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\", \"price\", \"sqr:availability\"],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"3100"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:22:36 GMT"},{"key":"x-amzn-RequestId","value":"8fa65c26-76d7-4c7f-982e-dce8d712820c"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qHbFr5FiAEcpg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-667956fc-0c46913f23d5c2e3318c5e6b;Parent=6896b9a3897fdca7;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8696978c2d465ffc3a342761ace51d9e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"edmO7dpo_cXYKI7EsWAJA-IwH8AZhOp9iP5m6TMce3DqWuvu7n_vOw=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 99,\n \"step\": 1,\n \"count\": 2040\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 342\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 339\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 320\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 304\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 220\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 192\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 175\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 102\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 44\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 182\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"334\",\n \"title\": \"Lando Gym Jacket\",\n \"price\": 99,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"2033\",\n \"title\": \"Erika Running Short-30-Red\",\n \"price\": 45,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1928\",\n \"title\": \"Maxima Drawstring Short-30-Yellow\",\n \"price\": 28,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1318\",\n \"title\": \"Jade Yoga Jacket-XS-Gray\",\n \"price\": 32,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"618\",\n \"title\": \"Strike Endurance Tee-L-Red\",\n \"price\": 39,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1750\",\n \"title\": \"Chloe Compete Tank-XS-Red\",\n \"price\": 39,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"697\",\n \"title\": \"Sparta Gym Tank-M-Green\",\n \"price\": 29,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1455\",\n \"title\": \"Elisa EverCool™ Tee-L-Purple\",\n \"price\": 29,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1124\",\n \"title\": \"Phoebe Zipper Sweatshirt-L-Gray\",\n \"price\": 59,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1008\",\n \"title\": \"Arcadio Gym Short-33-Red\",\n \"price\": 20,\n \"sqr:availability\": [\n \"in stock\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 2038\n },\n \"banners\": []\n }\n}"}],"_postman_id":"f39fe531-98f1-42db-b714-c400343f6fc3"},{"name":"4. Filter items to show only in stock items","id":"91122e97-183f-4cf4-904c-4269e61cfc1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\", \"price\", \"sqr:availability\"],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:availability\",\n \"value\": \"in stock\"\n }\n\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search","description":"A search request that filters for in stock items.
A search request that filters for attriribute values from a supplied array.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"11872b9c-0ee4-4cea-beac-15be0cfcb2e2","name":"5. Filter items to show items with specific attribute values","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"whereIn\",\n \"field\": \"color\",\n \"values\":[\"Lavender\",\"White\"]\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"2921"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:22:46 GMT"},{"key":"x-amzn-RequestId","value":"b7d6bd31-3035-41fc-837a-af5ab3054900"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qI_GKWliAEFLw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66795706-52db0cc53993f0b1116bdc19;Parent=606bac3a839916e1;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 8696978c2d465ffc3a342761ace51d9e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"cahrW4Nq4L7gPAFZGX9JVVK7I93fxgpdba-BF52oaSWQty0X-olacQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 28,\n \"max\": 84,\n \"step\": 1,\n \"count\": 90\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 30\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 15\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 15\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 10\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 6\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 5\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 5\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 4\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 184\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"1107\",\n \"title\": \"Selene Yoga Hoodie-XL-White\",\n \"price\": 42,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1818\",\n \"title\": \"Karmen Yoga Pant-29-White\",\n \"price\": 39,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1474\",\n \"title\": \"Juliana Short-Sleeve Tee-XL-White\",\n \"price\": 42,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1878\",\n \"title\": \"Daria Bikram Pant-28-White\",\n \"price\": 51,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1775\",\n \"title\": \"Maya Tunic-L-White\",\n \"price\": 29,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1507\",\n \"title\": \"Tiffany Fitness Tee-XL-White\",\n \"price\": 28,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"113\",\n \"title\": \"Hollister Backyard Sweatshirt-XS-White\",\n \"price\": 52,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1766\",\n \"title\": \"Maya Tunic-XS-White\",\n \"price\": 29,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1126\",\n \"title\": \"Phoebe Zipper Sweatshirt-L-White\",\n \"price\": 59,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1117\",\n \"title\": \"Phoebe Zipper Sweatshirt-XS-White\",\n \"price\": 59,\n \"color\": [\n \"White\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 90\n },\n \"banners\": []\n }\n}"}],"_postman_id":"8073b208-cf29-4c3b-b248-8702951d1c43"},{"name":"6. Chained AND filter","id":"d3286620-c2a2-40f3-b66d-3b1a6e3d27a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:availability\",\n \"value\": \"in stock\"\n },\n {\n \"type\": \"where\",\n \"field\": \"color\",\n \"value\":\"Red\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search","description":"A more complicated search request that chains together filter conditions using AND.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"0b41d073-037d-47ce-a04c-19a737b47d4e","name":"6. Chained AND filter","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:availability\",\n \"value\": \"in stock\"\n },\n {\n \"type\": \"where\",\n \"field\": \"color\",\n \"value\":\"Red\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"2974"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:22:52 GMT"},{"key":"x-amzn-RequestId","value":"2adb274d-fe37-4984-b6d4-f7d843bc57a5"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qJ9GgMliAEBAg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6679570c-4adc53d840d6946521d0cd7c;Parent=6d221b54d61a7a1f;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e2e847b082ff9d1bdd61dc9c27ca0786.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"-jIx59VgjrNKvLDiMDpmO1z7x5H34VPeereAkpuq7vViyePiRshOyw=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 20,\n \"max\": 84,\n \"step\": 1,\n \"count\": 252\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 54\n },\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 45\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 45\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 45\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 19\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 16\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 15\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 10\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 3\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 184\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"2033\",\n \"title\": \"Erika Running Short-30-Red\",\n \"price\": 45,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"618\",\n \"title\": \"Strike Endurance Tee-L-Red\",\n \"price\": 39,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1750\",\n \"title\": \"Chloe Compete Tank-XS-Red\",\n \"price\": 39,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1008\",\n \"title\": \"Arcadio Gym Short-33-Red\",\n \"price\": 20,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1263\",\n \"title\": \"Ingrid Running Jacket-L-Red\",\n \"price\": 84,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"821\",\n \"title\": \"Zeppelin Yoga Pant-33-Red\",\n \"price\": 82,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"883\",\n \"title\": \"Cobalt CoolTech™ Fitness Short-32-Red\",\n \"price\": 44,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"465\",\n \"title\": \"Ryker LumaTech™ Tee (Crew-neck)-XS-Red\",\n \"price\": 32,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"500\",\n \"title\": \"Atomic Endurance Running Tee (Crew-Neck)-S-Red\",\n \"price\": 29,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"25\",\n \"title\": \"Sprite Stasis Ball 55 cm\",\n \"price\": 23,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 252\n },\n \"banners\": []\n }\n}"}],"_postman_id":"d3286620-c2a2-40f3-b66d-3b1a6e3d27a2"},{"name":"7. Chained OR filter","id":"c772c8ea-4ad1-4a17-89dc-279a68a5341a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"size\",\n \"value\": \"55 cm\"\n },\n {\n \"type\": \"orWhere\",\n \"field\": \"sqr:category2\",\n \"value\": \"Fitness Equipment\"\n }\n ]\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search","description":"A more complicated search request that chains together filter conditions using OR.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"33588244-16f0-457d-9069-bf6e880a21e6","name":"7. Chained OR filter - before 260226","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"size\",\n \"value\": \"55 cm\"\n },\n {\n \"type\": \"orWhere\",\n \"field\": \"sqr:category2\",\n \"value\":\"Fitness Equipment\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"1693"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:22:57 GMT"},{"key":"x-amzn-RequestId","value":"e10faf02-8457-4702-9900-ff01720ec869"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qKzEwXFiAEPCQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66795711-129696df57d338bf696fe2de;Parent=237161fa15f6745f;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ea42f57e1e0a065bc1c1c637f97d3be4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"zBvMF1Mg7z9w_BbnTeYGuWYP3QWKfcoRfBeZOyjsWlMGcKFVf4eABw=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 23,\n \"max\": 23,\n \"step\": 1,\n \"count\": 3\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 3\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 1\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 1\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 1\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 0\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 0\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 0\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 0\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 0\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 0\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 0\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 0\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 0\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"25\",\n \"title\": \"Sprite Stasis Ball 55 cm\",\n \"price\": 23,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"26\",\n \"title\": \"Sprite Stasis Ball 55 cm\",\n \"price\": 23,\n \"color\": [\n \"Blue\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"24\",\n \"title\": \"Sprite Stasis Ball 55 cm\",\n \"price\": 23,\n \"color\": [\n \"Gray\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 3\n },\n \"banners\": []\n }\n}"},{"id":"e96ca70c-58cf-481e-9581-c8bda912bbe7","name":"7. Chained nested OR filter - before 260226","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"size\",\n \"value\": \"55 cm\"\n },\n {\n \"type\": \"orWhere\",\n \"field\": \"sqr:category2\",\n \"value\": \"Fitness Equipment\"\n }\n ]\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2632"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 26 Feb 2026 14:20:47 GMT"},{"key":"permissions-policy","value":"geolocation=(), microphone=(), camera=(), payment=(), usb=(), magnetometer=(), accelerometer=(), gyroscope=(), speaker=(), vibrate=(), fullscreen=()"},{"key":"x-amzn-RequestId","value":"39c250c3-4e39-4a9d-8cad-5c4efd8e7b04"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"access-control-allow-origin","value":"*"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"x-frame-options","value":"DENY"},{"key":"content-security-policy","value":"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data: https:; connect-src 'self' https:; frame-ancestors 'none'; object-src 'none'; base-uri 'self'"},{"key":"x-amz-apigw-id","value":"ZZJ97EMaFiAEfxg="},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"x-content-type-options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-69a056bf-6a1eccbf1f63baa80f166083;Parent=763706a4982dd500;Sampled=0;Lineage=1:030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3bdef981159de9c713020c64476ba0e4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"AMS1-P2"},{"key":"X-Amz-Cf-Id","value":"uRkhTdkuAa2mo9ZuJoZNoHUIjzIbsbw-WQlz1jlvH7bWQ2KdiywFKA=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 61,\n \"step\": 1,\n \"count\": 23\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 23\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 3\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 3\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 3\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 0\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 0\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 0\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 0\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 0\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 0\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 0\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 0\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"46\",\n \"title\": \"Sprite Yoga Companion Kit\",\n \"price\": 61\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"45\",\n \"title\": \"Set of Sprite Yoga Straps\",\n \"price\": 21\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"25\",\n \"title\": \"Sprite Stasis Ball 55 cm\",\n \"price\": 23,\n \"color\": [\n \"Red\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"34\",\n \"title\": \"Sprite Yoga Strap 8 foot\",\n \"price\": 17\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"15\",\n \"title\": \"Affirm Water Bottle \",\n \"price\": 7\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"23\",\n \"title\": \"Harmony Lumaflex™ Strength Band Kit \",\n \"price\": 22\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"32\",\n \"title\": \"Sprite Stasis Ball 75 cm\",\n \"price\": 32,\n \"color\": [\n \"Blue\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"27\",\n \"title\": \"Sprite Stasis Ball 65 cm\",\n \"price\": 27,\n \"color\": [\n \"Gray\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"33\",\n \"title\": \"Sprite Yoga Strap 6 foot\",\n \"price\": 14\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"19\",\n \"title\": \"Go-Get'r Pushup Grips\",\n \"price\": 19\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 23\n },\n \"banners\": [],\n \"result_id\": \"eyJxdWVyeSI6IioiLCJzY29wZSI6InNlYXJjaCIsImZpbHRlcnMiOlt7InR5cGUiOiJ3aGVyZSIsImZpbHRlcnMiOlt7ImZpZWxkIjoic3RyaW5nX3NpemUiLCJ0eXBlIjoid2hlcmUiLCJ2YWx1ZSI6IjU1IGNtIn0seyJmaWVsZCI6InN0cmluZ19zcXJfY2F0ZWdvcnkyIiwidHlwZSI6Im9yV2hlcmUiLCJ2YWx1ZSI6IkZpdG5lc3MgRXF1aXBtZW50In1dfV0sIm9mZnNldCI6MCwibGltaXQiOjEwLCJyZXN1bHRzX2NvdW50IjoyM30=\"\n }\n}"}],"_postman_id":"c772c8ea-4ad1-4a17-89dc-279a68a5341a"}],"id":"6779e785-9f16-450d-9042-794e069d5bce","description":"The ability to filter the response for desired items is foundational to search. This is supported
\nwithin the dataset with the filters array. The filters are processed in the order they are present in the array. Each filter is ANDed with its subsequent filter unless that filters type starts with the or prefix. This allows the creation of filter chains.
The OpenAPI documentation contains the schemas for the different filter types.
\nThe examples below show some of the more common use cases.
\n{\n \"index_uuid\": \"b5f76aef-86b3-4a82-a007-e29d1e2a6c16\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\", \"price\", \"in_stock\"],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\", \"price\", \"sqr:availability\"],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:availability\",\n \"value\": \"in stock\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"whereIn\",\n \"field\": \"color\",\n \"values\":[\"Lavender\",\"White\"]\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:availability\",\n \"value\": \"in stock\"\n },\n {\n \"type\": \"where\",\n \"field\": \"color\",\n \"value\":\"Red\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"color\"\n ],\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"size\",\n \"value\": \"55 cm\"\n },\n {\n \"type\": \"orWhere\",\n \"field\": \"sqr:category2\",\n \"value\":\"Fitness Equipment\"\n }\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nA simple unsorted search request. Inspecting the response sort_fields attribute allows for identification of the internal id for available sorts.
A search request with a specific sort applied to the results.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"05b29f0d-406e-454a-8780-a3939b812656","name":"9. Sorted Request","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"sort_by\": 53400,\n \"attributes\": [\"id\", \"title\", \"price\", \"color\"]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"3016"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:23:11 GMT"},{"key":"x-amzn-RequestId","value":"bd566b4c-c208-40e6-8b75-6c70a84431b5"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qM-H89FiAETTQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6679571f-5a0f9e1e02890afa2d725f23;Parent=6f354dfc44086285;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ea42f57e1e0a065bc1c1c637f97d3be4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"IG4DnFOrVH7hhQfg-QlwgxtCRrslyt-Lzc6k1truhYd42SM0DfdxoQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 99,\n \"step\": 1,\n \"count\": 2040\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 342\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 339\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 320\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 304\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 220\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 192\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 175\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 102\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 46\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 184\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"1928\",\n \"title\": \"Maxima Drawstring Short-30-Yellow\",\n \"price\": 28,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1648\",\n \"title\": \"Prima Compete Bra Top-L-Yellow\",\n \"price\": 24,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1463\",\n \"title\": \"Juliana Short-Sleeve Tee-XS-Yellow\",\n \"price\": 42,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1970\",\n \"title\": \"Bess Yoga Short-28-Yellow\",\n \"price\": 28,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"657\",\n \"title\": \"Primo Endurance Tank-XS-Yellow\",\n \"price\": 29,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1338\",\n \"title\": \"Nadia Elements Shell-S-Yellow\",\n \"price\": 69,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1639\",\n \"title\": \"Prima Compete Bra Top-XS-Yellow\",\n \"price\": 24,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"317\",\n \"title\": \"Orion Two-Tone Fitted Jacket-XL-Yellow\",\n \"price\": 72,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1559\",\n \"title\": \"Gwyn Endurance Tee-XS-Yellow\",\n \"price\": 24,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1216\",\n \"title\": \"Stellar Solar Jacket-M-Yellow\",\n \"price\": 75,\n \"color\": [\n \"Yellow\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 2040\n },\n \"banners\": []\n }\n}"}],"_postman_id":"84502459-2d8b-4a92-8d96-9d94df8997f9"}],"id":"cc7b9921-719a-4408-a8ba-9aab9d3eaac9","description":"Although Activate Search returns items in descending relvance order, it may be that an arbritraty order of items is required based on spcecifc item attributes.
\nSearch defaults to relevance order if no other sort is provided.
\nApplying a custom sort to a request the internal id of the Sorting configured in MySearch is provided.
The following example shows how this is achieved.
{\n \"index_uuid\": \"b5f76aef-86b3-4a82-a007-e29d1e2a6c16\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"sort_by\": 53400, \n \"attributes\": [\"id\", \"title\", \"price\", \"in_stock\"]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nThe id that is provided to the sort_by attribtue can be determined from the sort_fields attribute contained within the response to an initial unsorted, i.e. relevance sorted, request.
The format of the sort_fields response attribute is shown below, from which the internal id for the above request can be ascertained.
\"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n\nA search request that returns two different datasets containing diffetrent attribute data for the same search_term.
The dataset JSON attribute allows for multiple named datasets to tbe defined. This allows integrators to bundle two different views of the results for the exact same search request.
The power of this approach is that you can search the same underlying data using different response configurations. Such as providing a set of geocoordinates in one dataset for a Google Map implementation along with more descriptive data for a related item grid.
\nThe following example demonstrates this ability, splitting the data into two datasets one for titles and one for prices.
\n{\n \"index_uuid\": \"b5f76aef-86b3-4a82-a007-e29d1e2a6c16\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"itemTitles\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"title\"]\n },\n \"itemPrices\": {\n \"limit\": 10,\n \"offset\": 0, \n \"attributes\": [\"id\", \"price\"]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nThe example below is not a request that can be executed, but is added to show the personalisation within the request body.
\n","urlObject":{"protocol":"https","path":["v2","search"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"06394d88-4acf-4dbd-98cc-9f16786e279a"}],"id":"c7a76ade-5d52-4e7c-bffc-b9578bcf4df1","description":"For personalisation with Activate ask Customer Service for linking the two accounts.
\nOnce the customer service have connected the Activate and Activate Search account you are able to configure Personalisation boosts.
\nIn the request you have to add the personalisation:
\n \"personalisation\": {\n \"integration\": {\n \"source\": \"activate\",\n \"token\": \"sqzl668bd91f000006248012\"\n }\n }\n\nThe token is the Activate id for the user that is on the website at that moment. You can get the Activate user id: https://activate.spotler.help/hc/en-gb/articles/21445733848338-How-to-I-retreive-my-cookie
\n","_postman_id":"c7a76ade-5d52-4e7c-bffc-b9578bcf4df1"}],"id":"1d6a38c0-0c9f-418a-a290-9c03f4eb0935","description":"The search and merchandising endpoint is at https://search.spotlersearch.com/v2/search.
\nThe endpoint provides a common request format for search and merchandising operations.
\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"black\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0\n }\n },\n \"url\": \"https://example.example.com\",\n \"scope\": \"search\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nThe simple search request above is for items that contain the search_term black. It is run against the Activate Search Index with the UUID of 2594854e-42a5-4946-99d0-ff6f11b44b5e. [This UUID is availble in the MySearch application] It defines that a single dataset called items should be returned, and that this dataset should contain 10 items [limit], with an offset of 0. These attributes support pagination by the client. The final three attributes define the url, scope, and user session of the request. It is recommended that these are filled; scope can be either search or merchandising and defines which underlying Activate Search functionality is called, and the url and user session are data filled by the client for server-side data analytics purposes.
The request format contains a definition for an attribute called debug that should be set to false, or omitted altogether, for standard operation. This flag will echo internal application state to the client. The format of this debug information is not easily readable, but it is useful for Spotify Professional Services to debug internal application issues. It requires an understanding of the internal application and its infrastructure to be useful.
It is not useful for debugging MySearch configuration issues or for determining why a certain feature is working in an unanticipated way.
The prior simple search request returns ALL of the Item attributes in the response. This should be avoided to help reduce response times, bandwith usage, and system load. The following example shows how to retrict the Item attributes being returned.
\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"price\",\n \"id\",\n \"title\",\n \"sqr:availability\"\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nThe attributes JSON attribute contains an array of strings that define the Item attributes that will be returned in the response. The three Common Attributes, price, id, title are returned, and the third attribute sqr:availability is a Custom Attribute, and uses the same naming that is used by the content feed. This naming must include any XML Namespace prefix as defined by the XML file.
note: As can be seen by this example, providing the asterisk wildcard, * as the search_term will match on ALL products and return them in the default sort order.
A basic Merchandising request. The response will contain pinned items that have been defined in MySearch.
\n","urlObject":{"protocol":"https","path":["v2","merchandising"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"c243f704-6b53-4351-822f-994cdfedc68f","name":"11. Basic Request","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\"\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"2637"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:23:28 GMT"},{"key":"x-amzn-RequestId","value":"d160412b-8ab8-4afa-be8c-700367a25f76"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qPjEs1FiAEWQA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66795730-7709068024b8b85c591fe1da;Parent=090b045c4f05d55c;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e2e847b082ff9d1bdd61dc9c27ca0786.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"iZIOXJzu8WDw607773Hp4BRxwCMYeUuZeRVcGqV1w4cNtzTULPGt-A=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 99,\n \"step\": 1,\n \"count\": 2038\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 342\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 339\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 320\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 304\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 220\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 192\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 175\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 102\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 44\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"count\": 182\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"38\",\n \"title\": \"Summit Watch\"\n },\n \"pinned\": true\n },\n {\n \"properties\": {\n \"id\": \"334\",\n \"title\": \"Lando Gym Jacket\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"2033\",\n \"title\": \"Erika Running Short-30-Red\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1928\",\n \"title\": \"Maxima Drawstring Short-30-Yellow\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"42\",\n \"title\": \"Bolo Sport Watch\"\n },\n \"pinned\": true\n },\n {\n \"properties\": {\n \"id\": \"1318\",\n \"title\": \"Jade Yoga Jacket-XS-Gray\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"618\",\n \"title\": \"Strike Endurance Tee-L-Red\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1750\",\n \"title\": \"Chloe Compete Tank-XS-Red\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"697\",\n \"title\": \"Sparta Gym Tank-M-Green\"\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1455\",\n \"title\": \"Elisa EverCool™ Tee-L-Purple\"\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 2038\n },\n \"banners\": []\n }\n}"}],"_postman_id":"bcdc5c19-69f5-407f-90ef-7c1a083959ac"},{"name":"12. Merchandising Request with Filtering","id":"33a9a6ee-b694-4674-9e23-07642ca95415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"sqr:category1\"\n ],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n } \n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/merchandising","description":"The same request as above, but with a filter for a price range applied.
\n","urlObject":{"protocol":"https","path":["v2","merchandising"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"f0e47e8c-8ede-48d1-87ad-33068d3b2f4b","name":"12. Merchandising Request with Filtering","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"sqr:category1\"\n ],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n } \n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"3000"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 18 Sep 2024 13:25:06 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-66ead4b2-342ae9887ff746b53a1dfac9;Parent=3968b9655f0cab9e;Sampled=0;lineage=1:030c79d0:0"},{"key":"x-amzn-RequestId","value":"d3ca902e-e337-4030-adbd-6c3cb6a1d1ec"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"eTYr_FWaliAEemg="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 db3ad39d2b444e5c9e38affc6638a5cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"AMS1-P2"},{"key":"X-Amz-Cf-Id","value":"yanXJR4DMLNpv68dC42ejMP8mg6iBO07rL_JSD-Tl-NeEEovfPSMtg=="}],"cookie":[],"responseTime":null,"body":"{\n \"items\": {\n \"success\": true,\n \"code\": 0,\n \"facets\": [\n {\n \"type\": \"dualslider\",\n \"id\": 207372,\n \"name\": \"sqr:price\",\n \"attribute\": \"price\",\n \"label\": \"Price\",\n \"is_default_collapsed\": false,\n \"min\": 5,\n \"max\": 99,\n \"step\": 1,\n \"count\": 2038\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207373,\n \"name\": \"sqr:category1\",\n \"attribute\": \"text_sqr_category1\",\n \"label\": \"Category\",\n \"is_default_collapsed\": false,\n \"result_limit\": 15,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Hoodies & Sweatshirts\",\n \"value\": \"Hoodies & Sweatshirts\",\n \"count\": 342\n },\n {\n \"label\": \"New Luma Yoga Collection\",\n \"value\": \"New Luma Yoga Collection\",\n \"count\": 339\n },\n {\n \"label\": \"Tees\",\n \"value\": \"Tees\",\n \"count\": 320\n },\n {\n \"label\": \"Jackets\",\n \"value\": \"Jackets\",\n \"count\": 304\n },\n {\n \"label\": \"Shorts\",\n \"value\": \"Shorts\",\n \"count\": 220\n },\n {\n \"label\": \"Bras & Tanks\",\n \"value\": \"Bras & Tanks\",\n \"count\": 192\n },\n {\n \"label\": \"Pants\",\n \"value\": \"Pants\",\n \"count\": 175\n },\n {\n \"label\": \"Tanks\",\n \"value\": \"Tanks\",\n \"count\": 102\n },\n {\n \"label\": \"Gear\",\n \"value\": \"Gear\",\n \"count\": 42\n }\n ]\n },\n {\n \"type\": \"multiselect\",\n \"id\": 207382,\n \"name\": \"color\",\n \"attribute\": \"string_color\",\n \"label\": \"Colour\",\n \"is_default_collapsed\": true,\n \"result_limit\": 999,\n \"searchable\": false,\n \"values\": [\n {\n \"label\": \"Blue\",\n \"value\": \"Blue\",\n \"count\": 342\n },\n {\n \"label\": \"Black\",\n \"value\": \"Black\",\n \"count\": 264\n },\n {\n \"label\": \"Red\",\n \"value\": \"Red\",\n \"count\": 252\n },\n {\n \"label\": \"Green\",\n \"value\": \"Green\",\n \"count\": 244\n },\n {\n \"label\": \"Purple\",\n \"value\": \"Purple\",\n \"count\": 190\n },\n {\n \"label\": \"Orange\",\n \"value\": \"Orange\",\n \"count\": 181\n },\n {\n \"label\": \"Gray\",\n \"value\": \"Gray\",\n \"count\": 137\n },\n {\n \"label\": \"Yellow\",\n \"value\": \"Yellow\",\n \"count\": 137\n },\n {\n \"label\": \"White\",\n \"value\": \"White\",\n \"count\": 85\n },\n {\n \"label\": \"Brown\",\n \"value\": \"Brown\",\n \"count\": 19\n },\n {\n \"label\": \"Lavender\",\n \"value\": \"Lavender\",\n \"count\": 5\n }\n ]\n }\n ],\n \"sort_fields\": [\n {\n \"label\": \"Relevance\",\n \"id\": 53391\n },\n {\n \"label\": \"Price (Low-High)\",\n \"id\": 53392\n },\n {\n \"label\": \"Price (High-Low)\",\n \"id\": 53393\n },\n {\n \"label\": \"Popularity\",\n \"id\": 53394\n },\n {\n \"label\": \"Colour\",\n \"id\": 53400\n }\n ],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"38\",\n \"title\": \"Summit Watch\",\n \"price\": 54,\n \"sqr:category1\": [\n \"Gear\"\n ]\n },\n \"pinned\": true\n },\n {\n \"properties\": {\n \"id\": \"334\",\n \"title\": \"Lando Gym Jacket\",\n \"price\": 99,\n \"sqr:category1\": [\n \"Jackets\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"2033\",\n \"title\": \"Erika Running Short-30-Red\",\n \"price\": 45,\n \"sqr:category1\": [\n \"Shorts\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1928\",\n \"title\": \"Maxima Drawstring Short-30-Yellow\",\n \"price\": 28,\n \"sqr:category1\": [\n \"Shorts\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"42\",\n \"title\": \"Bolo Sport Watch\",\n \"price\": 49,\n \"sqr:category1\": [\n \"Gear\"\n ]\n },\n \"pinned\": true\n },\n {\n \"properties\": {\n \"id\": \"1318\",\n \"title\": \"Jade Yoga Jacket-XS-Gray\",\n \"price\": 32,\n \"sqr:category1\": [\n \"Jackets\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"618\",\n \"title\": \"Strike Endurance Tee-L-Red\",\n \"price\": 39,\n \"sqr:category1\": [\n \"Tees\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1750\",\n \"title\": \"Chloe Compete Tank-XS-Red\",\n \"price\": 39,\n \"sqr:category1\": [\n \"Bras & Tanks\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"697\",\n \"title\": \"Sparta Gym Tank-M-Green\",\n \"price\": 29,\n \"sqr:category1\": [\n \"Tanks\"\n ]\n },\n \"pinned\": false\n },\n {\n \"properties\": {\n \"id\": \"1455\",\n \"title\": \"Elisa EverCool™ Tee-L-Purple\",\n \"price\": 29,\n \"sqr:category1\": [\n \"New Luma Yoga Collection\"\n ]\n },\n \"pinned\": false\n }\n ],\n \"meta\": {\n \"offset\": 0,\n \"limit\": 10,\n \"total\": 2038\n },\n \"banners\": []\n }\n}"}],"_postman_id":"33a9a6ee-b694-4674-9e23-07642ca95415"},{"name":"Filter pinned items","id":"ba4a7031-b993-4563-98b6-e7d5fbcb8869","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"attributes\": [],\n \"sort_by\": 49736,\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:category3\",\n \"value\": \"Collections\"\n }\n\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"match_filters_for_pinned_items\": true\n }\n\n },\n \"url\": \"https://webshop.sooqr.com/gear.html\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"8c9c67e7-15b9-4324-8fcc-859a98bf8dca\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/merchandising","description":"While implementing you can choose if you want the pinned products to be filtered. Just add the following in the payload. By default it is 'false'
\n\"match_filters_for_pinned_items\": true
In the two example request bodies one hase fillter True. The other does not.
Without: 2 pinned items in result
With match true: Also the pinned items are filtered on the filter.
\n \"filters\": [\n {\n \"type\": \"where\",\n \"field\": \"sqr:category3\",\n \"value\": \"Collections\"\n }\n ],\n\nTrek high and low in the attractive Summit Watch, which features a digital LED display with time and date, stopwatch, lap counter, and 3-second backlight. It can also calculate the number of steps taken and calories burned.
Trek high and low in the attractive Summit Watch, which features a digital LED display with time and date, stopwatch, lap counter, and 3-second backlight. It can also calculate the number of steps taken and calories burned.
The name says so, but the Push It Messenger Bag is much more than a busy commuter's tote. It's a closet away from home when you're pedaling from class or work to gym and back or home again. It's the perfect size and shape for laptop, folded clothes, even extra shoes.
The name says so, but the Push It Messenger Bag is much more than a busy commuter's tote. It's a closet away from home when you're pedaling from class or work to gym and back or home again. It's the perfect size and shape for laptop, folded clothes, even extra shoes.
Convenience is next to nothing when your day is crammed with action. So whether you're heading to class, gym, or the unbeaten path, make sure you've got your Strive Shoulder Pack stuffed with all your essentials, and extras as well.
Convenience is next to nothing when your day is crammed with action. So whether you're heading to class, gym, or the unbeaten path, make sure you've got your Strive Shoulder Pack stuffed with all your essentials, and extras as well.
Whether you're traveling or wish you were, you'll never let time zones perplex you again with the Cruise Dual Analog Watch. The thick, adjustable band promises a comfortable, personalized fit to this classy, modern time piece.
Whether you're traveling or wish you were, you'll never let time zones perplex you again with the Cruise Dual Analog Watch. The thick, adjustable band promises a comfortable, personalized fit to this classy, modern time piece.
The Bolo Sport Watch is sleek, sporty and sized just right to fit your smaller wrist. Easy to read and set up, it features a large digital face and button-activated alarm and stopwatch. The soft-touch resin band promises no-pinch comfort, while the water-resistant design lets you take your workout to the lap pool.
The Bolo Sport Watch is sleek, sporty and sized just right to fit your smaller wrist. Easy to read and set up, it features a large digital face and button-activated alarm and stopwatch. The soft-touch resin band promises no-pinch comfort, while the water-resistant design lets you take your workout to the lap pool.
For long weekends away, camping outings and business trips, the Overnight Duffle can't be beat. The dual handles make it a cinch to carry, while the durable waterproof exterior helps you worry less about the weather. With multiple organizational pockets inside and out, it's the perfect travel companion.
For long weekends away, camping outings and business trips, the Overnight Duffle can't be beat. The dual handles make it a cinch to carry, while the durable waterproof exterior helps you worry less about the weather. With multiple organizational pockets inside and out, it's the perfect travel companion.
The Go-Get'r Pushup Grips safely provide the extra range of motion you need for a deep-dip routine targeting core, shoulder, chest and arm strength. Do fewer pushups using more energy, getting better results faster than the standard floor-level technique yield.
The Go-Get'r Pushup Grips safely provide the extra range of motion you need for a deep-dip routine targeting core, shoulder, chest and arm strength. Do fewer pushups using more energy, getting better results faster than the standard floor-level technique yield.
Powerwalking to the gym or strolling to the local coffeehouse, the Savvy Shoulder Tote lets you stash your essentials in sporty style! A top-loading compartment provides quick and easy access to larger items, while zippered pockets on the front and side hold cash, credit cards and phone.
Powerwalking to the gym or strolling to the local coffeehouse, the Savvy Shoulder Tote lets you stash your essentials in sporty style! A top-loading compartment provides quick and easy access to larger items, while zippered pockets on the front and side hold cash, credit cards and phone.
The Dash Digital Watch will challenge you to push harder and longer. Log workouts by date, average, and segment times, and recharge by setting hydration and nutrition alarms. This watch is styled with a sleek, square face and durable rubber strap for a long life.
The Dash Digital Watch will challenge you to push harder and longer. Log workouts by date, average, and segment times, and recharge by setting hydration and nutrition alarms. This watch is styled with a sleek, square face and durable rubber strap for a long life.
The Rival Field Messenger packs all your campus, studio or trail essentials inside a unique design of soft, textured leather - with loads of character to spare. Two exterior pockets keep all your smaller items handy, and the roomy interior offers even more space.
The Rival Field Messenger packs all your campus, studio or trail essentials inside a unique design of soft, textured leather - with loads of character to spare. Two exterior pockets keep all your smaller items handy, and the roomy interior offers even more space.
Trek high and low in the attractive Summit Watch, which features a digital LED display with time and date, stopwatch, lap counter, and 3-second backlight. It can also calculate the number of steps taken and calories burned.
Trek high and low in the attractive Summit Watch, which features a digital LED display with time and date, stopwatch, lap counter, and 3-second backlight. It can also calculate the number of steps taken and calories burned.
The name says so, but the Push It Messenger Bag is much more than a busy commuter's tote. It's a closet away from home when you're pedaling from class or work to gym and back or home again. It's the perfect size and shape for laptop, folded clothes, even extra shoes.
The name says so, but the Push It Messenger Bag is much more than a busy commuter's tote. It's a closet away from home when you're pedaling from class or work to gym and back or home again. It's the perfect size and shape for laptop, folded clothes, even extra shoes.
Convenience is next to nothing when your day is crammed with action. So whether you're heading to class, gym, or the unbeaten path, make sure you've got your Strive Shoulder Pack stuffed with all your essentials, and extras as well.
Convenience is next to nothing when your day is crammed with action. So whether you're heading to class, gym, or the unbeaten path, make sure you've got your Strive Shoulder Pack stuffed with all your essentials, and extras as well.
Whether you're traveling or wish you were, you'll never let time zones perplex you again with the Cruise Dual Analog Watch. The thick, adjustable band promises a comfortable, personalized fit to this classy, modern time piece.
Whether you're traveling or wish you were, you'll never let time zones perplex you again with the Cruise Dual Analog Watch. The thick, adjustable band promises a comfortable, personalized fit to this classy, modern time piece.
For long weekends away, camping outings and business trips, the Overnight Duffle can't be beat. The dual handles make it a cinch to carry, while the durable waterproof exterior helps you worry less about the weather. With multiple organizational pockets inside and out, it's the perfect travel companion.
For long weekends away, camping outings and business trips, the Overnight Duffle can't be beat. The dual handles make it a cinch to carry, while the durable waterproof exterior helps you worry less about the weather. With multiple organizational pockets inside and out, it's the perfect travel companion.
The Go-Get'r Pushup Grips safely provide the extra range of motion you need for a deep-dip routine targeting core, shoulder, chest and arm strength. Do fewer pushups using more energy, getting better results faster than the standard floor-level technique yield.
The Go-Get'r Pushup Grips safely provide the extra range of motion you need for a deep-dip routine targeting core, shoulder, chest and arm strength. Do fewer pushups using more energy, getting better results faster than the standard floor-level technique yield.
Powerwalking to the gym or strolling to the local coffeehouse, the Savvy Shoulder Tote lets you stash your essentials in sporty style! A top-loading compartment provides quick and easy access to larger items, while zippered pockets on the front and side hold cash, credit cards and phone.
Powerwalking to the gym or strolling to the local coffeehouse, the Savvy Shoulder Tote lets you stash your essentials in sporty style! A top-loading compartment provides quick and easy access to larger items, while zippered pockets on the front and side hold cash, credit cards and phone.
The Dash Digital Watch will challenge you to push harder and longer. Log workouts by date, average, and segment times, and recharge by setting hydration and nutrition alarms. This watch is styled with a sleek, square face and durable rubber strap for a long life.
The Dash Digital Watch will challenge you to push harder and longer. Log workouts by date, average, and segment times, and recharge by setting hydration and nutrition alarms. This watch is styled with a sleek, square face and durable rubber strap for a long life.
The Rival Field Messenger packs all your campus, studio or trail essentials inside a unique design of soft, textured leather - with loads of character to spare. Two exterior pockets keep all your smaller items handy, and the roomy interior offers even more space.
The Rival Field Messenger packs all your campus, studio or trail essentials inside a unique design of soft, textured leather - with loads of character to spare. Two exterior pockets keep all your smaller items handy, and the roomy interior offers even more space.
The Didi Sport Watch helps you keep your workout plan down to the second. The vertical, digital face looks sleek and futuristic. This watch is programmed with tons of helpful features such as a timer, an alarm clock, a pedometer, and more to help make your excercise more productive.
The Didi Sport Watch helps you keep your workout plan down to the second. The vertical, digital face looks sleek and futuristic. This watch is programmed with tons of helpful features such as a timer, an alarm clock, a pedometer, and more to help make your excercise more productive.
A basic Merchandising request. But using a wrong page identifier.
\n","urlObject":{"protocol":"https","path":["v2","merchandising"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"9a4879f2-d082-4491-bd58-bcdb666429cf","name":"Wrong page identifier - 404","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\"\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"wrong_identifier\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/merchandising"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 26 Feb 2026 10:21:05 GMT"},{"key":"permissions-policy","value":"geolocation=(), microphone=(), camera=(), payment=(), usb=(), magnetometer=(), accelerometer=(), gyroscope=(), speaker=(), vibrate=(), fullscreen=()"},{"key":"x-amzn-RequestId","value":"2e208dc3-d4d5-42e1-b410-09f07630f9cb"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"access-control-allow-origin","value":"*"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"x-frame-options","value":"DENY"},{"key":"content-security-policy","value":"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data: https:; connect-src 'self' https:; frame-ancestors 'none'; object-src 'none'; base-uri 'self'"},{"key":"x-amz-apigw-id","value":"ZYm22F0NliAEYHw="},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, proxy-revalidate"},{"key":"x-content-type-options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-69a01e91-75e3dc9e43b901b935ddac33;Parent=0f13a1dadf73f073;Sampled=0;Lineage=1:030c79d0:0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 e802bba79ff3efb2497084ca4babc248.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"AMS1-P2"},{"key":"X-Amz-Cf-Id","value":"rtGp_rJuwTAmsY32gAuC-BdxDzuSwscFEAp9ZJzrCx0DjGMrk-sgzw=="}],"cookie":[],"responseTime":null,"body":"Active merchandising with identifier \"wrong_identifier\" could not be found."}],"_postman_id":"23e7fa16-afc2-4c87-96ea-2e7b6411327a"}],"id":"46a2434a-b935-441d-b3be-72958eb91b27","description":"Merchandising allows customers to create an item listing page with specific items fixed to defined positions within the results. This allows integrators to create curated shop-front experiences in their product listing pages that leverages the underlying search functionality of Activate Search. Configuration documentation can be found in our customer support kb: https://activatesearch.spotler.help/hc/en-gb/articles/21206241642130-Merchandising
\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\"\n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nThe above request shows how simple it is to add Merchandised products to a search request. The response attribute pinned defines if this item was manually placed, as can be seen in the response excerpt below.
\"data\": [\n {\n \"properties\": {\n \"id\": \"38\",\n \"title\": \"Summit Watch\"\n },\n \"pinned\": true\n },\n {\n \"properties\": {\n \"id\": \"334\",\n \"title\": \"Lando Gym Jacket\"\n },\n \"pinned\": false\n },\n\n{\n \"index_uuid\": \"2594854e-42a5-4946-99d0-ff6f11b44b5e\",\n \"search_term\": \"*\",\n \"datasets\": {\n \"items\": {\n \"limit\": 10,\n \"offset\": 0,\n \"attributes\": [\n \"id\",\n \"title\",\n \"price\",\n \"sqr:category1\"\n ],\n \"filters\": [\n {\n \"type\": \"whereBetween\",\n \"field\": \"price\",\n \"start\": \"10\",\n \"end\": \"100\"\n } \n ]\n }\n },\n \"url\": \"https://example.example.com\",\n \"page_identifier\": \"gear\",\n \"scope\": \"merchandising\",\n \"user_session_id\": \"884570ec-a291-4892-babd-bf41faaef710\"\n}\n\nAs Merchandising uses the same API definition as standard Activate Search it also supports the same request features, such as filtering, sorting, and Datasets. The above example shows the same request, but applies price filtering to the results, including only products whose price is between 10 and 100.
\nAvailable filtering options are described in the Search Filtering section.
\nThis allows the client to specify which configured merchandising options should be applied to a search request, in this example for the defined Gear page.
Note: Manually pinned items will not be filtered and will always be placed. This allows implementers to upsell or crosssell items from across the catalogue regardless of the filters being applied.
\n","_postman_id":"46a2434a-b935-441d-b3be-72958eb91b27"},{"name":"Recommendations","item":[{"name":"Basic Requests","item":[{"name":"13. Recommendations Request","id":"83645d03-5c48-4d59-acf5-169f52b5c9fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"container_uuid\": \"caea77a1-86d7-4a83-b952-1109bea890ab\",\n \"product_ids\": [\n \"74\"\n ],\n \"filters\": [\n {\n \"field\": \"sqr:category2\",\n \"type\": \"whereIn\",\n \"values\": [\"Tops\",\"Bottoms\"]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/recommendations","description":"A recommendations request that provides a product id for similarity functionality and applies a category filter to the results.
\n","urlObject":{"protocol":"https","path":["v2","recommendations"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"6dfa4d9e-8095-4719-b581-d79ed51491ba","name":"13. Recommendations Request","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"container_uuid\": \"caea77a1-86d7-4a83-b952-1109bea890ab\",\n \"product_ids\": [\n \"74\"\n ],\n \"filters\": [\n {\n \"field\": \"sqr:category2\",\n \"type\": \"whereIn\",\n \"values\": [\"Tops\",\"Bottoms\"]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://search.spotlersearch.com/v2/recommendations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"4155"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:23:45 GMT"},{"key":"x-amzn-RequestId","value":"b6fb1dc5-4a23-4afd-afee-806cfa72d9e9"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qSPHZLliAEVGw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66795741-768205cf62fbc56a595ab318;Parent=687f79c474094ffd;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ea42f57e1e0a065bc1c1c637f97d3be4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P1"},{"key":"X-Amz-Cf-Id","value":"TgE_3jMxmUAZaX7iUrKLPt-yKlRAnGuO_hrwPYjQM2MbTBdGHOG4Ew=="}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 0,\n \"sort_fields\": [],\n \"data\": [\n {\n \"properties\": {\n \"id\": \"381\",\n \"title\": \"Typhon Performance Fleece-lined Jacket-XL-Red\",\n \"detail_url\": \"https://magento.sooqr.com/index.php/typhon-performance-fleece-lined-jacket.html\",\n \"text_text\": [\n \"Ironmen and couch warriors both reach for the Typhon Performance Fleece-lined Jacket. After all, no man can resist ultra-soft microfleece lining. Flatlock seams make it ideal for wearing over everything from tanks and tees to high-tech base layers.
• Black full-zip flight jacket.
• Cocona® wicking fiber.
• Machine wash/dry.
Chilly weather is just an excuse to throw on your toasty, handsome new Oslo Trek Hoodie. It features an adjustable drawstring hood and a kangaroo pocket for extra hand warmth. The ultra-soft, cozy lining will have you wishing for more brisk days.
• Brown hoodie with black detail.
• Pullover.
• Adjustable drawstring hood.
• Ribbed cuffs/waistband.
• Machine wash/dry.
A good running tank helps make the miles pass by keep you cool. The Erikssen CoolTech™ Fitness Tank completes that mission, with performance fabric engineered to wick perspiration and promote airflow.
• Red performance tank.
• Slight scoop neckline.
• Reflectivity.
• Machine wash/dry.
Ironmen and couch warriors both reach for the Typhon Performance Fleece-lined Jacket. After all, no man can resist ultra-soft microfleece lining. Flatlock seams make it ideal for wearing over everything from tanks and tees to high-tech base layers.
• Black full-zip flight jacket.
• Cocona® wicking fiber.
• Machine wash/dry.
The Ajax Full-Zip Sweatshirt makes the optimal layering or outer piece for archers, golfers, hikers and virtually any other sportsmen. Not only does it have top-notch moisture-wicking abilities, but the tight-weave fabric also prevents pilling from repeated wash-and-wear cycles.
• Mint striped full zip hoodie.
• 100% bonded polyester fleece.
• Pouch pocket.
• Rib cuffs and hem.
• Machine washable.
When the training gets intense, the Gobi HeatTec® Tee works as hard as you do to maintain your cool. The moisture-wicking material promises drier comfort, while breathable side panels deliver extra stretch that's sure to keep you moving.
• Orange micropolyester shirt.
• HeatTec® wicking fabric.
• Crew neckline.
• Machine wash/dry.
An example of the recommendations configuration endpoint that returns the UX configuration as set in MySearch.
\n","urlObject":{"protocol":"https","path":["v2","indexes","2594854e-42a5-4946-99d0-ff6f11b44b5e","recommenders","caea77a1-86d7-4a83-b952-1109bea890ab","config"],"host":["search","spotlersearch","com"],"query":[],"variable":[]}},"response":[{"id":"e6c5e2c0-a275-465d-93ba-3781333a21ac","name":"14. Configuration Request","originalRequest":{"method":"GET","header":[],"url":"https://search.spotlersearch.com/v2/indexes/2594854e-42a5-4946-99d0-ff6f11b44b5e/recommenders/caea77a1-86d7-4a83-b952-1109bea890ab/configarc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"754"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 24 Jun 2024 11:23:54 GMT"},{"key":"x-amzn-RequestId","value":"4839846e-ae91-4db8-b477-786ff706bfb1"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-amz-apigw-id","value":"Z3qTpEpmFiAEJ1A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6679574a-1a922adf5686dd8855e786fa;Parent=621c64ea23d83040;Sampled=0;lineage=030c79d0:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 048de604b26de968a1aa2fe5dd1a0084.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C2"},{"key":"X-Amz-Cf-Id","value":"QqPo998ZhHNCY8KN1W5dZASQ2F3heR-bQ_AbQkgsAW3kbownBGiN8w=="}],"cookie":[],"responseTime":null,"body":"{\n \"active_recommender_name\": \"Integration Guide Recommender\",\n \"container_name\": \"Integration Guide Container\",\n \"container_uuid\": \"caea77a1-86d7-4a83-b952-1109bea890ab\",\n \"design\": {\n \"automatic_sliding\": false,\n \"colors\": {\n \"description_color\": \"747474\",\n \"header_title_color\": \"00ACE4\",\n \"old_price_color\": \"aaaaaa\"\n },\n \"currency\": \"EUR\",\n \"locale\": \"en-US\",\n \"font_family\": \"Arial\",\n \"font_size\": \"13px\",\n \"maximum_slide_width\": null,\n \"minimum_slide_width\": 150,\n \"no_img_img\": \"https://static.sooqr.com/global/image/no-image.png\",\n \"open_in_new_tab\": true,\n \"show_currency_symbol\": true,\n \"slide_timeout\": 5000\n },\n \"fields\": {\n \"double_normal_price\": false,\n \"image\": true,\n \"price\": true,\n \"text_text\": true,\n \"title\": true\n },\n \"number_of_results\": 6,\n \"show_recommender_name\": true,\n \"uuid\": \"29ed76f3-019a-43c6-8fcc-47cf4c75140b\"\n}"}],"_postman_id":"0d3b55b0-2949-498f-93b1-16ab46d2e95f"}],"id":"b5517faf-ffe3-4919-88a8-ffc75ec63be1","description":"The Recommendations Configuration endpoint provides a JSON object for the configuration of a Recommender Container. This object contains confiuration related to how the client will display the Recommender.
\nThis is a simple GET requst using the following format
\nGET https://search.spotlersearch.com/v2/indexes/{index_uuid}/recommenders/{container_uuid}/config
The index_uuid and container_uuid values are available within MySearch
The service endpoint is at https://search.spotlersearch.com/v2/recommendations.
\nThis service provides a list of items for display based upon configuration provided in MySearch.
\n{\n \"container_uuid\": \"caea77a1-86d7-4a83-b952-1109bea890ab\",\n \"product_ids\": [\n \"74\"\n ],\n \"filters\": [\n {\n \"field\": \"sqr:category2\",\n \"type\": \"whereIn\",\n \"values\": [\"Tops\",\"Bottoms\"]\n }\n ]\n}\n\nThe above request contains just two attributes. The container_uuid is required and can be obtained from MySearch. The product_ids attribtue is a list of product ids that is used by the specific Recommender Container. [note: current functionality supports only a single Item id, the first one defined in the array is the one used and the rest are ignored.]
Clients can filter the Recommendations using the same format as used for the search endpoint as described in prior sections.
\nThe above example is tied to Recommender, whose container_uuid is available inthe MySearch configuration, that perfoms a similarity search based on the color attribute for the product with id 74[Which is a Red Tee-shirt] These recommendations are then filtered to show only products in the Tops and Bottoms categories, excluding any other categories.
The current version of the endpoint is the /v2/ endpoint. This implemention radically overhauls and obsoletes the previous version. As such, this documentation will only discuss this version of the API. All new accounts are automatically v2, however old accounts will continue to use the obsolete v1 API endpoint but can be migrated to the newer version by Spotify Activate Professional Services.
\nThe Item API endpoint provides up-to-date OpenAPI 3.1 definition and documentation.
[Item API Definition] [OpenAPI Documentation]
This guide expands on that documentation with some common usage scenarios.