{
  "parameters": [
    {
      "name": "q",
      "description": "The search query string entered by the customer"
    },
    {
      "name": "sort",
      "description": "Sort by"
    },
    {
      "name": "page",
      "description": "Page number"
    },
    {
      "name": ":facet_name",
      "description": "Each facet setup on search settings will have a corresponding parameter"
    }
  ],
  "response_fields": [

  ],
  "requests": [
    {
      "request_headers": {
      },
      "request_query_parameters": {
        "page": "1",
        "q": "large",
        "sort": "price_desc"
      },
      "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:25 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/\"cbbd627ecb28bfddcc28d6597fc07c2e\"",
        "X-Request-Id": "bf062e15-7dc7-4d52-8a59-09ae63b7ce6f",
        "X-Runtime": "0.119178",
        "Expires": "0",
        "Content-Length": "6349"
      },
      "request_method": "GET",
      "request_path": "/api/storefront/search?page=1&q=large&sort=price_desc",
      "request_body": null,
      "request_content_type": null,
      "response_status": 200,
      "response_status_text": "OK",
      "response_body": "{\n  \"query_string\": \"large\",\n  \"message\": null,\n  \"redirect\": null,\n  \"sorts\": [\n    [\n      \"Relevance\",\n      \"relevance\"\n    ],\n    [\n      \"Top Sellers\",\n      \"top_sellers\"\n    ],\n    [\n      \"Most Popular\",\n      \"popularity\"\n    ],\n    [\n      \"Newest\",\n      \"newest\"\n    ],\n    [\n      \"Price, Low to High\",\n      \"price_asc\"\n    ],\n    [\n      \"Price, High to Low\",\n      \"price_desc\"\n    ]\n  ],\n  \"sort\": {\n    \"name\": \"Price, High to Low\",\n    \"slug\": \"price_desc\",\n    \"field\": \"sorts.price\",\n    \"direction\": \"desc\"\n  },\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5eca28d4322a04dfbf69d7\",\n      \"type\": \"text\",\n      \"area\": \"results\",\n      \"data\": {\n        \"text\": \"Huzzah! Your search results are below!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d7\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d7&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Huzzah! Your search results are below!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5eca28d4322a04dfbf69d8\",\n      \"type\": \"text\",\n      \"area\": \"no_results\",\n      \"data\": {\n        \"text\": \"Sorry, we can't find what you searched for!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d8\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d8&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Sorry, we can&#39;t find what you searched for!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n    }\n  ],\n  \"first_page\": true,\n  \"second_page\": false,\n  \"last_page\": true,\n  \"page\": 1,\n  \"next_page\": null,\n  \"prev_page\": null,\n  \"per_page\": 20,\n  \"total_results\": 2,\n  \"total_pages\": 1,\n  \"facets\": [\n\n  ],\n  \"products\": [\n    {\n      \"id\": \"PRODUCT1\",\n      \"name\": \"Pretty Nice Shirt\",\n      \"description\": null,\n      \"slug\": \"pretty-nice-shirt\",\n      \"browser_title\": \"Pretty Nice Shirt\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Blue\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69da\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69db\",\n          \"option\": \"Blue\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    },\n    {\n      \"id\": \"PRODUCT2\",\n      \"name\": \"Great Pants\",\n      \"description\": null,\n      \"slug\": \"great-pants\",\n      \"browser_title\": \"Great Pants\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Brown\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69dd\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69de\",\n          \"option\": \"Brown\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}",
      "response_content_type": "application/json",
      "curl": "curl -g \"https://www.example.com/api/storefront/search?page=1&q=large&sort=price_desc\" -X GET "
    }
  ],
  "resource": "Searches",
  "description": "Showing search results",
  "route": "/api/storefront/search",
  "http_method": "GET",
  "explanation": "            This endpoint returns everything you'll need to show search results\n            to customers. This includes products, filters, and any content\n            that's been setup by an administrator.\n"
}