workarea-api 4.4.6

data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Authorization": "Token token=\"8iKJ3VEmcfyhdH7Ppy7BPBiz\""
+      },
+      "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/\"caea022584c113878675ef307855910a\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "c7577fce-775e-4e71-9ab1-3b0fd79d1127",
+        "X-Runtime": "0.007011",
+        "Expires": "0",
+        "Content-Length": "294"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"user_id\": \"5d5dbd6dd4322a4b69d790a6\",\n  \"id\": \"5d5dbd6dd4322a4b69d790aa\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa\",\n  \"default\": false,\n  \"issuer\": \"Visa\",\n  \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n  \"month\": 3,\n  \"year\": 2023,\n  \"first_name\": \"Susan\",\n  \"last_name\": \"Baker\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5d5dbd6dd4322a4b69d790aa\" -X GET \\\n\t-H \"Authorization: Token token=\\\"8iKJ3VEmcfyhdH7Ppy7BPBiz\\\"\""
+    }
+  ],
+  "resource": "Saved Credit Cards",
+  "description": "Showing a saved credit card",
+  "route": "/api/storefront/saved_credit_cards/:id",
+  "http_method": "GET"
+}

data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json",
+        "Authorization": "Token token=\"UgTGvTKKVmhPThYBB3S448td\""
+      },
+      "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/\"5cc83d0b5d528dca0dbb2f407d5da9f2\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "7dad7a77-4268-4c93-abbe-dc44f7d03cdc",
+        "X-Runtime": "0.011068",
+        "Expires": "0",
+        "Content-Length": "294"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/storefront/saved_credit_cards/5d5dbd6ed4322a4b69d790b0",
+      "request_body": "{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"user_id\": \"5d5dbd6dd4322a4b69d790ac\",\n  \"id\": \"5d5dbd6ed4322a4b69d790b0\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5dbd6ed4322a4b69d790b0\",\n  \"default\": false,\n  \"issuer\": \"Visa\",\n  \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n  \"month\": 7,\n  \"year\": 2024,\n  \"first_name\": \"Susan\",\n  \"last_name\": \"Baker\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5d5dbd6ed4322a4b69d790b0\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"UgTGvTKKVmhPThYBB3S448td\\\"\""
+    }
+  ],
+  "resource": "Saved Credit Cards",
+  "description": "Updating a saved credit card",
+  "route": "/api/storefront/saved_credit_cards/:id",
+  "http_method": "PATCH"
+}

data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json

@@ -0,0 +1,52 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "q": "red"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 21 Aug 2019 21:53:55 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/\"1f2a9b3dde9fdf74b25d5464ccbe3cfd\"",
+        "X-Request-Id": "9f1210b2-50c7-49bd-9be3-8742c78102f9",
+        "X-Runtime": "0.032883",
+        "Expires": "0",
+        "Content-Length": "631"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/searches?q=red",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"results\": [\n    {\n      \"value\": \"red\",\n      \"type\": \"Searches\",\n      \"image\": null,\n      \"url\": \"/api/storefront/search?q=red\",\n      \"analytics\": null\n    },\n    {\n      \"value\": \"Red Product\",\n      \"type\": \"Products\",\n      \"image\": \"/product_images/placeholder/small_thumb.jpg?c=1566424156\",\n      \"url\": \"/api/storefront/products/red-product\",\n      \"analytics\": {\n        \"id\": \"2A5AE5CA93\",\n        \"name\": \"Red Product\",\n        \"sku\": null,\n        \"sale\": false,\n        \"price\": 5.0,\n        \"category\": null\n      }\n    },\n    {\n      \"value\": \"Page about Red Products\",\n      \"type\": \"Pages\",\n      \"image\": null,\n      \"url\": \"/api/storefront/pages/page-about-red-products\",\n      \"analytics\": null\n    },\n    {\n      \"value\": \"Red Category\",\n      \"type\": \"Categories\",\n      \"image\": null,\n      \"url\": \"/api/storefront/categories/red-category\",\n      \"analytics\": null\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET "
+    }
+  ],
+  "resource": "Searches",
+  "description": "Showing search autocomplete suggestions",
+  "route": "/api/storefront/searches",
+  "explanation": "            This list will be based on popular search terms and matching\n            products, categories, etc. Useful for showing a autocomplete\n            drop-down as a customer types in a search bar.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/searches/showing_search_results.json

