workarea-api 4.4.7 → 4.5.5

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

@@ -8,7 +8,7 @@
   "requests": [
     {
       "request_headers": {
-        "Authorization": "Token token=\"9B4z2rzwUdRdP8GVBseDg2CQ\""
+        "Authorization": "Token token=\"SiesVW3r1J7oceNMoWtK7g4i\""
       },
       "request_query_parameters": {
       },
@@ -24,11 +24,12 @@
         "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/\"74391c9491520c0e402264bff4208c55\"",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:56:55 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "acc4a14f-1545-4d50-8165-2511cb79de7e",
-        "X-Runtime": "0.009153",
+        "X-Request-Id": "81ac4411-e51c-44b4-bfa7-3c8f4e2648d6",
+        "X-Runtime": "0.008921",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "571"
       },
@@ -38,14 +39,14 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"user_id\": \"5d5ec9ced4322a04dfbf6324\",\n  \"credit_cards\": [\n    {\n      \"id\": \"5d5ec9ced4322a04dfbf6328\",\n      \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6328\",\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    },\n    {\n      \"id\": \"5d5ec9ced4322a04dfbf6329\",\n      \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6329\",\n      \"default\": false,\n      \"issuer\": \"Visa\",\n      \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n      \"month\": 7,\n      \"year\": 2024,\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\"\n    }\n  ]\n}",
+      "response_body": "{\n  \"user_id\": \"5f3d2fa70218236e938cf754\",\n  \"credit_cards\": [\n    {\n      \"id\": \"5f3d2fa70218236e938cf759\",\n      \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5f3d2fa70218236e938cf759\",\n      \"default\": false,\n      \"issuer\": \"Visa\",\n      \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n      \"month\": 3,\n      \"year\": 2024,\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\"\n    },\n    {\n      \"id\": \"5f3d2fa70218236e938cf75a\",\n      \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5f3d2fa70218236e938cf75a\",\n      \"default\": false,\n      \"issuer\": \"Visa\",\n      \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n      \"month\": 7,\n      \"year\": 2025,\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\"\n    }\n  ]\n}",
       "response_content_type": "application/json",
-      "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"9B4z2rzwUdRdP8GVBseDg2CQ\\\"\""
+      "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"SiesVW3r1J7oceNMoWtK7g4i\\\"\""
     }
   ],
   "resource": "Saved Credit Cards",
   "description": "Listing the user's saved credit cards",
   "route": "/api/storefront/saved_credit_cards",
-  "http_method": "GET",
-  "explanation": "            List a customer's saved addresses. Useful for account management.\n            These addresses will be available to the customer in an\n            authenticated checkout.\n"
+  "explanation": "<p>List a customer&#39;s saved addresses. Useful for account management.<br>\nThese addresses will be available to the customer in an<br>\nauthenticated checkout.</p>\n",
+  "http_method": "GET"
 }

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

@@ -8,7 +8,7 @@
   "requests": [
     {
       "request_headers": {
-        "Authorization": "Token token=\"3gstq5QbUorVGaQ68esor1nD\""
+        "Authorization": "Token token=\"J5XmsTsXJncTvNCy6gWfUMUf\""
       },
       "request_query_parameters": {
       },
@@ -24,23 +24,24 @@
         "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/\"52292c68f1c4a0050eafa702eb3dd1d6\"",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:56:57 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "291bedc7-9905-4898-98e8-f70e8107d308",
-        "X-Runtime": "0.006976",
+        "X-Request-Id": "a7bc7c76-e534-49b0-8937-fb04bf66bd52",
+        "X-Runtime": "0.008410",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "294"
       },
       "request_method": "GET",
-      "request_path": "/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf6336",
+      "request_path": "/api/storefront/saved_credit_cards/5f3d2fa90218236e938cf768",
       "request_body": null,
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"user_id\": \"5d5ec9d0d4322a04dfbf6332\",\n  \"id\": \"5d5ec9d0d4322a04dfbf6336\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf6336\",\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_body": "{\n  \"user_id\": \"5f3d2fa90218236e938cf763\",\n  \"id\": \"5f3d2fa90218236e938cf768\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5f3d2fa90218236e938cf768\",\n  \"default\": false,\n  \"issuer\": \"Visa\",\n  \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n  \"month\": 3,\n  \"year\": 2024,\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/5d5ec9d0d4322a04dfbf6336\" -X GET \\\n\t-H \"Authorization: Token token=\\\"3gstq5QbUorVGaQ68esor1nD\\\"\""
+      "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5f3d2fa90218236e938cf768\" -X GET \\\n\t-H \"Authorization: Token token=\\\"J5XmsTsXJncTvNCy6gWfUMUf\\\"\""
     }
   ],
   "resource": "Saved Credit Cards",

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

