workarea-api 4.4.7 → 4.5.5

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/\"0fa7a729bbac800e0657c37173c2faa5\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:48:55 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "176dfe5f-8210-4657-9526-3d409ce5e030",
-        "X-Runtime": "0.230254",
+        "X-Request-Id": "3ce5f152-7de7-4e4c-8760-f295d7018f81",
+        "X-Runtime": "0.293819",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "416"
       },
       "request_method": "POST",
       "request_path": "/api/admin/fulfillments/1234/cancel_items",
-      "request_body": "{\"items\":[{\"id\":\"5d5ecb63d4322a04dfbf781c\",\"quantity\":1}]}",
+      "request_body": "{\"items\":[{\"id\":\"5f3d2dc20218236de151f0ec\",\"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-22T17:05:42.403Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5ecb66d4322a04dfbf7849\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5d5ecb66d4322a04dfbf784a\",\n            \"created_at\": \"2019-08-22T17:05:42.727Z\",\n            \"data\": {\n            },\n            \"quantity\": 1,\n            \"status\": \"canceled\",\n            \"updated_at\": \"2019-08-22T17:05:42.727Z\"\n          }\n        ],\n        \"order_item_id\": \"5d5ecb63d4322a04dfbf781c\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-22T17:05:42.730Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2020-08-19T13:48:55.044Z\",\n    \"items\": [\n      {\n        \"_id\": \"5f3d2dc70218236de151f11b\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5f3d2dc70218236de151f11d\",\n            \"created_at\": \"2020-08-19T13:48:55.598Z\",\n            \"data\": {\n            },\n            \"quantity\": 1,\n            \"status\": \"canceled\",\n            \"updated_at\": \"2020-08-19T13:48:55.598Z\"\n          }\n        ],\n        \"order_item_id\": \"5f3d2dc20218236de151f0ec\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2020-08-19T13:48:55.601Z\"\n  }\n}",
       "response_content_type": "application/json",