@@ -0,0 +1,69 @@
+{
+  "parameters": [
+    {
+      "name": "q",
+      "description": "The search query string entered by the customer"
+    },
+    {
+      "name": "sort",
+      "description": "Sort by"
+    },
+    {
+      "name": "page",
+      "description": "Page number"
+    },
+    {
+      "name": ":facet_name",
+      "description": "Each facet setup on search settings will have a corresponding parameter"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "page": "1",
+        "q": "large",
+        "sort": "price_desc"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 21 Aug 2019 21:53:55 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/\"f21cf335b55881d2f9ab3781be53f057\"",
+        "X-Request-Id": "9ae89914-b8e3-4190-bcf1-49fdd0daf67f",
+        "X-Runtime": "0.050303",
+        "Expires": "0",
+        "Content-Length": "6349"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/search?page=1&q=large&sort=price_desc",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"query_string\": \"large\",\n  \"message\": null,\n  \"redirect\": null,\n  \"sorts\": [\n    [\n      \"Relevance\",\n      \"relevance\"\n    ],\n    [\n      \"Top Sellers\",\n      \"top_sellers\"\n    ],\n    [\n      \"Most Popular\",\n      \"popularity\"\n    ],\n    [\n      \"Newest\",\n      \"newest\"\n    ],\n    [\n      \"Price, Low to High\",\n      \"price_asc\"\n    ],\n    [\n      \"Price, High to Low\",\n      \"price_desc\"\n    ]\n  ],\n  \"sort\": {\n    \"name\": \"Price, High to Low\",\n    \"slug\": \"price_desc\",\n    \"field\": \"sorts.price\",\n    \"direction\": \"desc\"\n  },\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbd73d4322a4b69d79109\",\n      \"type\": \"text\",\n      \"area\": \"results\",\n      \"data\": {\n        \"text\": \"Huzzah! Your search results are below!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd73d4322a4b69d79109\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd73d4322a4b69d79109&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Huzzah! Your search results are below!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbd73d4322a4b69d7910a\",\n      \"type\": \"text\",\n      \"area\": \"no_results\",\n      \"data\": {\n        \"text\": \"Sorry, we can't find what you searched for!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd73d4322a4b69d7910a\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd73d4322a4b69d7910a&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Sorry, we can&#39;t find what you searched for!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n    }\n  ],\n  \"first_page\": true,\n  \"second_page\": false,\n  \"last_page\": true,\n  \"page\": 1,\n  \"next_page\": null,\n  \"prev_page\": null,\n  \"per_page\": 20,\n  \"total_results\": 2,\n  \"total_pages\": 1,\n  \"facets\": [\n\n  ],\n  \"products\": [\n    {\n      \"id\": \"PRODUCT1\",\n      \"name\": \"Pretty Nice Shirt\",\n      \"description\": null,\n      \"slug\": \"pretty-nice-shirt\",\n      \"browser_title\": \"Pretty Nice Shirt\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Blue\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd73d4322a4b69d7910c\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5dbd73d4322a4b69d7910d\",\n          \"option\": \"Blue\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5dbd73d4322a4b69d7910d/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    },\n    {\n      \"id\": \"PRODUCT2\",\n      \"name\": \"Great Pants\",\n      \"description\": null,\n      \"slug\": \"great-pants\",\n      \"browser_title\": \"Great Pants\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Brown\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbd73d4322a4b69d7910f\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5dbd73d4322a4b69d79110\",\n          \"option\": \"Brown\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5dbd73d4322a4b69d79110/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/search?page=1&q=large&sort=price_desc\" -X GET "
+    }
+  ],
+  "resource": "Searches",
+  "description": "Showing search results",
+  "route": "/api/storefront/search",
+  "explanation": "            This endpoint returns everything you'll need to show search results\n            to customers. This includes products, filters, and any content\n            that's been setup by an administrator.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/system_content/showing_system_content.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:53:37 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/\"506a1e601b7a71c0ef35b136ede1a1ba\"",
+        "X-Request-Id": "f622c968-2803-4d26-ad41-66027462e959",
+        "X-Runtime": "0.008877",
+        "Expires": "0",
+        "Content-Length": "1981"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/layout",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbd60d4322a4b69d78fe6\",\n  \"name\": \"Layout\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Layout\",\n  \"browser_title\": \"Layout\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbd61d4322a4b69d78fe7\",\n      \"type\": \"text\",\n      \"area\": \"header_promo\",\n      \"data\": {\n        \"text\": \"Don't miss our sizzling summer deals!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd61d4322a4b69d78fe7\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd61d4322a4b69d78fe7&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Don&#39;t miss our sizzling summer deals!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Don't miss our sizzling summer deals!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbd61d4322a4b69d78fe8\",\n      \"type\": \"text\",\n      \"area\": \"footer_navigation\",\n      \"data\": {\n        \"text\": \"Be the first to received our exclusive discounts\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd61d4322a4b69d78fe8\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd61d4322a4b69d78fe8&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Be the first to received our exclusive discounts&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Be the first to received our exclusive discounts</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/system_content/layout\" -X GET "
+    }
+  ],
+  "resource": "System Content",
+  "description": "Showing system content",
+  "route": "/api/storefront/system_content/:name",
+  "explanation": "            System content is content for an area of site not configured by the\n            CMS. Examples would be content for the cart page, content for\n            checkout, site layout content, etc. The home page is also an example\n            of system content and shown in a separate example.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/system_content/showing_the_home_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:53:37 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/\"97baef4677fea2237d57e6c8138e9b77\"",
+        "X-Request-Id": "6155973d-720d-4986-b2f2-69abaee673c4",
+        "X-Runtime": "0.007540",
+        "Expires": "0",
+        "Content-Length": "1830"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/home_page",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbd61d4322a4b69d78fea\",\n  \"name\": \"Home Page\",\n  \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n  \"browser_title\": \"Home Page\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbd61d4322a4b69d78feb\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Summer is here!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd61d4322a4b69d78feb\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd61d4322a4b69d78feb&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Summer is here!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Summer is here!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbd61d4322a4b69d78fec\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Get 20% off all swimwear\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbd61d4322a4b69d78fec\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbd61d4322a4b69d78fec&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;text&quot;:&quot;Get 20% off all swimwear&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Get 20% off all swimwear</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page\" -X GET "
+    }
+  ],
+  "resource": "System Content",
+  "description": "Showing the home page",
+  "route": "/api/storefront/system_content/home_page",
+  "explanation": "            This endpoint returns everything you'll need to render the home\n            page.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/taxons/showing_a_taxon.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:46 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/\"4969afb2dc3014d92381339692b3c60e\"",
+        "X-Request-Id": "45b2ec42-6afd-40d6-9de9-6274b67e5eed",
+        "X-Runtime": "0.006233",
+        "Expires": "0",
+        "Content-Length": "534"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/taxons/5d5dbde2d4322a4b69d7990b",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"taxon\": {\n    \"id\": \"5d5dbde2d4322a4b69d7990b\",\n    \"url\": \"/api/storefront/taxons/5d5dbde2d4322a4b69d7990b\",\n    \"name\": \"Mens\",\n    \"depth\": 1,\n    \"navigable_url\": \"http://example.com/pages/mens\",\n    \"parent_id\": \"5d5dbde2d4322a4b69d7990c\",\n    \"parent_ids\": [\n      \"5d5dbde2d4322a4b69d7990c\"\n    ],\n    \"position\": 0\n  },\n  \"children\": [\n    {\n      \"id\": \"5d5dbde2d4322a4b69d7990d\",\n      \"url\": \"/api/storefront/taxons/5d5dbde2d4322a4b69d7990d\",\n      \"name\": \"Sale\",\n      \"depth\": 2,\n      \"navigable_url\": null,\n      \"parent_id\": \"5d5dbde2d4322a4b69d7990b\",\n      \"parent_ids\": [\n        \"5d5dbde2d4322a4b69d7990c\",\n        \"5d5dbde2d4322a4b69d7990b\"\n      ],\n      \"position\": 0\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5d5dbde2d4322a4b69d7990b\" -X GET "
+    }
+  ],
+  "resource": "Taxons",
+  "description": "Showing a taxon",
+  "route": "/api/storefront/taxons/:id",
+  "explanation": "            This endpoint will show details on a particular node (or taxon) of\n            the site taxonomy, along with its children.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/validation_errors/checkout_validation_errors.json

