workarea-api 4.4.7 → 4.5.0

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, 27 Nov 2019 00:51: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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:51:37 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "78e758bb-111a-45e9-b45c-38b616e0c18b",
+        "X-Runtime": "0.006550",
+        "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\": \"5dddc8991241596aa5204b57\",\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\": \"5dddc8991241596aa5204b58\",\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_5dddc8991241596aa5204b58\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8991241596aa5204b58&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, 27 Nov 2019 00:51: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-Workarea-Segmented-Content": "true",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:51:37 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "30666cef-8a67-4268-a8cf-eb13f27a4bec",
+        "X-Runtime": "0.006299",
+        "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\": \"5dddc8991241596aa5204b57\",\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\": \"5dddc8991241596aa5204b59\",\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_5dddc8991241596aa5204b59\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8991241596aa5204b59&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, 27 Nov 2019 00:51:36 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, 27 Nov 2019 00:51:36 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "f4a84544-444b-49ed-b271-bca835333e42",
+        "X-Runtime": "0.006377",
+        "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\": \"5dddc8971241596aa5204b4f\",\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\": \"5dddc8981241596aa5204b50\",\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_5dddc8981241596aa5204b50\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8981241596aa5204b50&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, 27 Nov 2019 00:51:36 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, 27 Nov 2019 00:51:36 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "11d049a0-74f8-48c0-b300-b71ff108f751",
+        "X-Runtime": "0.006377",
+        "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\": \"5dddc8971241596aa5204b4f\",\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\": \"5dddc8981241596aa5204b51\",\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_5dddc8981241596aa5204b51\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8981241596aa5204b51&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, 27 Nov 2019 00:52: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-Requested-With": "",
-        "Vary": "X-Requested-With, X-Flash-Messages",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:52:48 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": "f3d9d3a1-842e-422e-b717-5c29b14889e8",
+        "X-Runtime": "0.008132",
+        "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\": \"5dddc8e01241596aa5204ce3\",\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\": \"5dddc8e01241596aa5204ce4\",\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_5dddc8e01241596aa5204ce4\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8e01241596aa5204ce4&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\": \"5dddc8e01241596aa5204ce5\",\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_5dddc8e01241596aa5204ce5\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8e01241596aa5204ce5&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, 27 Nov 2019 00:52: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-Requested-With": "",
-        "Vary": "X-Requested-With, X-Flash-Messages",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:52:48 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": "f924549d-136a-4b93-b820-e6149f37bfc2",
+        "X-Runtime": "0.008772",
+        "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\": \"5dddc8df1241596aa5204cde\",\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\": \"5dddc8df1241596aa5204cdf\",\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_5dddc8df1241596aa5204cdf\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8df1241596aa5204cdf&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\": \"5dddc8df1241596aa5204ce0\",\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_5dddc8df1241596aa5204ce0\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc8df1241596aa5204ce0&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"
 }

data/doc/api/storefront/taxons/showing_a_taxon.json

@@ -18,34 +18,35 @@
         "X-Download-Options": "noopen",
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
-        "Date": "Thu, 22 Aug 2019 17:02:10 GMT",
+        "Date": "Wed, 27 Nov 2019 00:52: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",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:52:46 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "ETag": "W/\"68a6afbf1d116813312ea2a8cb13646d\"",
-        "X-Request-Id": "335b1d1a-a625-4d60-b1d5-774f0d1d5b7b",
-        "X-Runtime": "0.009750",
+        "X-Request-Id": "5ceec41f-08e9-4933-a1f9-788147b25053",
+        "X-Runtime": "0.007104",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "534"
       },
       "request_method": "GET",
