workarea-api 4.4.6 → 4.5.4

data/doc/api/admin/email_signups/listing_email_signups.json

@@ -33,10 +33,13 @@
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Content-Type": "application/json; charset=utf-8",
-        "ETag": "W/\"5584471bf3a3834ca9fdd4fc9bf2ba52\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:38:35 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "0fb3f7e7-7d0b-44cc-ab43-7d58da1ec0d0",
-        "X-Runtime": "0.005540",
+        "X-Request-Id": "9cb1ba2e-ab06-44b0-8fed-fdbb367a3da0",
+        "X-Runtime": "0.004936",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "299"
       },
@@ -46,7 +49,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"email_signups\": [\n    {\n      \"_id\": \"5d5dbdc1d4322a4b69d7957e\",\n      \"created_at\": \"2019-08-21T21:55:13.523Z\",\n      \"email\": \"1@workarea.com\",\n      \"updated_at\": \"2019-08-21T21:55:13.523Z\"\n    },\n    {\n      \"_id\": \"5d5dbdc1d4322a4b69d7957d\",\n      \"created_at\": \"2019-08-21T21:55:13.520Z\",\n      \"email\": \"0@workarea.com\",\n      \"updated_at\": \"2019-08-21T21:55:13.520Z\"\n    }\n  ]\n}",
+      "response_body": "{\n  \"email_signups\": [\n    {\n      \"_id\": \"5dddc58b124159425407591c\",\n      \"created_at\": \"2019-11-27T00:38:35.568Z\",\n      \"email\": \"1@workarea.com\",\n      \"updated_at\": \"2019-11-27T00:38:35.568Z\"\n    },\n    {\n      \"_id\": \"5dddc58b124159425407591b\",\n      \"created_at\": \"2019-11-27T00:38:35.564Z\",\n      \"email\": \"0@workarea.com\",\n      \"updated_at\": \"2019-11-27T00:38:35.564Z\"\n    }\n  ]\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/admin/email_signups?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
     }

data/doc/api/admin/email_signups/showing_an_email_signup.json

@@ -15,26 +15,24 @@
         "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/\"2222a485cb64774a3dbc169ba6d40d6e\"",
-        "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "14e2036f-7d68-423f-ab31-6320f2d5f46b",
-        "X-Runtime": "0.004002",
-        "Expires": "0",
-        "Content-Length": "169"
+        "X-Flash-Messages": "{}",
+        "ETag": "W/\"94638a9b8bbf68f7e2a6d5186b31de04\"",
+        "Cache-Control": "max-age=0, private, must-revalidate",
+        "Set-Cookie": "release_page_views=; path=/; expires=Sun, 06 Sep 2037 18:06:07 -0000\nrelease_changed_at=; path=/; expires=Sun, 06 Sep 2037 18:06:07 -0000",
+        "X-Request-Id": "ef309928-4057-4e7f-88ae-f9cb520d564a",
+        "X-Runtime": "0.009249",
+        "Content-Length": "162"
       },
       "request_method": "GET",
-      "request_path": "/api/admin/email_signups/5d5dbdc0d4322a4b69d79579",
+      "request_path": "/api/admin/email_signups/59b0390f7ceffe612c1193a4",
       "request_body": null,
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"email_signup\": {\n    \"_id\": \"5d5dbdc0d4322a4b69d79579\",\n    \"created_at\": \"2019-08-21T21:55:12.982Z\",\n    \"email\": \"email-signup-3@workarea.com\",\n    \"updated_at\": \"2019-08-21T21:55:12.982Z\"\n  }\n}",
+      "response_body": "{\n  \"email_signup\": {\n    \"_id\": \"59b0390f7ceffe612c1193a4\",\n    \"created_at\": \"2017-09-06T18:06:07.833Z\",\n    \"email\": \"bcrouse@workarea.com\",\n    \"updated_at\": \"2017-09-06T18:06:07.833Z\"\n  }\n}",
       "response_content_type": "application/json",
-      "curl": "curl -g \"https://www.example.com/api/admin/email_signups/5d5dbdc0d4322a4b69d79579\" -X GET "
+      "curl": "curl -g \"https://www.example.com/api/admin/email_signups/59b0390f7ceffe612c1193a4\" -X GET "
     }
   ],
   "resource": "Email Signups",

data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json