@@ -0,0 +1,51 @@
+{
+  "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; 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/\"2d03488689514d800da1625e3380ac62\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "158086ed-9e94-4b12-96b8-9a79250dc488",
+        "X-Runtime": "0.439855",
+        "Expires": "0",
+        "Content-Length": "3271"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/storefront/checkouts/BE24C76EC5",
+      "request_body": "{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"BE24C76EC5\",\n    \"url\": \"http://www.example.com/api/storefront/orders/BE24C76EC5\",\n    \"user_id\": null,\n    \"email\": \"susanb@\",\n    \"placed_at\": null,\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5d5dbd2dd4322a4b69d78de9\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\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\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": null,\n    \"tenders\": [\n\n    ]\n  },\n  \"checkout\": {\n    \"url\": \"http://www.example.com/api/storefront/checkouts/BE24C76EC5\",\n    \"started_at\": \"2019-08-21T21:52:45.826Z\",\n    \"shippable\": false,\n    \"complete\": false,\n    \"addresses\": {\n      \"complete\": false,\n      \"email\": \"susanb@\",\n      \"problems\": [\n        \"Email is invalid\"\n      ],\n      \"shipping_address\": {\n        \"id\": \"5d5dbd2ed4322a4b69d78df0\",\n        \"first_name\": \"\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"350 Fifth Avenue\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"First name can't be blank\"\n        ]\n      },\n      \"billing_address\": {\n        \"id\": \"5d5dbd2ed4322a4b69d78df1\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n          \"Street can't be blank\"\n        ]\n      }\n    },\n    \"shipping\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"shipping_service\": null,\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"shipping_options\": [\n\n      ]\n    },\n    \"payment\": {\n      \"complete\": false,\n      \"problems\": [\n        \"Address is invalid\"\n      ],\n      \"tenders\": [\n\n      ]\n    }\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/checkouts/BE24C76EC5\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Validation Errors",
+  "description": "Checkout validation errors",
+  "route": "/api/storefront/checkouts/:id",
+  "explanation": "            Due to the more complex nature of checkout updates and data,\n            checkout validation errors are returned inline with the resource\n            they are coming from as shown below. Note the response status can be\n            200 OK, due to some data being persisted properly.\n",
+  "http_method": "PATCH"
+}

