workarea-api 4.4.6

data/doc/api/storefront/orders/listing_the_user_s_orders.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Authorization": "Token token=\"VCLZLZNytgSk4eNoMvB6fiEd\""
+      },
+      "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",
+        "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",
+        "ETag": "W/\"1163dbf0c33850e8e2585e30e3fb94da\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "801fbb0b-a79e-4df0-ad1f-135934c99600",
+        "X-Runtime": "0.028632",
+        "Expires": "0",
+        "Content-Length": "6389"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/orders",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"user_id\": \"5d5dbce1d4322a4b69d78a50\",\n  \"orders\": [\n    {\n      \"id\": \"5FD19B695B\",\n      \"url\": \"http://www.example.com/api/storefront/orders/5FD19B695B\",\n      \"user_id\": \"5d5dbce1d4322a4b69d78a50\",\n      \"email\": \"sbaker@workarea.com\",\n      \"placed_at\": \"2019-08-21T21:51:31.859Z\",\n      \"canceled_at\": null,\n      \"promo_codes\": [\n\n      ],\n      \"requires_shipping\": true,\n      \"items\": [\n        {\n          \"id\": \"5d5dbce2d4322a4b69d78a5a\",\n          \"product_id\": \"EC647996A2\",\n          \"sku\": \"PROD3\",\n          \"quantity\": 1,\n          \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n          \"options\": {\n          },\n          \"customizations\": {\n            \"foo\": \"bar\"\n          },\n          \"product_image\": {\n            \"urls\": [\n              {\n                \"type\": \"small\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"small_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"large_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"detail\",\n                \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"super_zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon_ico\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n              }\n            ]\n          },\n          \"pricing\": {\n            \"price_adjustments\": [\n              {\n                \"description\": \"Item Subtotal\",\n                \"discount\": false,\n                \"amount\": {\n                  \"cents\": 2000.0,\n                  \"currency_iso\": \"USD\"\n                }\n              }\n            ],\n            \"total_price\": {\n              \"cents\": 2000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"on_sale\": false,\n            \"original_unit_price\": {\n              \"cents\": 2000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"original_price\": {\n              \"cents\": 2000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"customized\": true,\n            \"customizations_unit_price\": {\n              \"cents\": 0.0,\n              \"currency_iso\": \"USD\"\n            }\n          }\n        },\n        {\n          \"id\": \"5d5dbce2d4322a4b69d78a57\",\n          \"product_id\": \"12DF7369C8\",\n          \"sku\": \"PROD2\",\n          \"quantity\": 1,\n          \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\n          \"options\": {\n          },\n          \"customizations\": {\n          },\n          \"product_image\": {\n            \"urls\": [\n              {\n                \"type\": \"small\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"small_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"large_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"detail\",\n                \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"super_zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon_ico\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n              }\n            ]\n          },\n          \"pricing\": {\n            \"price_adjustments\": [\n              {\n                \"description\": \"Item Subtotal\",\n                \"discount\": false,\n                \"amount\": {\n                  \"cents\": 1000.0,\n                  \"currency_iso\": \"USD\"\n                }\n              }\n            ],\n            \"total_price\": {\n              \"cents\": 1000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"on_sale\": false,\n            \"original_unit_price\": {\n              \"cents\": 1000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"original_price\": {\n              \"cents\": 1000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"customized\": false,\n            \"customizations_unit_price\": {\n              \"cents\": 0.0,\n              \"currency_iso\": \"USD\"\n            }\n          }\n        },\n        {\n          \"id\": \"5d5dbce2d4322a4b69d78a54\",\n          \"product_id\": \"1AFBE84648\",\n          \"sku\": \"PROD1\",\n          \"quantity\": 2,\n          \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\n          \"options\": {\n          },\n          \"customizations\": {\n          },\n          \"product_image\": {\n            \"urls\": [\n              {\n                \"type\": \"small\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"small_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"medium_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"large_thumb\",\n                \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"detail\",\n                \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"super_zoom\",\n                \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n              },\n              {\n                \"type\": \"favicon_ico\",\n                \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n              }\n            ]\n          },\n          \"pricing\": {\n            \"price_adjustments\": [\n              {\n                \"description\": \"Item Subtotal\",\n                \"discount\": false,\n                \"amount\": {\n                  \"cents\": 1000.0,\n                  \"currency_iso\": \"USD\"\n                }\n              }\n            ],\n            \"total_price\": {\n              \"cents\": 1000.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"on_sale\": false,\n            \"original_unit_price\": {\n              \"cents\": 500.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"original_price\": {\n              \"cents\": 500.0,\n              \"currency_iso\": \"USD\"\n            },\n            \"customized\": false,\n            \"customizations_unit_price\": {\n              \"cents\": 0.0,\n              \"currency_iso\": \"USD\"\n            }\n          }\n        }\n      ],\n      \"pricing\": {\n        \"price_adjustments\": [\n\n        ],\n        \"shipping_total\": {\n          \"cents\": 100.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"tax_total\": {\n          \"cents\": 0.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"subtotal_price\": {\n          \"cents\": 4000.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"total_price\": {\n          \"cents\": 4100.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"paid_amount\": {\n          \"cents\": 4100.0,\n          \"currency_iso\": \"USD\"\n        }\n      },\n      \"shipping_service\": \"Express\",\n      \"shipping_address\": {\n        \"id\": \"5d5dbce2d4322a4b69d78a5e\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"350 Fifth Avenue\",\n        \"street_2\": \"Second Floor\",\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": \"6465552390\",\n        \"phone_extension\": null\n      },\n      \"billing_address\": {\n        \"id\": \"5d5dbce2d4322a4b69d78a72\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"350 Fifth Avenue\",\n        \"street_2\": \"Second Floor\",\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": \"6465552390\",\n        \"phone_extension\": null\n      },\n      \"tenders\": [\n        {\n          \"type\": \"credit_card\",\n          \"amount\": {\n            \"cents\": 4100.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"issuer\": \"Test Card\",\n          \"display_number\": \"XXXX-XXXX-XXXX-1\",\n          \"month\": 1,\n          \"year\": 2020\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/orders\" -X GET \\\n\t-H \"Authorization: Token token=\\\"VCLZLZNytgSk4eNoMvB6fiEd\\\"\""
+    }
+  ],
+  "resource": "Orders",
+  "description": "Listing the user's orders",
+  "route": "/api/storefront/orders",
+  "explanation": "            This endpoints returns recently placed orders for a customer. Use it\n            for showing an order history for the customer.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/orders/showing_an_order.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Authorization": "Token token=\"3KoD46iQWsj9GcFv3StnTmTp\""
+      },
+      "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",
+        "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",
+        "ETag": "W/\"00be926cf0b3981ce08c4d54f11c9e29\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "e0353fff-f011-4f9c-9e09-aa2f0d8321ea",
+        "X-Runtime": "0.038223",
+        "Expires": "0",
+        "Content-Length": "11595"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/orders/4B5A26891C",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"4B5A26891C\",\n    \"url\": \"http://www.example.com/api/storefront/orders/4B5A26891C\",\n    \"user_id\": \"5d5dbcded4322a4b69d789f6\",\n    \"email\": \"sbaker@workarea.com\",\n    \"placed_at\": \"2019-08-21T21:51:28.274Z\",\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5d5dbcded4322a4b69d78a00\",\n        \"product_id\": \"FE98C1877E\",\n        \"sku\": \"PROD3\",\n        \"quantity\": 1,\n        \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n        \"options\": {\n        },\n        \"customizations\": {\n          \"foo\": \"bar\"\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 2000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": true,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      },\n      {\n        \"id\": \"5d5dbcded4322a4b69d789fd\",\n        \"product_id\": \"34615B56C8\",\n        \"sku\": \"PROD2\",\n        \"quantity\": 1,\n        \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      },\n      {\n        \"id\": \"5d5dbcded4322a4b69d789fa\",\n        \"product_id\": \"BFAF72E85F\",\n        \"sku\": \"PROD1\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 4000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 4100.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 4100.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": \"Express\",\n    \"shipping_address\": {\n      \"id\": \"5d5dbcded4322a4b69d78a04\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": \"Second Floor\",\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"billing_address\": {\n      \"id\": \"5d5dbcdfd4322a4b69d78a18\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": \"Second Floor\",\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"tenders\": [\n      {\n        \"type\": \"credit_card\",\n        \"amount\": {\n          \"cents\": 4100.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"issuer\": \"Test Card\",\n        \"display_number\": \"XXXX-XXXX-XXXX-1\",\n        \"month\": 1,\n        \"year\": 2020\n      }\n    ]\n  },\n  \"fulfillment\": {\n    \"status\": \"Partially Shipped\",\n    \"packages\": [\n      {\n        \"tracking_number\": \"1z\",\n        \"tracking_link\": \"http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1z\",\n        \"items\": [\n          {\n            \"id\": \"5d5dbcded4322a4b69d789fa\",\n            \"product_id\": \"BFAF72E85F\",\n            \"sku\": \"PROD1\",\n            \"quantity\": 2,\n            \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\n            \"options\": {\n            },\n            \"customizations\": {\n            },\n            \"product_image\": {\n              \"urls\": [\n                {\n                  \"type\": \"small\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"medium\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"small_thumb\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"medium_thumb\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"large_thumb\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"detail\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"zoom\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"super_zoom\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"favicon\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n                },\n                {\n                  \"type\": \"favicon_ico\",\n                  \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n                }\n              ]\n            },\n            \"pricing\": {\n              \"price_adjustments\": [\n                {\n                  \"description\": \"Item Subtotal\",\n                  \"discount\": false,\n                  \"amount\": {\n                    \"cents\": 1000.0,\n                    \"currency_iso\": \"USD\"\n                  }\n                }\n              ],\n              \"total_price\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              },\n              \"on_sale\": false,\n              \"original_unit_price\": {\n                \"cents\": 500.0,\n                \"currency_iso\": \"USD\"\n              },\n              \"original_price\": {\n                \"cents\": 500.0,\n                \"currency_iso\": \"USD\"\n              },\n              \"customized\": false,\n              \"customizations_unit_price\": {\n                \"cents\": 0.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          }\n        ]\n      }\n    ],\n    \"pending_items\": [\n      {\n        \"id\": \"5d5dbcded4322a4b69d78a00\",\n        \"product_id\": \"FE98C1877E\",\n        \"sku\": \"PROD3\",\n        \"quantity\": 1,\n        \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n        \"options\": {\n        },\n        \"customizations\": {\n          \"foo\": \"bar\"\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 2000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": true,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"canceled_items\": [\n      {\n        \"id\": \"5d5dbcded4322a4b69d789fd\",\n        \"product_id\": \"34615B56C8\",\n        \"sku\": \"PROD2\",\n        \"quantity\": 1,\n        \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ]\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/orders/4B5A26891C\" -X GET \\\n\t-H \"Authorization: Token token=\\\"3KoD46iQWsj9GcFv3StnTmTp\\\"\""
+    }
+  ],
+  "resource": "Orders",
+  "description": "Showing an order",
+  "route": "/api/storefront/orders/:id",
+  "explanation": "            This endpoint returns everything needed to render an order for a\n            customer's order history including order details and fulfillment\n            status.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/pages/showing_a_page.json