@@ -9,7 +9,7 @@
     {
       "request_headers": {
         "Content-Type": "application/json",
-        "Authorization": "Token token=\"znRJwJSwnksRNf3hhfbHoWHa\""
+        "Authorization": "Token token=\"w2cHWDEfThvRioKJbiXMRLzZ\""
       },
       "request_query_parameters": {
       },
@@ -25,23 +25,24 @@
         "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/\"0038cc54b80e1fb6e7943b4bf37a94b8\"",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:56:58 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "1c143b11-ba5e-4272-aeef-4dadbbb0d752",
-        "X-Runtime": "0.017047",
+        "X-Request-Id": "39ee0fe9-c59a-49ff-bf66-194e5370f72f",
+        "X-Runtime": "0.016105",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "294"
       },
       "request_method": "PATCH",
-      "request_path": "/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322",
-      "request_body": "{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}",
+      "request_path": "/api/storefront/saved_credit_cards/5f3d2faa0218236e938cf76f",
+      "request_body": "{\"month\":\"7\",\"year\":\"2025\",\"cvv\":\"123\"}",
       "request_content_type": "application/json",
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"user_id\": \"5d5ec9ced4322a04dfbf631e\",\n  \"id\": \"5d5ec9ced4322a04dfbf6322\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322\",\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_body": "{\n  \"user_id\": \"5f3d2faa0218236e938cf76a\",\n  \"id\": \"5f3d2faa0218236e938cf76f\",\n  \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5f3d2faa0218236e938cf76f\",\n  \"default\": false,\n  \"issuer\": \"Visa\",\n  \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n  \"month\": 7,\n  \"year\": 2025,\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/5d5ec9ced4322a04dfbf6322\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"znRJwJSwnksRNf3hhfbHoWHa\\\"\""
+      "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5f3d2faa0218236e938cf76f\" -d '{\"month\":\"7\",\"year\":\"2025\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"w2cHWDEfThvRioKJbiXMRLzZ\\\"\""
     }
   ],
   "resource": "Saved Credit Cards",

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

@@ -19,19 +19,20 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Thu, 22 Aug 2019 17:00:24 GMT",
+        "Date": "Wed, 19 Aug 2020 13:57:17 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",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:17 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "ETag": "W/\"5cadef3e3fd1835a35070954308d0d32\"",
-        "X-Request-Id": "02b9b8a2-403b-4f94-83ea-5cebacd48cee",
-        "X-Runtime": "0.055426",
+        "X-Request-Id": "37826b78-c9b3-4384-a76b-e48eb1abc0af",
+        "X-Runtime": "0.010973",
+        "X-Workarea-Segments": "",
         "Expires": "0",
-        "Content-Length": "631"
+        "Content-Length": "16"
       },
       "request_method": "GET",
       "request_path": "/api/storefront/searches?q=red",
@@ -39,7 +40,7 @@
       "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=1566493120\",\n      \"url\": \"/api/storefront/products/red-product\",\n      \"analytics\": {\n        \"id\": \"8CB6DE3B62\",\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_body": "{\n  \"results\": null\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET "
     }
@@ -47,6 +48,6 @@
   "resource": "Searches",
   "description": "Showing search autocomplete suggestions",
   "route": "/api/storefront/searches",
-  "http_method": "GET",
-  "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"
+  "explanation": "<p>This list will be based on popular search terms and matching<br>\nproducts, categories, etc. Useful for showing a autocomplete<br>\ndrop-down as a customer types in a search bar.</p>\n",
+  "http_method": "GET"
 }

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

