{ "parameters": [ { "name": "sort", "description": "Sort by" }, { "name": "page", "description": "Page number" }, { "name": ":facet_name", "description": "Each facet setup on the category will have a corresponding parameter" } ], "response_fields": [ ], "requests": [ { "request_headers": { }, "request_query_parameters": { "page": "1", "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:03:14 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/\"d77464fb879e2e6511c1f89966f35dfb\"", "X-Request-Id": "0a68049d-aba8-429b-9af0-20b6b51247b1", "X-Runtime": "0.032425", "Expires": "0", "Content-Length": "5026" }, "request_method": "GET", "request_path": "/api/storefront/categories/shirts?page=1&sort=price_desc", "request_body": null, "request_content_type": null, "response_status": 200, "response_status_text": "OK", "response_body": "{\n \"id\": \"5d5ecad2d4322a04dfbf7137\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"browser_title\": \"Home - Mens - Shirts\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"sorts\": [\n [\n \"Featured\",\n \"featured\"\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\": \"price_desc\",\n \"breadcrumbs\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf713b\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713b\",\n \"name\": \"Home\",\n \"depth\": 0,\n \"navigable_url\": \"/\",\n \"parent_id\": null,\n \"parent_ids\": [\n\n ],\n \"position\": 0\n },\n {\n \"id\": \"5d5ecad2d4322a04dfbf713a\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713a\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": null,\n \"parent_id\": \"5d5ecad2d4322a04dfbf713b\",\n \"parent_ids\": [\n \"5d5ecad2d4322a04dfbf713b\"\n ],\n \"position\": 0\n },\n {\n \"id\": \"5d5ecad2d4322a04dfbf713c\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713c\",\n \"name\": \"Shirts\",\n \"depth\": 2,\n \"navigable_url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"parent_id\": \"5d5ecad2d4322a04dfbf713a\",\n \"parent_ids\": [\n \"5d5ecad2d4322a04dfbf713b\",\n \"5d5ecad2d4322a04dfbf713a\"\n ],\n \"position\": 0\n }\n ],\n \"content_blocks\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf713d\",\n \"type\": \"text\",\n \"area\": \"above_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"\\n\"\n },\n {\n \"id\": \"5d5ecad2d4322a04dfbf713e\",\n \"type\": \"text\",\n \"area\": \"below_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"\\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\": 1,\n \"total_pages\": 1,\n \"facets\": [\n {\n \"type\": \"terms\",\n \"name\": \"Size\",\n \"display_name\": \"Size\",\n \"results\": [\n {\n \"name\": \"Small\",\n \"count\": 1\n },\n {\n \"name\": \"Medium\",\n \"count\": 1\n },\n {\n \"name\": \"Large\",\n \"count\": 1\n }\n ]\n }\n ],\n \"products\": [\n {\n \"id\": \"0CC2B425DC\",\n \"name\": \"Sweet Shirt\",\n \"description\": null,\n \"slug\": \"sweet-shirt\",\n \"browser_title\": \"Sweet Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\n ],\n \"color\": [\n \"Red\"\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\": \"5d5ecad2d4322a04dfbf7135\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf7136\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/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/categories/shirts?page=1&sort=price_desc\" -X GET " } ], "resource": "Categories", "description": "Showing a category", "route": "/api/storefront/categories/:slug", "http_method": "GET", "explanation": " This endpoint includes everything you need to render a category,\n including any associated content, products, and filters.\n" }