@@ -0,0 +1,47 @@
+{
+  "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:38:36 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "4acea774-f9f6-4b3b-8db5-43a5736ee67a",
+        "X-Runtime": "0.004993",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "159"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/email_signups/test%2540workarea%252Ecom",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"email_signup\": {\n    \"_id\": \"5dddc58c1241594254075921\",\n    \"created_at\": \"2019-11-27T00:38:36.712Z\",\n    \"email\": \"test@workarea.com\",\n    \"updated_at\": \"2019-11-27T00:38:36.712Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/email_signups/test%2540workarea%252Ecom\" -X GET "
+    }
+  ],
+  "resource": "Email Signups",
+  "description": "Showing an email signup by email",
+  "route": "/api/admin/email_signups/:email",
+  "http_method": "GET"
+}

data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json

@@ -0,0 +1,47 @@
+{
+  "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:38:34 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "22f808b3-03bd-40ec-9d65-b0bf5f0e2344",
+        "X-Runtime": "0.004250",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "169"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/email_signups/5dddc58a1241594254075916",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"email_signup\": {\n    \"_id\": \"5dddc58a1241594254075916\",\n    \"created_at\": \"2019-11-27T00:38:34.411Z\",\n    \"email\": \"email-signup-3@workarea.com\",\n    \"updated_at\": \"2019-11-27T00:38:34.411Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/email_signups/5dddc58a1241594254075916\" -X GET "
+    }
+  ],
+  "resource": "Email Signups",
+  "description": "Showing an email signup by ID",
+  "route": "/api/admin/email_signups/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/fulfillment/listing_fulfillments.json

@@ -30,10 +30,13 @@
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Content-Type": "application/json; charset=utf-8",
-        "ETag": "W/\"e3d1320e84d6324c4bd52a6c1fea7b26\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:44:24 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "afb6a256-3f1c-4a07-8d75-595f99366599",
-        "X-Runtime": "0.008100",
+        "X-Request-Id": "9c761c3f-1fa8-4c59-a9c9-9ec7f6a44ee9",
+        "X-Runtime": "0.007358",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "476"
       },
@@ -43,7 +46,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"fulfillments\": [\n    {\n      \"_id\": \"2\",\n      \"created_at\": \"2019-08-21T21:49:52.374Z\",\n      \"items\": [\n        {\n          \"_id\": \"5d5dbc80d4322a4b69d78345\",\n          \"created_at\": null,\n          \"order_item_id\": \"5d5dbc7dd4322a4b69d78301\",\n          \"quantity\": 2,\n          \"updated_at\": null\n        }\n      ],\n      \"updated_at\": \"2019-08-21T21:49:52.374Z\"\n    },\n    {\n      \"_id\": \"1\",\n      \"created_at\": \"2019-08-21T21:49:49.369Z\",\n      \"items\": [\n        {\n          \"_id\": \"5d5dbc7dd4322a4b69d782fc\",\n          \"created_at\": null,\n          \"order_item_id\": \"5d5dbc7ad4322a4b69d782cf\",\n          \"quantity\": 2,\n          \"updated_at\": null\n        }\n      ],\n      \"updated_at\": \"2019-08-21T21:49:49.369Z\"\n    }\n  ]\n}",
+      "response_body": "{\n  \"fulfillments\": [\n    {\n      \"_id\": \"2\",\n      \"created_at\": \"2019-11-27T00:44:21.538Z\",\n      \"items\": [\n        {\n          \"_id\": \"5dddc6e51241594254076336\",\n          \"created_at\": null,\n          \"order_item_id\": \"5dddc6dd12415942540762ef\",\n          \"quantity\": 2,\n          \"updated_at\": null\n        }\n      ],\n      \"updated_at\": \"2019-11-27T00:44:21.538Z\"\n    },\n    {\n      \"_id\": \"1\",\n      \"created_at\": \"2019-11-27T00:44:12.156Z\",\n      \"items\": [\n        {\n          \"_id\": \"5dddc6dc12415942540762e3\",\n          \"created_at\": null,\n          \"order_item_id\": \"5dddc6d912415942540762b4\",\n          \"quantity\": 2,\n          \"updated_at\": null\n        }\n      ],\n      \"updated_at\": \"2019-11-27T00:44:12.156Z\"\n    }\n  ]\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/admin/fulfillments\" -X GET "
     }

data/doc/api/admin/fulfillment/marking_items_as_canceled.json

