{ "parameters": [ ], "response_fields": [ ], "requests": [ { "request_headers": { }, "request_query_parameters": { "q": "red" }, "response_headers": { "X-Frame-Options": "SAMEORIGIN", "X-XSS-Protection": "1; mode=block", "X-Content-Type-Options": "nosniff", "X-Download-Options": "noopen", "X-Permitted-Cross-Domain-Policies": "none", "Referrer-Policy": "strict-origin-when-cross-origin", "Date": "Thu, 22 Aug 2019 17:00:24 GMT", "Content-Type": "application/json; charset=utf-8", "Access-Control-Allow-Origin": "*", "Access-Control-Allow-Headers": "*", "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS", "X-Requested-With": "", "Vary": "X-Requested-With, X-Flash-Messages", "Cache-Control": "no-cache, no-store, must-revalidate", "ETag": "W/\"5cadef3e3fd1835a35070954308d0d32\"", "X-Request-Id": "02b9b8a2-403b-4f94-83ea-5cebacd48cee", "X-Runtime": "0.055426", "Expires": "0", "Content-Length": "631" }, "request_method": "GET", "request_path": "/api/storefront/searches?q=red", "request_body": null, "request_content_type": null, "response_status": 200, "response_status_text": "OK", "response_body": "{\n \"results\": [\n {\n \"value\": \"red\",\n \"type\": \"Searches\",\n \"image\": null,\n \"url\": \"/api/storefront/search?q=red\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Product\",\n \"type\": \"Products\",\n \"image\": \"/product_images/placeholder/small_thumb.jpg?c=1566493120\",\n \"url\": \"/api/storefront/products/red-product\",\n \"analytics\": {\n \"id\": \"8CB6DE3B62\",\n \"name\": \"Red Product\",\n \"sku\": null,\n \"sale\": false,\n \"price\": 5.0,\n \"category\": null\n }\n },\n {\n \"value\": \"Page about Red Products\",\n \"type\": \"Pages\",\n \"image\": null,\n \"url\": \"/api/storefront/pages/page-about-red-products\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Category\",\n \"type\": \"Categories\",\n \"image\": null,\n \"url\": \"/api/storefront/categories/red-category\",\n \"analytics\": null\n }\n ]\n}", "response_content_type": "application/json", "curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET " } ], "resource": "Searches", "description": "Showing search autocomplete suggestions", "route": "/api/storefront/searches", "http_method": "GET", "explanation": " This list will be based on popular search terms and matching\n products, categories, etc. Useful for showing a autocomplete\n drop-down as a customer types in a search bar.\n" }