workarea-api 4.4.6

data/doc/api/admin/variants/listing_product_variants.json

@@ -0,0 +1,44 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"ccb3062c13b58a439fe49a701dda21ee\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "d2c1c0ad-17ff-435d-b437-e28b7fd0a2d7",
+        "X-Runtime": "0.008269",
+        "Expires": "0",
+        "Content-Length": "522"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products/7C6261B352/variants",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"variants\": [\n    {\n      \"_id\": \"5d5dbd0ad4322a4b69d78bf4\",\n      \"active\": true,\n      \"created_at\": \"2019-08-21T21:52:10.672Z\",\n      \"details\": {\n      },\n      \"name\": \"SKU857\",\n      \"position\": 0,\n      \"sku\": \"SKU857\",\n      \"updated_at\": \"2019-08-21T21:52:10.672Z\"\n    },\n    {\n      \"_id\": \"5d5dbd0ad4322a4b69d78bf5\",\n      \"active\": true,\n      \"created_at\": \"2019-08-21T21:52:10.771Z\",\n      \"details\": {\n      },\n      \"name\": \"SKU948\",\n      \"position\": 1,\n      \"sku\": \"SKU948\",\n      \"updated_at\": \"2019-08-21T21:52:10.771Z\"\n    },\n    {\n      \"_id\": \"5d5dbd0ad4322a4b69d78bf3\",\n      \"active\": true,\n      \"created_at\": null,\n      \"details\": {\n      },\n      \"name\": \"SKU\",\n      \"position\": 2,\n      \"sku\": \"SKU\",\n      \"updated_at\": null\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products/7C6261B352/variants\" -X GET "
+    }
+  ],
+  "resource": "Variants",
+  "description": "Listing product variants",
+  "route": "/api/admin/products/:product_id/variants",
+  "http_method": "GET"
+}

data/doc/api/admin/variants/removing_a_product_variant.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "e8d7089c-d4f3-45d5-b84a-5f78eb4cbd52",
+        "X-Runtime": "0.066995",
+        "Expires": "0"
+      },
+      "request_method": "DELETE",
+      "request_path": "/api/admin/products/EAC79FEB2C/variants/5d5dbd0bd4322a4b69d78bfb",
+      "request_body": null,
+      "request_content_type": "application/x-www-form-urlencoded",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/products/EAC79FEB2C/variants/5d5dbd0bd4322a4b69d78bfb\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Variants",
+  "description": "Removing a product variant",
+  "route": "/api/admin/products/:product_id/variants/:id",
+  "http_method": "DELETE"
+}

data/doc/api/admin/variants/updating_a_product_variant.json

@@ -0,0 +1,42 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "a02ffeb0-9f61-4f64-82e4-0ecd12ac44e6",
+        "X-Runtime": "0.071951",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/products/7972BEC196/variants/5d5dbd0cd4322a4b69d78c02",
+      "request_body": "{\"variant\":{\"name\":\"Foo\"}}",
+      "request_content_type": "application/json",
+      "response_status": 204,
+      "response_status_text": "No Content",
+      "response_body": null,
+      "response_content_type": null,
+      "curl": "curl \"https://www.example.com/api/admin/products/7972BEC196/variants/5d5dbd0cd4322a4b69d78c02\" -d '{\"variant\":{\"name\":\"Foo\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Variants",
+  "description": "Updating a product variant",
+  "route": "/api/admin/products/:product_id/variants/:id",
+  "http_method": "PATCH"
+}

data/doc/api/storefront/accounts/creating_an_account.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"12927d60377df6feb94097a68c874b22\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "4d915fc8-aff8-43fd-aba8-08df277268b9",
+        "X-Runtime": "0.316095",
+        "Expires": "0",
+        "Content-Length": "306"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/account",
+      "request_body": "{\"email\":\"bob@workarea.com\",\"password\":\"areallysecurepassword\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"account\": {\n    \"id\": \"5d5dbd8bd4322a4b69d7926e\",\n    \"email\": \"bob@workarea.com\",\n    \"public_info\": null,\n    \"first_name\": null,\n    \"last_name\": null,\n    \"updated_at\": \"2019-08-21T21:54:19.906Z\",\n    \"created_at\": \"2019-08-21T21:54:19.906Z\"\n  },\n  \"authentication_token\": {\n    \"token\": \"PHtCnN1B9ZoYNfTGnZh7Xxu6\",\n    \"expires_at\": \"2019-08-28T21:54:19.983Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"bob@workarea.com\",\"password\":\"areallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Accounts",
+  "description": "Creating an account",
+  "route": "/api/storefront/account",
+  "explanation": "            This endpoint does three things: it creates an account, it creates\n            an authentication token, and it sends an account creation email to\n            the customer.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/accounts/getting_account_details.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Authorization": "Token token=\"S7ba6Jmi7ALkqhCzzk19ZC6T\""
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"6166f3e5ae6b4a5252bc123a70472f42\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "2c35946b-cc19-415e-8689-e1a6362072b5",
+        "X-Runtime": "0.005800",
+        "Expires": "0",
+        "Content-Length": "203"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/account",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbd8dd4322a4b69d79276\",\n  \"email\": \"user267@workarea.com\",\n  \"public_info\": \"BC\",\n  \"first_name\": \"Ben\",\n  \"last_name\": \"Crouse\",\n  \"updated_at\": \"2019-08-21T21:54:21.038Z\",\n  \"created_at\": \"2019-08-21T21:54:21.038Z\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"S7ba6Jmi7ALkqhCzzk19ZC6T\\\"\""
+    }
+  ],
+  "resource": "Accounts",
+  "description": "Getting account details",
+  "route": "/api/storefront/account",
+  "http_method": "GET"
+}