@@ -21,22 +21,25 @@
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Location": "/api/admin/fulfillments/1234",
         "Content-Type": "application/json; charset=utf-8",
-        "ETag": "W/\"3a0f2cdf376820db5c632d8cecb5e16d\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:44:02 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "6228c126-77de-4c0c-b7d7-d3e9847cd8a3",
-        "X-Runtime": "0.229706",
+        "X-Request-Id": "c2629862-a1ed-4626-b4c6-e54fb8620b72",
+        "X-Runtime": "0.218236",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "416"
       },
       "request_method": "POST",
       "request_path": "/api/admin/fulfillments/1234/cancel_items",
-      "request_body": "{\"items\":[{\"id\":\"5d5dbc85d4322a4b69d78384\",\"quantity\":1}]}",
+      "request_body": "{\"items\":[{\"id\":\"5dddc6cf1241594254076237\",\"quantity\":1}]}",
       "request_content_type": "application/json",
       "response_status": 201,
       "response_status_text": "Created",
-      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-08-21T21:49:59.664Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5dbc87d4322a4b69d783b1\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5d5dbc87d4322a4b69d783b2\",\n            \"created_at\": \"2019-08-21T21:49:59.960Z\",\n            \"data\": {\n            },\n            \"quantity\": 1,\n            \"status\": \"canceled\",\n            \"updated_at\": \"2019-08-21T21:49:59.960Z\"\n          }\n        ],\n        \"order_item_id\": \"5d5dbc85d4322a4b69d78384\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-21T21:49:59.964Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-11-27T00:44:02.418Z\",\n    \"items\": [\n      {\n        \"_id\": \"5dddc6d21241594254076266\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5dddc6d21241594254076268\",\n            \"created_at\": \"2019-11-27T00:44:02.779Z\",\n            \"data\": {\n            },\n            \"quantity\": 1,\n            \"status\": \"canceled\",\n            \"updated_at\": \"2019-11-27T00:44:02.779Z\"\n          }\n        ],\n        \"order_item_id\": \"5dddc6cf1241594254076237\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-11-27T00:44:02.782Z\"\n  }\n}",
       "response_content_type": "application/json",
-      "curl": "curl \"https://www.example.com/api/admin/fulfillments/1234/cancel_items\" -d '{\"items\":[{\"id\":\"5d5dbc85d4322a4b69d78384\",\"quantity\":1}]}' -X POST \\\n\t-H \"Content-Type: application/json\""
+      "curl": "curl \"https://www.example.com/api/admin/fulfillments/1234/cancel_items\" -d '{\"items\":[{\"id\":\"5dddc6cf1241594254076237\",\"quantity\":1}]}' -X POST \\\n\t-H \"Content-Type: application/json\""
     }
   ],
   "resource": "Fulfillment",

data/doc/api/admin/fulfillment/marking_items_as_shipped.json

@@ -21,22 +21,25 @@
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Location": "/api/admin/fulfillments/1234",
         "Content-Type": "application/json; charset=utf-8",
-        "ETag": "W/\"24492b41765e7247d71d6dfabc79ca2d\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:44:46 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "9fbef416-6104-4c75-985f-ab5b713b5d69",
-        "X-Runtime": "0.257822",
+        "X-Request-Id": "0d009e4e-e602-4463-a031-47ad0a2fb329",
+        "X-Runtime": "0.229551",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "437"
       },
       "request_method": "POST",
       "request_path": "/api/admin/fulfillments/1234/ship_items",
-      "request_body": "{\"tracking_number\":\"1Z\",\"items\":[{\"id\":\"5d5dbc81d4322a4b69d7834d\",\"quantity\":1}]}",
+      "request_body": "{\"tracking_number\":\"1Z\",\"items\":[{\"id\":\"5dddc6fa1241594254076344\",\"quantity\":1}]}",
       "request_content_type": "application/json",
       "response_status": 201,
       "response_status_text": "Created",
