workarea-api 4.4.6

data/doc/api/admin/product_images/updating_a_product_image.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": "ef1ed3bd-d5c8-4b03-8773-1fabd0db215c",
+        "X-Runtime": "0.101313",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/products/114020DD70/images/5d5dbd5ad4322a4b69d78fa4",
+      "request_body": "{\"image\":{\"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/114020DD70/images/5d5dbd5ad4322a4b69d78fa4\" -d '{\"image\":{\"name\":\"foo\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Product Images",
+  "description": "Updating a product image",
+  "route": "/api/admin/products/:product_id/images/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/products/bulk_upserting_products.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": "e9c32515-46a4-4398-9269-d59757f9ed3f",
+        "X-Runtime": "0.369929",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/products/bulk",
+      "request_body": "{\"products\":[{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]},{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]},{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}]}",
+      "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/bulk\" -d '{\"products\":[{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]},{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]},{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.831Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.831Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78227\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Products",
+  "description": "Bulk upserting products",
+  "route": "/api/admin/products/bulk",
+  "http_method": "PATCH"
+}

data/doc/api/admin/products/creating_a_product.json

@@ -0,0 +1,46 @@
+{
+  "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",
+        "Location": "/api/admin/products/11157B1CB0",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"292d288f4b9b81846f38cb0855bd3f75\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "09e3f98a-abb5-419b-a9c7-e4d16087a113",
+        "X-Runtime": "0.107615",
+        "Expires": "0",
+        "Content-Length": "670"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/products",
+      "request_body": "{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:24.943Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:24.943Z\",\"variants\":[{\"_id\":\"5d5dbc64d4322a4b69d78239\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"product\": {\n    \"_id\": \"11157B1CB0\",\n    \"active\": true,\n    \"browser_title\": null,\n    \"copied_from_id\": null,\n    \"created_at\": \"2019-08-21T21:49:24.943Z\",\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\": null,\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-08-21T21:49:24.943Z\",\n    \"variants\": [\n      {\n        \"_id\": \"5d5dbc64d4322a4b69d78239\",\n        \"active\": true,\n        \"created_at\": null,\n        \"details\": {\n        },\n        \"name\": \"SKU\",\n        \"position\": 0,\n        \"sku\": \"SKU\",\n        \"updated_at\": null\n      }\n    ]\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/products\" -d '{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:24.943Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:24.943Z\",\"variants\":[{\"_id\":\"5d5dbc64d4322a4b69d78239\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Products",
+  "description": "Creating a product",
+  "route": "/api/admin/products",
+  "http_method": "POST"
+}

data/doc/api/admin/products/listing_products.json

@@ -0,0 +1,58 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Current page"
+    },
+    {
+      "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": {
+        "page": "1",
+        "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",
+        "ETag": "W/\"0136cb02e355db6c3376c77ad3af95c4\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "e9edb166-efa1-438b-bc8c-f5f622076915",
+        "X-Runtime": "0.011125",
+        "Expires": "0",
+        "Content-Length": "1374"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products?page=1&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\": \"AD42849B45\",\n      \"active\": true,\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-08-21T21:49:20.477Z\",\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-08-21T21:49:20.601Z\",\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-08-21T21:49:20.477Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5d5dbc60d4322a4b69d7820e\",\n          \"active\": true,\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\": \"453CC37A9C\",\n      \"active\": true,\n      \"browser_title\": null,\n      \"copied_from_id\": null,\n      \"created_at\": \"2019-08-21T21:49:20.231Z\",\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-08-21T21:49:20.469Z\",\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-08-21T21:49:20.383Z\",\n      \"variants\": [\n        {\n          \"_id\": \"5d5dbc60d4322a4b69d7820c\",\n          \"active\": true,\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&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Products",
+  "description": "Listing products",
+  "route": "/api/admin/products",
+  "http_method": "GET"
+}

data/doc/api/admin/products/removing_a_product.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": "9916ae6d-81b4-4a6e-a38f-b5a6682647ec",
+        "X-Runtime": "0.028880",
+        "Expires": "0"
+      },
+      "request_method": "DELETE",
+      "request_path": "/api/admin/products/05CE2C043C",
+      "request_body": null,
+      "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/05CE2C043C\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Products",
+  "description": "Removing a product",
+  "route": "/api/admin/products/:id",
+  "http_method": "DELETE"
+}