-      "curl": "curl \"https://www.example.com/api/admin/fulfillments/1234/cancel_items\" -d '{\"items\":[{\"id\":\"5d5ecb63d4322a04dfbf781c\",\"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\":\"5f3d2dc20218236de151f0ec\",\"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/\"e33276c7ec1dae27cdb190f9892e54ec\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:49:08 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "b6cc63e5-3373-4b7e-98bb-d8a42d63cc6f",
-        "X-Runtime": "0.232627",
+        "X-Request-Id": "03eaea3a-8c2a-4653-9326-c73bd3a0a0df",
+        "X-Runtime": "0.298634",
+        "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\":\"5d5ecb5fd4322a04dfbf77e5\",\"quantity\":1}]}",
+      "request_body": "{\"tracking_number\":\"1Z\",\"items\":[{\"id\":\"5f3d2dcf0218236de151f169\",\"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-22T17:05:38.277Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5ecb62d4322a04dfbf7812\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5d5ecb62d4322a04dfbf7813\",\n            \"created_at\": \"2019-08-22T17:05:38.606Z\",\n            \"data\": {\n              \"tracking_number\": \"1z\"\n            },\n            \"quantity\": 1,\n            \"status\": \"shipped\",\n            \"updated_at\": \"2019-08-22T17:05:38.606Z\"\n          }\n        ],\n        \"order_item_id\": \"5d5ecb5fd4322a04dfbf77e5\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-22T17:05:38.609Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2020-08-19T13:49:07.394Z\",\n    \"items\": [\n      {\n        \"_id\": \"5f3d2dd30218236de151f198\",\n        \"created_at\": null,\n        \"events\": [\n          {\n            \"_id\": \"5f3d2dd30218236de151f19a\",\n            \"created_at\": \"2020-08-19T13:49:07.860Z\",\n            \"data\": {\n              \"tracking_number\": \"1z\"\n            },\n            \"quantity\": 1,\n            \"status\": \"shipped\",\n            \"updated_at\": \"2020-08-19T13:49:07.860Z\"\n          }\n        ],\n        \"order_item_id\": \"5f3d2dcf0218236de151f169\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2020-08-19T13:49:07.863Z\"\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\":\"5d5ecb5fd4322a04dfbf77e5\",\"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\":\"5f3d2dcf0218236de151f169\",\"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/\"3cbadfd1cbb37db792302fb05c2952cd\"",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:49:01 GMT",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "ac06d35a-459d-475e-ac71-0700ba9bf374",
-        "X-Runtime": "0.007645",
+        "X-Request-Id": "aa9d5dfd-a8db-4c1d-8e37-42049148573e",
+        "X-Runtime": "0.005815",
+        "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-22T17:05:34.459Z\",\n    \"items\": [\n      {\n        \"_id\": \"5d5ecb5ed4322a04dfbf77dd\",\n        \"created_at\": null,\n        \"order_item_id\": \"5d5ecb5bd4322a04dfbf77b0\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2019-08-22T17:05:34.459Z\"\n  }\n}",
+      "response_body": "{\n  \"fulfillment\": {\n    \"_id\": \"1234\",\n    \"created_at\": \"2020-08-19T13:49:01.515Z\",\n    \"items\": [\n      {\n        \"_id\": \"5f3d2dcd0218236de151f15b\",\n        \"created_at\": null,\n        \"order_item_id\": \"5f3d2dc90218236de151f12c\",\n        \"quantity\": 2,\n        \"updated_at\": null\n      }\n    ],\n    \"updated_at\": \"2020-08-19T13:49:01.515Z\"\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, 19 Aug 2020 13:46:10 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "360a25e5-f7a7-427e-a1a7-bccbb01d964c",
+        "X-Runtime": "0.006840",
+        "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\": \"E09C6C3EE5\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:09.468Z\",\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\": \"2020-08-19T13:46:10.156Z\",\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\": \"2020-08-19T13:46:09.468Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d210218236de151eb3c\",\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=eExKQ3ZpWlpWeGQvazE3ZVdHSnJRTnVYU3dYU010enN6YVNKSmhiRGk0VDZ3YzVKNUlWMlFQMXg5VkRZN2M2anJ6Sjg3NC93cmdwVWh1YjhMb0dSVGc9PS0tN1prSWZHamZoMFZnVTJQaXB0VVJHQT09--7c23c09d7f6dded4eb645641f30c659d601dfca8"
+      },
+      "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, 19 Aug 2020 13:46:10 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "9496f423-781f-4902-93f3-3dfa70d94c50",
+        "X-Runtime": "0.008789",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "672"
+      },
+      "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\": \"E09C6C3EE5\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:09.468Z\",\n      \"customizations\": null,\n      \"default_category_id\": null,\n      \"description\": null,\n      \"details\": {\n      },\n      \"digital\": false,\n      \"filters\": {\n      },\n      \"last_indexed_at\": \"2020-08-19T13:46:10.156Z\",\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\": \"2020-08-19T13:46:09.468Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d210218236de151eb3c\",\n          \"active\": true,\n          \"active_segment_ids\": [\n\n          ],\n          \"created_at\": null,\n          \"details\": {\n          },\n          \"name\": null,\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=eExKQ3ZpWlpWeGQvazE3ZVdHSnJRTnVYU3dYU010enN6YVNKSmhiRGk0VDZ3YzVKNUlWMlFQMXg5VkRZN2M2anJ6Sjg3NC93cmdwVWh1YjhMb0dSVGc9PS0tN1prSWZHamZoMFZnVTJQaXB0VVJHQT09--7c23c09d7f6dded4eb645641f30c659d601dfca8\""
+    }
+  ],
+  "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": "2020-08-18 13:46:05 UTC",
+        "created_at_ends_at": "2020-08-20 13:46:05 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, 19 Aug 2020 13:46:05 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "8dc42fd5-6309-455b-b2cb-a9e7d7c9e5ac",
+        "X-Runtime": "0.008335",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?created_at_starts_at=2020-08-18+13%3A46%3A05+UTC&created_at_ends_at=2020-08-20+13%3A46%3A05+UTC",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"1BD3BA02EB\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:05.405Z\",\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\": \"2020-08-19T13:46:05.765Z\",\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\": \"2020-08-19T13:46:05.405Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d1d0218236de151eb21\",\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\": \"E992C2F571\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:04.727Z\",\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\": \"2020-08-19T13:46:05.390Z\",\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\": \"2020-08-19T13:46:05.188Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d1c0218236de151eb18\",\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=2020-08-18+13%3A46%3A05+UTC&created_at_ends_at=2020-08-20+13%3A46%3A05+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": "2020-08-18 13:46:14 UTC",
+        "updated_at_ends_at": "2020-08-20 13:46:14 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, 19 Aug 2020 13:46:14 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "6993dfc3-7789-4ea1-8173-81f4e78a9c12",
+        "X-Runtime": "0.010144",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?updated_at_starts_at=2020-08-18+13%3A46%3A14+UTC&updated_at_ends_at=2020-08-20+13%3A46%3A14+UTC",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"9349778291\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:14.390Z\",\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\": \"2020-08-19T13:46:14.782Z\",\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\": \"2020-08-19T13:46:14.390Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d260218236de151eb65\",\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\": \"5702D10633\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:13.780Z\",\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\": \"2020-08-19T13:46:14.377Z\",\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\": \"2020-08-19T13:46:14.178Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d250218236de151eb5c\",\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=2020-08-18+13%3A46%3A14+UTC&updated_at_ends_at=2020-08-20+13%3A46%3A14+UTC\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Filtering by updated time stamp",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

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

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Current page"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "page": "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",
+        "Content-Type": "application/json; charset=utf-8",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:46:12 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "bc70b3f1-39ff-4481-8a89-f47fe207a8f7",
+        "X-Runtime": "0.008205",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?page=1",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"652A9EA6A1\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:11.988Z\",\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\": \"2020-08-19T13:46:12.329Z\",\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\": \"2020-08-19T13:46:11.988Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d230218236de151eb53\",\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\": \"BB674676A4\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:11.332Z\",\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\": \"2020-08-19T13:46:11.972Z\",\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\": \"2020-08-19T13:46:11.682Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d230218236de151eb4a\",\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?page=1\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Paging results",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

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

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Current page"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "page": "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",
+        "Content-Type": "application/json; charset=utf-8",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:46:03 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "d7156dd9-85d4-489e-acc0-6b464d4eb5a4",
+        "X-Runtime": "0.006392",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "15"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?page=2",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products?page=2\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Retrieving addtional pages of results",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

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