-      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-08-21T21:49:55.910Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5dbc83d4322a4b69d7837a\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5d5dbc84d4322a4b69d7837b\",\n            \"created_at\": \"2019-08-21T21:49:56.213Z\",\n            \"data\": {\n              \"tracking_number\": \"1z\"\n            },\n            \"quantity\": 1,\n            \"status\": \"shipped\",\n            \"updated_at\": \"2019-08-21T21:49:56.213Z\"\n          }\n        ],\n        \"order_item_id\": \"5d5dbc81d4322a4b69d7834d\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-21T21:49:56.217Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-11-27T00:44:45.639Z\",\n    \"items\": [\n      {\n        \"_id\": \"5dddc6fd1241594254076373\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5dddc6fd1241594254076375\",\n            \"created_at\": \"2019-11-27T00:44:45.995Z\",\n            \"data\": {\n              \"tracking_number\": \"1z\"\n            },\n            \"quantity\": 1,\n            \"status\": \"shipped\",\n            \"updated_at\": \"2019-11-27T00:44:45.995Z\"\n          }\n        ],\n        \"order_item_id\": \"5dddc6fa1241594254076344\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-11-27T00:44:45.998Z\"\n  }\n}",
       "response_content_type": "application/json",
-      "curl": "curl \"https://www.example.com/api/admin/fulfillments/1234/ship_items\" -d '{\"tracking_number\":\"1Z\",\"items\":[{\"id\":\"5d5dbc81d4322a4b69d7834d\",\"quantity\":1}]}' -X POST \\\n\t-H \"Content-Type: application/json\""
+      "curl": "curl \"https://www.example.com/api/admin/fulfillments/1234/ship_items\" -d '{\"tracking_number\":\"1Z\",\"items\":[{\"id\":\"5dddc6fa1241594254076344\",\"quantity\":1}]}' -X POST \\\n\t-H \"Content-Type: application/json\""
     }
   ],
   "resource": "Fulfillment",

data/doc/api/admin/fulfillment/showing_fulfillment.json

@@ -19,10 +19,13 @@
         "X-Permitted-Cross-Domain-Policies": "none",
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Content-Type": "application/json; charset=utf-8",
-        "ETag": "W/\"99ee682fa8ebf8ae86253ccdc157b2bb\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:44:07 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "fad7957b-b685-46ca-8e4c-35b60111f9bf",
-        "X-Runtime": "0.006785",
+        "X-Request-Id": "78bcead0-5945-4f62-a13a-1eb2df8d9f4b",
+        "X-Runtime": "0.006757",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "247"
       },
@@ -32,7 +35,7 @@
       "request_content_type": null,
       "response_status": 200,
       "response_status_text": "OK",
-      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-08-21T21:49:45.862Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5dbc79d4322a4b69d782c7\",\n        \"created_at\": null,\n        \"order_item_id\": \"5d5dbc77d4322a4b69d7829a\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-21T21:49:45.862Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2019-11-27T00:44:06.809Z\",\n    \"items\": [\n      {\n        \"_id\": \"5dddc6d612415942540762a6\",\n        \"created_at\": null,\n        \"order_item_id\": \"5dddc6d31241594254076277\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-11-27T00:44:06.809Z\"\n  }\n}",
       "response_content_type": "application/json",
       "curl": "curl -g \"https://www.example.com/api/admin/fulfillments/1234\" -X GET "
     }

data/doc/api/admin/global_functionality/dealing_with_locales.json