@@ -36,17 +36,18 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Thu, 22 Aug 2019 17:00:25 GMT",
+        "Date": "Wed, 19 Aug 2020 13:57: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",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:19 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "ETag": "W/\"cbbd627ecb28bfddcc28d6597fc07c2e\"",
-        "X-Request-Id": "bf062e15-7dc7-4d52-8a59-09ae63b7ce6f",
-        "X-Runtime": "0.119178",
+        "X-Request-Id": "24da8e0e-3c33-4f3d-8888-d5e089d99fe3",
+        "X-Runtime": "0.083213",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "6349"
       },
@@ -56,7 +57,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"query_string\": \"large\",\n  \"message\": null,\n  \"redirect\": null,\n  \"sorts\": [\n    [\n      \"Relevance\",\n      \"relevance\"\n    ],\n    [\n      \"Top Sellers\",\n      \"top_sellers\"\n    ],\n    [\n      \"Most Popular\",\n      \"popularity\"\n    ],\n    [\n      \"Newest\",\n      \"newest\"\n    ],\n    [\n      \"Price, Low to High\",\n      \"price_asc\"\n    ],\n    [\n      \"Price, High to Low\",\n      \"price_desc\"\n    ]\n  ],\n  \"sort\": {\n    \"name\": \"Price, High to Low\",\n    \"slug\": \"price_desc\",\n    \"field\": \"sorts.price\",\n    \"direction\": \"desc\"\n  },\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5eca28d4322a04dfbf69d7\",\n      \"type\": \"text\",\n      \"area\": \"results\",\n      \"data\": {\n        \"text\": \"Huzzah! Your search results are below!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d7\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d7&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Huzzah! Your search results are below!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5eca28d4322a04dfbf69d8\",\n      \"type\": \"text\",\n      \"area\": \"no_results\",\n      \"data\": {\n        \"text\": \"Sorry, we can't find what you searched for!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d8\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d8&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Sorry, we can&#39;t find what you searched for!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n    }\n  ],\n  \"first_page\": true,\n  \"second_page\": false,\n  \"last_page\": true,\n  \"page\": 1,\n  \"next_page\": null,\n  \"prev_page\": null,\n  \"per_page\": 20,\n  \"total_results\": 2,\n  \"total_pages\": 1,\n  \"facets\": [\n\n  ],\n  \"products\": [\n    {\n      \"id\": \"PRODUCT1\",\n      \"name\": \"Pretty Nice Shirt\",\n      \"description\": null,\n      \"slug\": \"pretty-nice-shirt\",\n      \"browser_title\": \"Pretty Nice Shirt\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Blue\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69da\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69db\",\n          \"option\": \"Blue\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    },\n    {\n      \"id\": \"PRODUCT2\",\n      \"name\": \"Great Pants\",\n      \"description\": null,\n      \"slug\": \"great-pants\",\n      \"browser_title\": \"Great Pants\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"Color\": \"Brown\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69dd\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 3500.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 5000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5eca28d4322a04dfbf69de\",\n          \"option\": \"Brown\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}",
+      "response_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\": \"5f3d2fbe0218236e938cf864\",\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_5f3d2fbe0218236e938cf864\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fbe0218236e938cf864&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\": \"5f3d2fbe0218236e938cf865\",\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_5f3d2fbe0218236e938cf865\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fbe0218236e938cf865&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\": \"5f3d2fbe0218236e938cf867\",\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\": \"5f3d2fbe0218236e938cf868\",\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/5f3d2fbe0218236e938cf868/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5f3d2fbe0218236e938cf868/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\": \"5f3d2fbf0218236e938cf877\",\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\": \"5f3d2fbf0218236e938cf878\",\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/5f3d2fbf0218236e938cf878/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/great-pants/Brown/5f3d2fbf0218236e938cf878/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 "
     }
@@ -64,6 +65,6 @@
   "resource": "Searches",
   "description": "Showing search results",
   "route": "/api/storefront/search",
-  "http_method": "GET",
-  "explanation": "            This endpoint returns everything you'll need to show search results\n            to customers. This includes products, filters, and any content\n            that's been setup by an administrator.\n"
+  "explanation": "<p>This endpoint returns everything you&#39;ll need to show search results<br>\nto customers. This includes products, filters, and any content<br>\nthat&#39;s been setup by an administrator.</p>\n",
+  "http_method": "GET"
 }