data/doc/api/admin/products/showing_a_product.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/\"51320d66d8e2e2aac087d23b86d930dc\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "9169dce1-be2a-4bbb-9f8f-689ea9d3d2d6",
+        "X-Runtime": "0.009984",
+        "Expires": "0",
+        "Content-Length": "690"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/products/D3CEB7D152",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"product\": {\n    \"_id\": \"D3CEB7D152\",\n    \"active\": true,\n    \"browser_title\": null,\n    \"copied_from_id\": null,\n    \"created_at\": \"2019-08-21T21:49:21.214Z\",\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-08-21T21:49:21.356Z\",\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-08-21T21:49:21.214Z\",\n    \"variants\": [\n      {\n        \"_id\": \"5d5dbc61d4322a4b69d78213\",\n        \"active\": true,\n        \"created_at\": null,\n        \"details\": {\n        },\n        \"name\": \"SKU\",\n        \"position\": 0,\n        \"sku\": \"SKU\",\n        \"updated_at\": null\n      }\n    ]\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/products/D3CEB7D152\" -X GET "
+    }
+  ],
+  "resource": "Products",
+  "description": "Showing a product",
+  "route": "/api/admin/products/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/products/updating_a_product.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": "c7fc80d5-6f01-4c93-8bfd-ab392aa87919",
+        "X-Runtime": "0.068570",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/products/CEF609C107",
+      "request_body": "{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.030Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.030Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78220\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}",
+      "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/CEF609C107\" -d '{\"active\":true,\"browser_title\":null,\"copied_from_id\":null,\"created_at\":\"2019-08-21T21:49:23.030Z\",\"customizations\":null,\"default_category_id\":null,\"description\":null,\"details\":{\"Material\":[\"Cotton\"],\"Style\":[\"12345\"]},\"digital\":false,\"filters\":{\"Material\":\"Cotton\",\"Style\":\"12345\"},\"meta_description\":null,\"name\":\"Test Product\",\"purchasable\":true,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:49:23.030Z\",\"variants\":[{\"_id\":\"5d5dbc63d4322a4b69d78220\",\"active\":true,\"created_at\":null,\"details\":{},\"name\":\"SKU\",\"position\":0,\"sku\":\"SKU\",\"updated_at\":null}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Products",
+  "description": "Updating a product",
+  "route": "/api/admin/products/:id",
+  "http_method": "PATCH"
+}

data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.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": "bbf3bf4c-26a6-466f-a440-3c0320e951ec",
+        "X-Runtime": "0.098335",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/promo_code_lists/bulk",
+      "request_body": "{\"promo_code_lists\":[{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"},{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"},{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"}]}",
+      "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/promo_code_lists/bulk\" -d '{\"promo_code_lists\":[{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"},{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"},{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.175Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.175Z\"}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Bulk upserting promo code lists",
+  "route": "/api/admin/promo_code_lists/bulk",
+  "http_method": "PATCH"
+}

data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json

@@ -0,0 +1,46 @@
+{
+  "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",
+        "Location": "/api/admin/promo_code_lists/5d5dbdbfd4322a4b69d79568",
+        "Content-Type": "application/json; charset=utf-8",
+        "ETag": "W/\"6c37c55d25d252dbfcb42d7aa71be9d6\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "190c02f2-bb68-4615-a65c-f48b9282c108",
+        "X-Runtime": "0.022360",
+        "Expires": "0",
+        "Content-Length": "231"
+      },
+      "request_method": "POST",
+      "request_path": "/api/admin/promo_code_lists",
+      "request_body": "{\"promo_code_list\":{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.829Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.829Z\"}}",
+      "request_content_type": "application/json",
+      "response_status": 201,
+      "response_status_text": "Created",
+      "response_body": "{\n  \"promo_code_list\": {\n    \"_id\": \"5d5dbdbfd4322a4b69d79568\",\n    \"count\": 2,\n    \"created_at\": \"2019-08-21T21:55:11.829Z\",\n    \"expires_at\": null,\n    \"generation_completed_at\": null,\n    \"name\": \"Test Code List\",\n    \"prefix\": null,\n    \"updated_at\": \"2019-08-21T21:55:11.829Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/admin/promo_code_lists\" -d '{\"promo_code_list\":{\"count\":2,\"created_at\":\"2019-08-21T21:55:11.829Z\",\"expires_at\":null,\"generation_completed_at\":null,\"name\":\"Test Code List\",\"prefix\":null,\"updated_at\":\"2019-08-21T21:55:11.829Z\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Creating a promo code list",
+  "route": "/api/admin/promo_code_lists",
+  "http_method": "POST"
+}