data/doc/api/storefront/accounts/updating_an_account.json

@@ -0,0 +1,52 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json",
+        "Authorization": "Token token=\"AdK8VpGSyXdNUzuGVuUhJGZm\"",
+        "X-Http-Method-Override": "GET"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"860390f92f87fd1eb8edeab8ef315820\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "142efa84-00c3-4cc1-8a8e-092b6627582b",
+        "X-Runtime": "0.005679",
+        "Expires": "0",
+        "Content-Length": "203"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/account",
+      "request_body": "{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbd8cd4322a4b69d79272\",\n  \"email\": \"user266@workarea.com\",\n  \"public_info\": \"BC\",\n  \"first_name\": \"Ben\",\n  \"last_name\": \"Crouse\",\n  \"updated_at\": \"2019-08-21T21:54:20.487Z\",\n  \"created_at\": \"2019-08-21T21:54:20.487Z\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"AdK8VpGSyXdNUzuGVuUhJGZm\\\"\" \\\n\t-H \"X-Http-Method-Override: GET\""
+    }
+  ],
+  "resource": "Accounts",
+  "description": "Updating an account",
+  "route": "/api/storefront/account",
+  "http_method": "POST"
+}

data/doc/api/storefront/analytics/saving_a_category_view.json

@@ -0,0 +1,39 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "Content-Type": "text/html; charset=utf-8",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "6d988bfd-dc84-4ac1-91f9-e9e3ca779a65",
+        "X-Runtime": "0.002649",
+        "Expires": "0",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/analytics/category_view/12345",
+      "request_body": null,
+      "request_content_type": "application/x-www-form-urlencoded",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "text/html",
+      "curl": "curl \"https://www.example.com/api/storefront/analytics/category_view/12345\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Analytics",
+  "description": "saving a category view",
+  "route": "/api/storefront/analytics/category_view/:category_id",
+  "explanation": "saving a category view will be reflected in admin reports",
+  "http_method": "POST"
+}

data/doc/api/storefront/analytics/saving_a_product_view.json

@@ -0,0 +1,39 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/x-www-form-urlencoded"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "Content-Type": "text/html; charset=utf-8",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "3aa00741-ae34-41b9-9c23-2dc758d19151",
+        "X-Runtime": "0.002840",
+        "Expires": "0",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/analytics/product_view/12345",
+      "request_body": null,
+      "request_content_type": "application/x-www-form-urlencoded",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "text/html",
+      "curl": "curl \"https://www.example.com/api/storefront/analytics/product_view/12345\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Analytics",
+  "description": "saving a product view",
+  "route": "/api/storefront/analytics/product_view/:product_id",
+  "explanation": "saving a product view will be reflected in admin reports",
+  "http_method": "POST"
+}

data/doc/api/storefront/analytics/saving_a_search.json

@@ -0,0 +1,39 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "Content-Type": "text/html; charset=utf-8",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "8b19fca8-2746-49bc-94df-e191552aa898",
+        "X-Runtime": "0.002739",
+        "Expires": "0",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/analytics/search",
+      "request_body": "{\"q\":\"foo\",\"total_results\":5}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "text/html",
+      "curl": "curl \"https://www.example.com/api/storefront/analytics/search\" -d '{\"q\":\"foo\",\"total_results\":5}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Analytics",
+  "description": "Saving a search",
+  "route": "/api/storefront/analytics/search",
+  "explanation": "            Saving a search will be reflected in admin reports. This is intended\n            to be called once per search performed by a customer.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/analytics/saving_a_search_abandonment.json