-      "request_path": "/api/storefront/taxons/5d5eca92d4322a04dfbf6f44",
+      "request_path": "/api/storefront/taxons/5dddc8dd1241596aa5204cd9",
       "request_body": null,
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"taxon\": {\n    \"id\": \"5d5eca92d4322a04dfbf6f44\",\n    \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\",\n    \"name\": \"Mens\",\n    \"depth\": 1,\n    \"navigable_url\": \"http://example.com/pages/mens\",\n    \"parent_id\": \"5d5eca92d4322a04dfbf6f45\",\n    \"parent_ids\": [\n      \"5d5eca92d4322a04dfbf6f45\"\n    ],\n    \"position\": 0\n  },\n  \"children\": [\n    {\n      \"id\": \"5d5eca92d4322a04dfbf6f46\",\n      \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f46\",\n      \"name\": \"Sale\",\n      \"depth\": 2,\n      \"navigable_url\": null,\n      \"parent_id\": \"5d5eca92d4322a04dfbf6f44\",\n      \"parent_ids\": [\n        \"5d5eca92d4322a04dfbf6f45\",\n        \"5d5eca92d4322a04dfbf6f44\"\n      ],\n      \"position\": 0\n    }\n  ]\n}",
+      "response_body": "{\n  \"taxon\": {\n    \"id\": \"5dddc8dd1241596aa5204cd9\",\n    \"url\": \"/api/storefront/taxons/5dddc8dd1241596aa5204cd9\",\n    \"name\": \"Mens\",\n    \"depth\": 1,\n    \"navigable_url\": \"http://example.com/pages/mens\",\n    \"parent_id\": \"5dddc8dd1241596aa5204cda\",\n    \"parent_ids\": [\n      \"5dddc8dd1241596aa5204cda\"\n    ],\n    \"position\": 0\n  },\n  \"children\": [\n    {\n      \"id\": \"5dddc8de1241596aa5204cdb\",\n      \"url\": \"/api/storefront/taxons/5dddc8de1241596aa5204cdb\",\n      \"name\": \"Sale\",\n      \"depth\": 2,\n      \"navigable_url\": null,\n      \"parent_id\": \"5dddc8dd1241596aa5204cd9\",\n      \"parent_ids\": [\n        \"5dddc8dd1241596aa5204cda\",\n        \"5dddc8dd1241596aa5204cd9\"\n      ],\n      \"position\": 0\n    }\n  ]\n}",
       "response_content_type": "application/json",
-      "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\" -X GET "
+      "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5dddc8dd1241596aa5204cd9\" -X GET "
     }
   ],
   "resource": "Taxons",
   "description": "Showing a taxon",
   "route": "/api/storefront/taxons/:id",
-  "http_method": "GET",
-  "explanation": "            This endpoint will show details on a particular node (or taxon) of\n            the site taxonomy, along with its children.\n"
+  "explanation": "<p>This endpoint will show details on a particular node (or taxon) of<br>\nthe site taxonomy, along with its children.</p>\n",
+  "http_method": "GET"
 }

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

@@ -24,28 +24,29 @@
         "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/\"1c738b755ccc1b901b10d9fd9e7b24de\"",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:51:33 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "df8c92ae-b1f8-48d9-9497-d49dd15b9f03",
-        "X-Runtime": "0.491660",
+        "X-Request-Id": "1f3d729a-7f8d-47cc-a170-f6dbf096a0bf",
+        "X-Runtime": "0.447104",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "3271"
       },
       "request_method": "PATCH",
-      "request_path": "/api/storefront/checkouts/B90394D2D5",
+      "request_path": "/api/storefront/checkouts/65CBE75A6F",
       "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\": \"B90394D2D5\",\n    \"url\": \"http://www.example.com/api/storefront/orders/B90394D2D5\",\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\": \"5d5eca6ed4322a04dfbf6d7a\",\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=1566493120\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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/B90394D2D5\",\n    \"started_at\": \"2019-08-22T17:01:34.556Z\",\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\": \"5d5eca6fd4322a04dfbf6d81\",\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\": \"5d5eca6fd4322a04dfbf6d82\",\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_body": "{\n  \"order\": {\n    \"id\": \"65CBE75A6F\",\n    \"url\": \"http://www.example.com/api/storefront/orders/65CBE75A6F\",\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\": \"5dddc8951241596aa5204b41\",\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=1574815751\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\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/65CBE75A6F\",\n    \"started_at\": \"2019-11-27T00:51:33.506Z\",\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\": \"5dddc8951241596aa5204b48\",\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\": \"5dddc8951241596aa5204b49\",\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/B90394D2D5\" -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\""
+      "curl": "curl \"https://www.example.com/api/storefront/checkouts/65CBE75A6F\" -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",
-  "http_method": "PATCH",
-  "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"
+  "explanation": "<p>Due to the more complex nature of checkout updates and data,<br>\ncheckout validation errors are returned inline with the resource<br>\nthey are coming from as shown below. Note the response status can be<br>\n200 OK, due to some data being persisted properly.</p>\n",
+  "http_method": "PATCH"
 }

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

@@ -21,8 +21,9 @@
         "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": "9cf31710-98e2-4a0e-a0e9-8c98d3044773",
-        "X-Runtime": "0.008732",
+        "X-Request-Id": "ba73618c-7816-4930-b249-c07a150c0e9c",
+        "X-Runtime": "0.007253",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "59"
       },