data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json

@@ -0,0 +1,58 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Current page"
+    },
+    {
+      "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": {
+        "page": "1",
+        "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",
+        "ETag": "W/\"ee4dbd3eeafe1197d78a5fa295bf6758\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "c683fe41-74d9-4477-af9b-2518b6e634ec",
+        "X-Runtime": "0.004723",
+        "Expires": "0",
+        "Content-Length": "490"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/promo_code_lists?page=1&sort_by=created_at&sort_direction=desc",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"promo_code_lists\": [\n    {\n      \"_id\": \"5d5dbdbdd4322a4b69d79533\",\n      \"count\": 2,\n      \"created_at\": \"2019-08-21T21:55:09.475Z\",\n      \"expires_at\": null,\n      \"generation_completed_at\": \"2019-08-21T21:55:09.482Z\",\n      \"name\": \"Test Code List\",\n      \"prefix\": null,\n      \"updated_at\": \"2019-08-21T21:55:09.484Z\"\n    },\n    {\n      \"_id\": \"5d5dbdbdd4322a4b69d79530\",\n      \"count\": 2,\n      \"created_at\": \"2019-08-21T21:55:09.460Z\",\n      \"expires_at\": null,\n      \"generation_completed_at\": \"2019-08-21T21:55:09.469Z\",\n      \"name\": \"Test Code List\",\n      \"prefix\": null,\n      \"updated_at\": \"2019-08-21T21:55:09.471Z\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/promo_code_lists?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Listing promo code lists",
+  "route": "/api/admin/promo_code_lists",
+  "http_method": "GET"
+}

data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.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": "48b9e7bb-7650-4d02-b4a3-4c64726a66aa",
+        "X-Runtime": "0.007371",
+        "Expires": "0"
+      },
+      "request_method": "DELETE",
+      "request_path": "/api/admin/promo_code_lists/5d5dbdc0d4322a4b69d79572",
+      "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/promo_code_lists/5d5dbdc0d4322a4b69d79572\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Removing a promo code list",
+  "route": "/api/admin/promo_code_lists/:id",
+  "http_method": "DELETE"
+}

data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.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/\"fc84d78d3504b0c482dcc83ce918f84e\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "22b952a3-d905-4a48-af91-ec82db188f20",
+        "X-Runtime": "0.004174",
+        "Expires": "0",
+        "Content-Length": "253"
+      },
+      "request_method": "GET",
+      "request_path": "/api/admin/promo_code_lists/5d5dbdbed4322a4b69d79539",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"promo_code_list\": {\n    \"_id\": \"5d5dbdbed4322a4b69d79539\",\n    \"count\": 2,\n    \"created_at\": \"2019-08-21T21:55:10.042Z\",\n    \"expires_at\": null,\n    \"generation_completed_at\": \"2019-08-21T21:55:10.049Z\",\n    \"name\": \"Test Code List\",\n    \"prefix\": null,\n    \"updated_at\": \"2019-08-21T21:55:10.052Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/admin/promo_code_lists/5d5dbdbed4322a4b69d79539\" -X GET "
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Showing a promo code list",
+  "route": "/api/admin/promo_code_lists/:id",
+  "http_method": "GET"
+}

data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.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": "f5e4592f-60b8-4871-bbf3-c05a4e6a4633",
+        "X-Runtime": "0.009116",
+        "Expires": "0"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/admin/promo_code_lists/5d5dbdbed4322a4b69d7953f",
+      "request_body": "{\"promo_code_list\":{\"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/promo_code_lists/5d5dbdbed4322a4b69d7953f\" -d '{\"promo_code_list\":{\"name\":\"foo\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Promo Code Lists",
+  "description": "Updating a promo code list",
+  "route": "/api/admin/promo_code_lists/:id",
+  "http_method": "PATCH"
+}