@@ -0,0 +1,51 @@
+{
+  "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, 21 Aug 2019 21:54:44 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/\"3acf4dc26f76e7deb56d8f8cc55d891a\"",
+        "X-Request-Id": "0a18eb33-f92d-4e00-b65e-366ab36f9ce3",
+        "X-Runtime": "0.017454",
+        "Expires": "0",
+        "Content-Length": "3949"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/pages/summer-lookbook",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbda3d4322a4b69d79359\",\n  \"name\": \"Summer Lookbook\",\n  \"url\": \"http://www.example.com/api/storefront/pages/summer-lookbook\",\n  \"browser_title\": \"Summer Lookbook\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"breadcrumbs\": [\n    {\n      \"id\": \"5d5dbda4d4322a4b69d7935c\",\n      \"url\": \"/api/storefront/taxons/5d5dbda4d4322a4b69d7935c\",\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\": \"5d5dbda3d4322a4b69d7935b\",\n      \"url\": \"/api/storefront/taxons/5d5dbda3d4322a4b69d7935b\",\n      \"name\": \"Women\",\n      \"depth\": 1,\n      \"navigable_url\": \"www.example.com/women\",\n      \"parent_id\": \"5d5dbda4d4322a4b69d7935c\",\n      \"parent_ids\": [\n        \"5d5dbda4d4322a4b69d7935c\"\n      ],\n      \"position\": 0\n    },\n    {\n      \"id\": \"5d5dbda4d4322a4b69d7935d\",\n      \"url\": \"/api/storefront/taxons/5d5dbda4d4322a4b69d7935d\",\n      \"name\": \"Summer Lookbook\",\n      \"depth\": 2,\n      \"navigable_url\": \"http://www.example.com/api/storefront/pages/summer-lookbook\",\n      \"parent_id\": \"5d5dbda3d4322a4b69d7935b\",\n      \"parent_ids\": [\n        \"5d5dbda4d4322a4b69d7935c\",\n        \"5d5dbda3d4322a4b69d7935b\"\n      ],\n      \"position\": 0\n    }\n  ],\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbda4d4322a4b69d7935e\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Great new looks for summer\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbda4d4322a4b69d7935e\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbda4d4322a4b69d7935e&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Great new looks for summer&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Great new looks for summer</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbda4d4322a4b69d79360\",\n      \"type\": \"image\",\n      \"area\": \"default\",\n      \"data\": {\n        \"image\": \"5d5dbda4d4322a4b69d7935f\",\n        \"alt\": \"splash\",\n        \"link\": \"\",\n        \"align\": \"\",\n        \"image_url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMDgvMjEvN3N4NTQ1OTB1NF9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=2aa463f5630bc220\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--image\\\" id=\\\"content_block_5d5dbda4d4322a4b69d79360\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbda4d4322a4b69d79360&quot;,&quot;type&quot;:&quot;image&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;image&quot;:&quot;5d5dbda4d4322a4b69d7935f&quot;,&quot;alt&quot;:&quot;splash&quot;,&quot;link&quot;:&quot;&quot;,&quot;align&quot;:&quot;&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='image-content-block image-content-block--'>\\n<img alt=\\\"splash\\\" class=\\\"image-content-block__image\\\" src=\\\"/media/W1siZiIsIjIwMTkvMDgvMjEvN3N4NTQ1OTB1NF9maWxlLmpwZyJdXQ/file.jpg?sha=6eaac3a7a86770ca\\\" />\\n</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbda4d4322a4b69d79361\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Pool party fashion\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 2,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbda4d4322a4b69d79361\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbda4d4322a4b69d79361&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:2,&quot;data&quot;:{&quot;text&quot;:&quot;Pool party fashion&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Pool party fashion</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/pages/summer-lookbook\" -X GET "
+    }
+  ],
+  "resource": "Pages",
+  "description": "Showing a page",
+  "route": "/api/storefront/pages/:slug",
+  "explanation": "            This endpoint will return all relevant data for showing a content\n            page.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "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",
+        "Content-Type": "application/json",
+        "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",
+        "X-Request-Id": "71bcddb7-206f-4e11-9a73-81de11f5539f",
+        "X-Runtime": "0.051574",
+        "Expires": "0",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/password_resets",
+      "request_body": "{\"email\":\"user7@workarea.com\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/password_resets\" -d '{\"email\":\"user7@workarea.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Password Resets",
+  "description": "Sending a forgot password email",
+  "route": "/api/storefront/password_resets",
+  "explanation": "            This will send a password reset email to the email address if there\n            is an account. The email will contain a link to the site where the\n            password reset can be completed.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json