@@ -40,6 +41,6 @@
   "resource": "Validation Errors",
   "description": "General validation errors",
   "route": "/api/storefront/account",
-  "http_method": "POST",
-  "explanation": "            This demonstrates API responses when invalid data is submitted.\n"
+  "explanation": "<p>This demonstrates API responses when invalid data is submitted.</p>\n",
+  "http_method": "POST"
 }

data/lib/workarea/api/documentation_test.rb

@@ -10,7 +10,7 @@ end
 module Workarea
   module Api
     class DocumentationTest < Workarea::IntegrationTest
-      IGNORED_HEADERS = %w(Host Accept)
+      IGNORED_HEADERS = %w(Host Accept X-Workarea-Segments)
 
       class Example
         attr_accessor :resource, :http_method, :route, :description,
@@ -22,6 +22,12 @@ module Workarea
           @requests = []
         end
 
+        def explanation=(value)
+          @explanation = Redcarpet::Markdown
+            .new(Redcarpet::Render::HTML.new(hard_wrap: true))
+            .render(value.strip_heredoc)
+        end
+
         def file_name
           name = @description.presence || "#{@http_method} #{@route}"
           "#{name.systemize}.json"
@@ -103,6 +109,9 @@ module Workarea
             end
           end
 
+          results['resources'].sort_by! { |r| r['name'] }
+          results['resources'].each { |r| r['examples'].sort_by! { |e| e['description'] } }
+
           File.open(root.join('index.json'), 'w') do |file|
             file.write(JSON.pretty_generate(results))
           end

data/lib/workarea/api/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Api
-    VERSION = '4.4.7'.freeze
+    VERSION = '4.5.0'.freeze
   end
 end

data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb

@@ -1,38 +1,50 @@
 module Workarea
   module Api
     module Storefront
-      class AnalyticsController < ActionController::Metal
-        include ActionController::Head
-        include ActionController::Instrumentation
-
+      class AnalyticsController < Api::Storefront::ApplicationController
         def category_view
           Metrics::CategoryByDay.inc(key: { category_id: params[:category_id] }, views: 1)
+
+          if current_metrics_id.present?
+            Metrics::User.save_affinity(
+              id: current_metrics_id,
+              action: 'viewed',
+              category_ids: params[:category_id]
+            )
+          end
+
           head :ok
         end
 
         def product_view
           Metrics::ProductByDay.inc(key: { product_id: params[:product_id] }, views: 1)
+
+          if current_metrics_id.present?
+            Metrics::User.save_affinity(
+              id: current_metrics_id,
+              action: 'viewed',
+              product_ids: params[:product_id]
+            )
+          end
+
           head :ok
         end
 
         def search
-          Metrics::SearchByDay.save_search(params[:q], params[:total_results])
-          head :ok
-        end
+          query_string = QueryString.new(params[:q])
 
-        def search_abandonment
-          warn <<~eos
-DEPRECATION WARNING: Search abandonment tracking is deprecated and will be removed \
-in Workarea 3.5.
-          eos
-          head :ok
-        end
+          if query_string.present? && !query_string.short?
+            Metrics::SearchByDay.save_search(params[:q], params[:total_results])
+
+            if current_metrics_id.present?
+              Metrics::User.save_affinity(
+                id: current_metrics_id,
+                action: 'viewed',
+                search_ids: query_string.id
+              )
+            end
+          end
 
-        def filters
-          warn <<~eos
-DEPRECATION WARNING: Filter analytics tracking is deprecated and will be removed \
-in Workarea 3.5.
-          eos
           head :ok
         end
       end

data/storefront/app/controllers/workarea/api/storefront/application_controller.rb

@@ -2,15 +2,15 @@ module Workarea
   module Api
     module Storefront
       class ApplicationController < Workarea::ApplicationController
-        include Workarea::Storefront::HttpCaching
+        include HttpCaching
         include Api::Storefront::Authentication
-        include Api::Storefront::UserActivity
 
         respond_to :json
 
         before_action :set_json_format
         before_action :skip_session
         before_action { params.permit! }
+        around_action :apply_segments
         after_action :disable_cors_protection
 
         rescue_from Mongoid::Errors::DocumentNotFound, with: :handle_not_found
@@ -28,6 +28,19 @@ module Workarea
           request.session_options[:skip] = true
         end
 
+        def assert_current_metrics_id
+          if current_metrics_id.blank?
+            render(
+              json: {
+                problem: t('workarea.api.storefront.recent_views.missing_id')
+              },
+              status: :unprocessable_entity
+            )
+
+            return false
+          end
+        end
+
         private
 
         def set_json_format