@@ -0,0 +1,38 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "Content-Type": "text/html; charset=utf-8",
+        "Cache-Control": "no-cache",
+        "X-Request-Id": "9c3731e3-d4e8-46d0-93d6-c74abb949b7c",
+        "X-Runtime": "0.001960",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/analytics/search_abandonment",
+      "request_body": "{\"q\":\"foo\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "text/html",
+      "curl": "curl \"https://www.example.com/api/storefront/analytics/search_abandonment\" -d '{\"q\":\"foo\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Analytics",
+  "description": "Saving a search abandonment",
+  "route": "/api/storefront/analytics/search_abandonment",
+  "http_method": "POST",
+  "explanation": "            Saving a search abandonment will be reflected in admin reports. This\n            is intended to be called when a customer performs a search, but\n            leaves the screen without viewing a product.\n"
+}

data/doc/api/storefront/analytics/saving_filters.json

@@ -0,0 +1,38 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "Content-Type": "text/html; charset=utf-8",
+        "Cache-Control": "no-cache",
+        "X-Request-Id": "06a932d7-b02a-4cac-b2cb-abb346a351fe",
+        "X-Runtime": "0.005257",
+        "Content-Length": "0"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/analytics/filters",
+      "request_body": "{\"filters\":{\"color\":\"Red\"}}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": null,
+      "response_content_type": "text/html",
+      "curl": "curl \"https://www.example.com/api/storefront/analytics/filters\" -d '{\"filters\":{\"color\":\"Red\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Analytics",
+  "description": "Saving filters",
+  "route": "/api/storefront/analytics/filters",
+  "http_method": "POST",
+  "explanation": "            Saving a filter will be reflected in admin reports. This is intended\n            to be called when a customer selects a filter on from a product\n            listing (most likely categories or search results).\n"
+}

data/doc/api/storefront/assets/showing_an_asset.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"a5c14b557854cee6ec5f29b9abb23921\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "7dfd7d27-f044-4216-8024-ebdce1de2ee0",
+        "X-Runtime": "0.004118",
+        "Expires": "0",
+        "Content-Length": "217"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/assets/5d5dbd2ed4322a4b69d78df5",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbd2ed4322a4b69d78df5\",\n  \"name\": \"Summer Sale Callout\",\n  \"url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMDgvMjEvNnBrMjhhbDJhel9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=158e5af8e3a65664\",\n  \"type\": \"image\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/assets/5d5dbd2ed4322a4b69d78df5\" -X GET "
+    }
+  ],
+  "resource": "Assets",
+  "description": "Showing an asset",
+  "route": "/api/storefront/assets/:id",
+  "explanation": "            Use this endpoint to look up assets stored in Workarea. Often times\n            these will be referenced in content blocks.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/authentication/creating_an_authentication_token.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"a2ab4f837ea395ab575925b081cb3ca3\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "fb0ea804-827a-4bd6-9687-d5d7ab264b3c",
+        "X-Runtime": "0.250259",
+        "Expires": "0",
+        "Content-Length": "76"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/authentication_tokens",
+      "request_body": "{\"email\":\"user8@workarea.com\",\"password\":\"p@assword!\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"token\": \"q4eRbfXaAf3c4gJBHtojewZt\",\n  \"expires_at\": \"2019-08-28T21:49:33.251Z\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '{\"email\":\"user8@workarea.com\",\"password\":\"p@assword!\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Authentication",
+  "description": "Creating an authentication token",
+  "route": "/api/storefront/authentication_tokens",
+  "explanation": "            Creating an authentication token is the first step in user\n            authentication. You will use this token to authenticate requests on\n            behalf of the user going forward. To get a token you can use to\n            authenticate an account, use this endpoint. You'll need the email\n            and password from the user, and we'll issue a token that can be used\n            to authenticate further requests for that customer. This token will\n            expire after 7 days.\n            Tokens are also invalidated when a user changes their password. See\n            the \"using an authentication token\" example for how to use an\n            authentication token.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/authentication/refreshing_an_authentication_token.json

@@ -0,0 +1,52 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/x-www-form-urlencoded",
+        "Authorization": "Token token=\"igReqgpz6Y9DGU4FFhwSkKnJ\""
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"66a238fd3ae548835be1e293b3f05cd9\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "b42d9eaf-b00a-4cae-9e64-64f82613936e",
+        "X-Runtime": "0.007278",
+        "Expires": "0",
+        "Content-Length": "76"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/storefront/authentication_tokens",
+      "request_body": null,
+      "request_content_type": "application/x-www-form-urlencoded",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"token\": \"igReqgpz6Y9DGU4FFhwSkKnJ\",\n  \"expires_at\": \"2019-08-28T21:49:33.839Z\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"igReqgpz6Y9DGU4FFhwSkKnJ\\\"\""
+    }
+  ],
+  "resource": "Authentication",
+  "description": "Refreshing an authentication token",
+  "route": "/api/storefront/authentication_tokens",
+  "explanation": "            Refreshing an authentication token extends its expiration so that it\n            can continue to be used.\n",
+  "http_method": "PATCH"
+}