{ "parameters": [ ], "response_fields": [ ], "requests": [ { "request_headers": { }, "request_query_parameters": { }, "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": "Wed, 19 Aug 2020 13:57:21 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-Workarea-Segments", "Last-Modified": "Wed, 19 Aug 2020 13:57:21 GMT", "Cache-Control": "no-cache, no-store, must-revalidate", "X-Request-Id": "c9551c4e-40fa-4f32-92ad-bcab93497379", "X-Runtime": "0.070922", "X-Workarea-Segments": "", "Expires": "0", "Content-Length": "4103" }, "request_method": "GET", "request_path": "/api/storefront/products/nice-shirt", "request_body": null, "request_content_type": null, "response_status": 200, "response_status_text": "OK", "response_body": "{\n \"product\": {\n \"id\": \"D4F7562AFC\",\n \"name\": \"Nice Shirt\",\n \"description\": null,\n \"slug\": \"nice-shirt\",\n \"browser_title\": \"Nice 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\": \"5f3d2fc00218236e938cf884\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n },\n {\n \"id\": \"5f3d2fc00218236e938cf885\",\n \"name\": \"SKU2\",\n \"sku\": \"SKU2\",\n \"details\": {\n \"color\": [\n \"Red\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 300.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\": 300.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5f3d2fc00218236e938cf886\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n \"recommendations\": [\n {\n \"id\": \"09730125B6\",\n \"name\": \"Fall Jacket\",\n \"description\": null,\n \"slug\": \"fall-jacket\",\n \"browser_title\": \"Fall Jacket\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\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\": \"5f3d2fc10218236e938cf89b\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\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\": \"5f3d2fc10218236e938cf89c\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/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/products/nice-shirt\" -X GET " } ], "resource": "Products", "description": "Showing a product", "route": "/api/storefront/products/:slug", "explanation": "
This endpoint includes everything you need to render a product
\ndetail page including, variants, images, and recommendations.