data/doc/api/storefront/validation_errors/general_validation_errors.json

@@ -0,0 +1,45 @@
+{
+  "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; charset=utf-8",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "624a232f-2a82-415e-89b1-e9a474ad6da1",
+        "X-Runtime": "0.006536",
+        "Expires": "0",
+        "Content-Length": "59"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/account",
+      "request_body": "{\"email\":\"bob@\",\"password\":\"\"}",
+      "request_content_type": "application/json",
+      "response_status": 422,
+      "response_status_text": "Unprocessable Entity",
+      "response_body": "{\n  \"problems\": [\n    \"Password can't be blank\",\n    \"Email is invalid\"\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"bob@\",\"password\":\"\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Validation Errors",
+  "description": "General validation errors",
+  "route": "/api/storefront/account",
+  "explanation": "            This demonstrates API responses when invalid data is submitted.\n",
+  "http_method": "POST"
+}

data/lib/workarea/api/curl.rb

@@ -0,0 +1,86 @@
+module Workarea
+  module Api
+    # This class stolen from Rspec Api Documentation
+    class Curl < Struct.new(:method, :path, :data, :headers)
+      attr_accessor :host
+
+      def output(config_host, config_headers_to_filer = nil)
+        self.host = config_host
+        @config_headers_to_filer = Array(config_headers_to_filer)
+        send(method.downcase)
+      end
+
+      def post
+        "curl \"#{url}\" #{post_data} -X POST #{headers}"
+      end
+
+      def get
+        "curl -g \"#{url}#{get_data}\" -X GET #{headers}"
+      end
+
+      def head
+        "curl \"#{url}#{get_data}\" -X HEAD #{headers}"
+      end
+
+      def put
+        "curl \"#{url}\" #{post_data} -X PUT #{headers}"
+      end
+
+      def delete
+        "curl \"#{url}\" #{post_data} -X DELETE #{headers}"
+      end
+
+      def patch
+        "curl \"#{url}\" #{post_data} -X PATCH #{headers}"
+      end
+
+      def url
+        "#{host}#{path}"
+      end
+
+      def headers
+        filter_headers(super).map do |k, v|
+          if k =~ /authorization/i && v =~ /^Basic/
+            "\\\n\t-u #{format_auth_header(v)}"
+          else
+            "\\\n\t-H \"#{format_full_header(k, v)}\""
+          end
+        end.join(' ')
+      end
+
+      def get_data
+        "?#{data}" unless data.blank?
+      end
+
+      def post_data
+        escaped_data = data.to_s.gsub("'", '\\u0027')
+        "-d '#{escaped_data}'"
+      end
+
+      private
+
+      def format_auth_header(value)
+        ::Base64.decode64(value.split(' ', 2).last || '')
+      end
+
+      def format_header(header)
+        header.gsub(/^HTTP_/, '').titleize.split.join('-')
+      end
+
+      def format_full_header(header, value)
+        formatted_value = value ? value.gsub(/"/, '\\"') : ''
+        "#{format_header(header)}: #{formatted_value}"
+      end
+
+      def filter_headers(headers)
+        if !@config_headers_to_filer.empty?
+          headers.reject do |header|
+            @config_headers_to_filer.map(&:downcase).include?(format_header(header).downcase)
+          end
+        else
+          headers
+        end
+      end
+    end
+  end
+end