@@ -0,0 +1,86 @@
+{
+  "parameters": [
+    {
+      "name": "locale",
+      "description": "I18n locale key"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "locale": "en"
+      },
+      "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:46:19 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "023113ef-7b7b-4f80-91e1-868e6f568b60",
+        "X-Runtime": "0.009481",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "741"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?locale=en",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"AE9C99D2EC\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:19.439Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:19.723Z\",\n      \"meta_description\": null,\n      \"name\": \"Test Product\",\n      \"purchasable\": true,\n      \"slug\": \"test-product\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:19.439Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc75b124159425407656c\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products?locale=en\" -X GET "
+    },
+    {
+      "request_headers": {
+        "Cookie": "_dummy_session=SXV2VGtpUWpKMDVEenlJMnFBMUF3OUFnSXlCWTJGWEdTOWxYc2V2V1pqay9mYTBxN2dKNlRTRHBMWnQ3eDcyNXY5eTJsU2JFcEVIRjRYTXRMZUN4S1E9PS0tWlNMVmk3TE1hb1RXV2xaeiszMWNCQT09--4f13d09184dcbcd1170e5dce525d31a2494759e8"
+      },
+      "request_query_parameters": {
+        "locale": "es"
+      },
+      "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:46:19 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "17f28d89-710b-4ce9-b3a2-0f33a6522849",
+        "X-Runtime": "0.012967",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "747"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?locale=es",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"AE9C99D2EC\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:19.439Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:19.723Z\",\n      \"meta_description\": null,\n      \"name\": \"Producto de prueba\",\n      \"purchasable\": true,\n      \"slug\": \"test-product\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:19.439Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc75b124159425407656c\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products?locale=es\" -X GET \\\n\t-H \"Cookie: _dummy_session=SXV2VGtpUWpKMDVEenlJMnFBMUF3OUFnSXlCWTJGWEdTOWxYc2V2V1pqay9mYTBxN2dKNlRTRHBMWnQ3eDcyNXY5eTJsU2JFcEVIRjRYTXRMZUN4S1E9PS0tWlNMVmk3TE1hb1RXV2xaeiszMWNCQT09--4f13d09184dcbcd1170e5dce525d31a2494759e8\""
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Dealing with locales",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json

@@ -0,0 +1,56 @@
+{
+  "parameters": [
+    {
+      "name": "created_at_starts_at",
+      "description": "Start of a created at date range"
+    },
+    {
+      "name": "created_at_ends_at",
+      "description": "End of a created at date range"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "created_at_starts_at": "2019-11-26 00:46:21 UTC",
+        "created_at_ends_at": "2019-11-28 00:46:21 UTC"
+      },
+      "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:46:21 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "feefc310-0167-4a05-b4bf-d45ac045c430",
+        "X-Runtime": "0.008774",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?created_at_starts_at=2019-11-26+00%3A46%3A21+UTC&created_at_ends_at=2019-11-28+00%3A46%3A21+UTC",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"1E5662ED5D\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:21.761Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:21.951Z\",\n      \"meta_description\": null,\n      \"name\": \"Test Product\",\n      \"purchasable\": true,\n      \"slug\": \"test-product-1\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:21.761Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc75d1241594254076580\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    },\n    {\n      \"_id\": \"4FC73335DA\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:21.379Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:21.751Z\",\n      \"meta_description\": null,\n      \"name\": \"Test Product\",\n      \"purchasable\": true,\n      \"slug\": \"test-product\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:21.618Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc75d1241594254076577\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products?created_at_starts_at=2019-11-26+00%3A46%3A21+UTC&created_at_ends_at=2019-11-28+00%3A46%3A21+UTC\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Filtering by created at time stamp",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json

@@ -0,0 +1,56 @@
+{
+  "parameters": [
+    {
+      "name": "updated_at_starts_at",
+      "description": "Start of a last updated at date range"
+    },
+    {
+      "name": "updated_at_ends_at",
+      "description": "End of a last updated at date range"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "updated_at_starts_at": "2019-11-26 00:46:27 UTC",
+        "updated_at_ends_at": "2019-11-28 00:46:27 UTC"
+      },
+      "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",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 27 Nov 2019 00:46:27 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "65d90f96-6dc3-45c1-91f8-fa7767d6fdd6",
+        "X-Runtime": "0.011043",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?updated_at_starts_at=2019-11-26+00%3A46%3A27+UTC&updated_at_ends_at=2019-11-28+00%3A46%3A27+UTC",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"F2908E09C4\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:27.174Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:27.338Z\",\n      \"meta_description\": null,\n      \"name\": \"Test Product\",\n      \"purchasable\": true,\n      \"slug\": \"test-product-1\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:27.174Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc76312415942540765af\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    },\n    {\n      \"_id\": \"9D68374432\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-11-27T00:46:26.471Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n        \"Material\": [\n          \"Cotton\"\n        ],\n        \"Style\": [\n          \"12345\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"Material\": \"Cotton\",\n        \"Style\": \"12345\"\n      },\n      \"last_indexed_at\": \"2019-11-27T00:46:27.163Z\",\n      \"meta_description\": null,\n      \"name\": \"Test Product\",\n      \"purchasable\": true,\n      \"slug\": \"test-product\",\n      \"subscribed_user_ids\": [\n\n      ],\n      \"tags\": [\n\n      ],\n      \"template\": \"generic\",\n      \"updated_at\": \"2019-11-27T00:46:27.035Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5dddc76212415942540765a6\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": \"SKU\",\n          \"position\": 0,\n          \"sku\": \"SKU\",\n          \"updated_at\": null\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products?updated_at_starts_at=2019-11-26+00%3A46%3A27+UTC&updated_at_ends_at=2019-11-28+00%3A46%3A27+UTC\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Filtering by updated time stamp",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}