@@ -0,0 +1,55 @@
+{
+  "parameters": [
+    {
+      "name": "session_id",
+      "description": "A unique session_id you keep for an anonymous browser"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "session_id": "5d5dbd03d4322a4b69d78bcd"
+      },
+      "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",
+        "ETag": "W/\"be65f3ab42758d84aeddbf3e485648bd\"",
+        "Last-Modified": "Wed, 21 Aug 2019 21:52:03 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",
+        "X-Request-Id": "797b2125-19fb-48e2-95b1-17a8308b7f15",
+        "X-Runtime": "0.036716",
+        "Expires": "0",
+        "Content-Length": "3882"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/recommendations?session_id=5d5dbd03d4322a4b69d78bcd",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"id\": \"5FF338C21A\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-8\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd02d4322a4b69d78bc9\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"29096749D8\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbcfed4322a4b69d78bb9\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"EEEAEAACE8\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-4\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbcffd4322a4b69d78bc1\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"6B5D01C965\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-2\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbcfed4322a4b69d78bbd\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"481326709B\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-3\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbcffd4322a4b69d78bbf\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"F63E4BAE76\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-7\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd01d4322a4b69d78bc7\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/recommendations?session_id=5d5dbd03d4322a4b69d78bcd\" -X GET "
+    }
+  ],
+  "resource": "Personalized Recommendations",
+  "description": "Showing recommendations with a session ID",
+  "route": "/api/storefront/recommendations",
+  "explanation": "            Display personalized recommendations based on a session ID that\n            you've maintained for an anonymous browser (as opposed to\n            authentication).\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Authorization": "Token token=\"Arr2qngbgTaExhsZVyGHZjiv\""
+      },
+      "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",
+        "ETag": "W/\"56c7c66c36f11a5934f425a6b1266426\"",
+        "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",
+        "X-Request-Id": "169f489f-b6be-491f-b499-4170689a42d2",
+        "X-Runtime": "0.033992",
+        "Expires": "0",
+        "Content-Length": "3882"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/recommendations",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"id\": \"DBB45C161E\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd03d4322a4b69d78bd3\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"5C23FDEF1C\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-1\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd04d4322a4b69d78bd5\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"3EE998F26A\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-4\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd05d4322a4b69d78bdb\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"9CDFD9860E\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-9\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd08d4322a4b69d78be5\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"203FF74EDB\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-3\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd04d4322a4b69d78bd9\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    },\n    {\n      \"id\": \"59AB1ED30D\",\n      \"name\": \"Test Product\",\n      \"description\": null,\n      \"slug\": \"test-product-7\",\n      \"browser_title\": \"Test Product\",\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        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd07d4322a4b69d78be1\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/recommendations\" -X GET \\\n\t-H \"Authorization: Token token=\\\"Arr2qngbgTaExhsZVyGHZjiv\\\"\""
+    }
+  ],
+  "resource": "Personalized Recommendations",
+  "description": "Showing recommendations with authentication",
+  "route": "/api/storefront/recommendations",
+  "explanation": "            Display personalized recommendations based on the currently\n            authenticated customer.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/products/showing_a_product.json