data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json

@@ -0,0 +1,93 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "sessions": "1"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 19 Aug 2020 13:57:48 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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:48 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "af0cec93-7516-4003-9771-c2cad639fe12",
+        "X-Runtime": "0.008463",
+        "X-Workarea-Segments": "first_time_visitor",
+        "Expires": "0",
+        "Content-Length": "1014"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/home_page?sessions=1",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5f3d2fdc0218236e938cfa52\",\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\": \"5f3d2fdc0218236e938cfa53\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Hello visitor!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2fdc0218236e938cfa53\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fdc0218236e938cfa53&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Hello visitor!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Hello visitor!</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?sessions=1\" -X GET "
+    },
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "sessions": "2"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 19 Aug 2020 13:57:48 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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:48 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "bfd599b2-0acf-4946-940c-9e5e20909378",
+        "X-Runtime": "0.008031",
+        "X-Workarea-Segments": "returning_visitor",
+        "Expires": "0",
+        "Content-Length": "1011"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/home_page?sessions=2",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5f3d2fdc0218236e938cfa52\",\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\": \"5f3d2fdc0218236e938cfa54\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Welcome back!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2fdc0218236e938cfa54\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fdc0218236e938cfa54&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;text&quot;:&quot;Welcome back!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Welcome back!</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?sessions=2\" -X GET "
+    }
+  ],
+  "resource": "Segmentation",
+  "description": "Specifying session count for segmentation",
+  "route": "/api/storefront/system_content/home_page",
+  "explanation": "<p>Workarea supports segmenting users by number of sessions, e.g.<br>\nfirst-time vs returning visitors. To support this in the storefront<br>\nAPI, the client will be responsible for managing this since the API<br>\nis stateless (doesn&#39;t have cookies/session).</p>\n\n<p>To get session-based segments functioning, you need to pass a<br>\n<code>sessions</code> parameter in each request. Workarea will use that as<br>\nthe number of sessions for determing the segments for the response.<br>\nThis works for all requests across the storefront API.</p>\n\n<p>This example shows getting a home page with segmented content based<br>\non the number of sessions.</p>\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json

@@ -0,0 +1,93 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "session_id": "session_1"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 19 Aug 2020 13:57:49 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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:49 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "bfa70412-ccb1-4278-82cc-f05c9b6792b3",
+        "X-Runtime": "0.008106",
+        "X-Workarea-Segments": "first_time_customer",
+        "Expires": "0",
+        "Content-Length": "1038"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/home_page?session_id=session_1",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5f3d2fdd0218236e938cfa5a\",\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\": \"5f3d2fdd0218236e938cfa5b\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Thanks for your order!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2fdd0218236e938cfa5b\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fdd0218236e938cfa5b&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Thanks for your order!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Thanks for your order!</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?session_id=session_1\" -X GET "
+    },
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "session_id": "session_2"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Date": "Wed, 19 Aug 2020 13:57:49 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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:57:49 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "08056fc4-96a5-4ddb-906b-84c25f020882",
+        "X-Runtime": "0.008415",
+        "X-Workarea-Segments": "returning_customer",
+        "Expires": "0",
+        "Content-Length": "1059"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/system_content/home_page?session_id=session_2",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5f3d2fdd0218236e938cfa5a\",\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\": \"5f3d2fdd0218236e938cfa5c\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Welcome back repeat customer!\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 1,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2fdd0218236e938cfa5c\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2fdd0218236e938cfa5c&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:1,&quot;data&quot;:{&quot;text&quot;:&quot;Welcome back repeat customer!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Welcome back repeat customer!</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?session_id=session_2\" -X GET "
+    }
+  ],
+  "resource": "Segmentation",
+  "description": "Using session IDs for segmenting non-authenticated users",
+  "route": "/api/storefront/system_content/home_page",
+  "explanation": "<p>Workarea supports segmenting users by number of orders, revenue, etc.<br>\nFor this functionality to work for users without accounts, you&#39;ll<br>\nneed to maintain and pass a <code>session_id</code> consistently throughout calls<br>\nto the API.</p>\n\n<p>An instance of <code>Metrics::User</code> will be found or created for that<br>\n<code>session_id</code>, and data about the user will be tracked there.</p>\n\n<p>Assuming use of the <code>session_id</code> consistently through checkout, this<br>\nexample shows getting home page content for two different anonymous<br>\nusers and getting segmented content back.</p>\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/system_content/showing_system_content.json