@@ -0,0 +1,56 @@
+{
+  "parameters": [
+    {
+      "name": "sort_by",
+      "description": "Field on which to sort (see responses for possible values)"
+    },
+    {
+      "name": "sort_direction",
+      "description": "Direction to sort (asc or desc)"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "sort_by": "created_at",
+        "sort_direction": "desc"
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Workarea-Segments",
+        "Last-Modified": "Wed, 19 Aug 2020 13:46:08 GMT",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "3c5edf8e-3d83-409a-8354-43a6892997ac",
+        "X-Runtime": "0.007928",
+        "X-Workarea-Segments": "",
+        "Expires": "0",
+        "Content-Length": "1470"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?sort_by=created_at&sort_direction=desc",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"products\": [\n    {\n      \"_id\": \"856046A927\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:07.662Z\",\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\": \"2020-08-19T13:46:08.054Z\",\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\": \"2020-08-19T13:46:07.662Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d1f0218236de151eb33\",\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\": \"CE707AD0B3\",\n      \"active\": true,\n      \"active_segment_ids\": [\n\n      ],\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2020-08-19T13:46:07.031Z\",\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\": \"2020-08-19T13:46:07.650Z\",\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\": \"2020-08-19T13:46:07.437Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5f3d2d1f0218236de151eb2a\",\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?sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Global Functionality",
+  "description": "Sorting results",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}