@@ -0,0 +1,51 @@
+{
+  "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, 21 Aug 2019 21:55:18 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/\"161c9e3eeae25f6eaab924c298a8c9b5\"",
+        "X-Request-Id": "0b5c244e-add8-41a0-b83e-c78429b4636a",
+        "X-Runtime": "0.040306",
+        "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\": \"CF0F8B0BBF\",\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\": \"5d5dbdc6d4322a4b69d795a3\",\n        \"name\": \"SKU1\",\n        \"sku\": \"SKU1\",\n        \"details\": {\n          \"color\": [\n            \"Blue\"\n          ]\n        }\n      },\n      {\n        \"id\": \"5d5dbdc6d4322a4b69d795a4\",\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\": \"5d5dbdc6d4322a4b69d795a5\",\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/5d5dbdc6d4322a4b69d795a5/small.jpg?c=0\"\n          },\n          {\n            \"type\": \"medium\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/medium.jpg?c=0\"\n          },\n          {\n            \"type\": \"small_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/small_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"medium_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/medium_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"large_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/large_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"detail\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/detail.jpg?c=0\"\n          },\n          {\n            \"type\": \"zoom\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/zoom.jpg?c=0\"\n          },\n          {\n            \"type\": \"super_zoom\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/super_zoom.jpg?c=0\"\n          },\n          {\n            \"type\": \"favicon\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/favicon.jpg?c=0\"\n          },\n          {\n            \"type\": \"favicon_ico\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc6d4322a4b69d795a5/favicon_ico.jpg?c=0\"\n          }\n        ]\n      }\n    ]\n  },\n  \"recommendations\": [\n    {\n      \"id\": \"EE3230BDA1\",\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\": \"5d5dbdc6d4322a4b69d795a7\",\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\": \"5d5dbdc6d4322a4b69d795a8\",\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/5d5dbdc6d4322a4b69d795a8/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc6d4322a4b69d795a8/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\n            detail page including, variants, images, and recommendations.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json

@@ -0,0 +1,55 @@
+{
+  "parameters": [
+    {
+      "name": "sku",
+      "description": "View products details specifically for this SKU"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "sku": "SKU2"
+      },
+      "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, 21 Aug 2019 21:55:19 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/\"0d1d8721ad6a90da4b7161a820cb6db3\"",
+        "X-Request-Id": "765e7e3c-53e8-44b9-8be5-e2a24bd8d495",
+        "X-Runtime": "0.036595",
+        "Expires": "0",
+        "Content-Length": "4111"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/products/nice-shirt?sku=SKU2",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"product\": {\n    \"id\": \"E1FCE89668\",\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\": \"In Stock\",\n    \"variants\": [\n      {\n        \"id\": \"5d5dbdc7d4322a4b69d795ac\",\n        \"name\": \"SKU1\",\n        \"sku\": \"SKU1\",\n        \"details\": {\n          \"color\": [\n            \"Blue\"\n          ]\n        }\n      },\n      {\n        \"id\": \"5d5dbdc7d4322a4b69d795ad\",\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\": 300.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"original_max_price\": {\n      \"cents\": 300.0,\n      \"currency_iso\": \"USD\"\n    },\n    \"images\": [\n      {\n        \"id\": \"5d5dbdc7d4322a4b69d795ae\",\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/5d5dbdc7d4322a4b69d795ae/small.jpg?c=0\"\n          },\n          {\n            \"type\": \"medium\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/medium.jpg?c=0\"\n          },\n          {\n            \"type\": \"small_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/small_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"medium_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/medium_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"large_thumb\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/large_thumb.jpg?c=0\"\n          },\n          {\n            \"type\": \"detail\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/detail.jpg?c=0\"\n          },\n          {\n            \"type\": \"zoom\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/zoom.jpg?c=0\"\n          },\n          {\n            \"type\": \"super_zoom\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/super_zoom.jpg?c=0\"\n          },\n          {\n            \"type\": \"favicon\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/favicon.jpg?c=0\"\n          },\n          {\n            \"type\": \"favicon_ico\",\n            \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5dbdc7d4322a4b69d795ae/favicon_ico.jpg?c=0\"\n          }\n        ]\n      }\n    ]\n  },\n  \"recommendations\": [\n    {\n      \"id\": \"546223A2B9\",\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\": \"5d5dbdc7d4322a4b69d795b0\",\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\": \"5d5dbdc7d4322a4b69d795b1\",\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/5d5dbdc7d4322a4b69d795b1/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5dbdc7d4322a4b69d795b1/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?sku=SKU2\" -X GET "
+    }
+  ],
+  "resource": "Products",
+  "description": "Showing a product with a specific SKU selected",
+  "route": "/api/storefront/products/:slug",
+  "explanation": "            This demonstrates how to get product details for a specific SKU.\n            This will result in pricing, inventory, and images to match the\n            storefront logic for that SKU.\n",
+  "http_method": "GET"
+}