@@ -18,17 +18,18 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Thu, 22 Aug 2019 16:58:57 GMT",
+        "Date": "Wed, 19 Aug 2020 13:54:09 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",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:54:09 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "ETag": "W/\"80e99c9a4189f1075fe29a655c4f5d4c\"",
-        "X-Request-Id": "8c0d811f-3856-4390-9274-617f125c362d",
-        "X-Runtime": "0.010637",
+        "X-Request-Id": "c7549707-035f-428f-a882-b6f0266fbecf",
+        "X-Runtime": "0.013768",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "1981"
       },
@@ -38,7 +39,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"id\": \"5d5ec9d1d4322a04dfbf633e\",\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\": \"5d5ec9d1d4322a04dfbf633f\",\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_5d5ec9d1d4322a04dfbf633f\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5ec9d1d4322a04dfbf633f&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\": \"5d5ec9d1d4322a04dfbf6340\",\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_5d5ec9d1d4322a04dfbf6340\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5ec9d1d4322a04dfbf6340&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_body": "{\n  \"id\": \"5f3d2f010218236e938cebfe\",\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\": \"5f3d2f010218236e938cebff\",\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_5f3d2f010218236e938cebff\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f010218236e938cebff&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\": \"5f3d2f010218236e938cec00\",\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_5f3d2f010218236e938cec00\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f010218236e938cec00&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 "
     }
@@ -46,6 +47,6 @@
   "resource": "System Content",
   "description": "Showing system content",
   "route": "/api/storefront/system_content/:name",
-  "http_method": "GET",
-  "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"
+  "explanation": "<p>System content is content for an area of site not configured by the<br>\nCMS. Examples would be content for the cart page, content for<br>\ncheckout, site layout content, etc. The home page is also an example<br>\nof system content and shown in a separate example.</p>\n",
+  "http_method": "GET"
 }

data/doc/api/storefront/system_content/showing_the_home_page.json

@@ -18,17 +18,18 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Thu, 22 Aug 2019 16:58:57 GMT",
+        "Date": "Wed, 19 Aug 2020 13:54:10 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",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:54:10 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "ETag": "W/\"0cb889e813b55f6fa624cf1cacf1b257\"",
-        "X-Request-Id": "cf0fb6d8-3f87-4ad8-8961-79a3dc6c1cd1",
-        "X-Runtime": "0.009229",
+        "X-Request-Id": "3ad54fe0-81b2-4828-89f6-e4514c6621fa",
+        "X-Runtime": "0.009666",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "1830"
       },
@@ -38,7 +39,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"id\": \"5d5ec9d1d4322a04dfbf6342\",\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\": \"5d5ec9d1d4322a04dfbf6343\",\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_5d5ec9d1d4322a04dfbf6343\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5ec9d1d4322a04dfbf6343&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\": \"5d5ec9d1d4322a04dfbf6344\",\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_5d5ec9d1d4322a04dfbf6344\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5ec9d1d4322a04dfbf6344&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_body": "{\n  \"id\": \"5f3d2f020218236e938cec03\",\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\": \"5f3d2f020218236e938cec04\",\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_5f3d2f020218236e938cec04\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f020218236e938cec04&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\": \"5f3d2f020218236e938cec05\",\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_5f3d2f020218236e938cec05\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5f3d2f020218236e938cec05&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 "
     }
@@ -46,6 +47,6 @@
   "resource": "System Content",
   "description": "Showing the home page",
   "route": "/api/storefront/system_content/home_page",
-  "http_method": "GET",
-  "explanation": "            This endpoint returns everything you'll need to render the home\n            page.\n"
+  "explanation": "<p>This endpoint returns everything you&#39;ll need to render the home<br>\npage.</p>\n",
+  "http_method": "GET"
 }