workarea-api 4.4.6

data/doc/api/storefront/categories/showing_a_category.json

@@ -0,0 +1,64 @@
+{
+  "parameters": [
+    {
+      "name": "sort",
+      "description": "Sort by"
+    },
+    {
+      "name": "page",
+      "description": "Page number"
+    },
+    {
+      "name": ":facet_name",
+      "description": "Each facet setup on the category will have a corresponding parameter"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+        "page": "1",
+        "sort": "price_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",
+        "Date": "Wed, 21 Aug 2019 21:55:54 GMT",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "ETag": "W/\"4f3d9e26c6d9561c94674bb12088411a\"",
+        "X-Request-Id": "adc04a09-d91b-4110-b197-59a087a5db2b",
+        "X-Runtime": "0.028526",
+        "Expires": "0",
+        "Content-Length": "5026"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/categories/shirts?page=1&sort=price_desc",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbde9d4322a4b69d79948\",\n  \"name\": \"Shirts\",\n  \"slug\": \"shirts\",\n  \"url\": \"http://www.example.com/api/storefront/categories/shirts\",\n  \"browser_title\": \"Home - Mens - Shirts\",\n  \"meta_description\": \"Shop online for Workarea API products\",\n  \"sorts\": [\n    [\n      \"Featured\",\n      \"featured\"\n    ],\n    [\n      \"Top Sellers\",\n      \"top_sellers\"\n    ],\n    [\n      \"Most Popular\",\n      \"popularity\"\n    ],\n    [\n      \"Newest\",\n      \"newest\"\n    ],\n    [\n      \"Price, Low to High\",\n      \"price_asc\"\n    ],\n    [\n      \"Price, High to Low\",\n      \"price_desc\"\n    ]\n  ],\n  \"sort\": \"price_desc\",\n  \"breadcrumbs\": [\n    {\n      \"id\": \"5d5dbde9d4322a4b69d7994c\",\n      \"url\": \"/api/storefront/taxons/5d5dbde9d4322a4b69d7994c\",\n      \"name\": \"Home\",\n      \"depth\": 0,\n      \"navigable_url\": \"/\",\n      \"parent_id\": null,\n      \"parent_ids\": [\n\n      ],\n      \"position\": 0\n    },\n    {\n      \"id\": \"5d5dbde9d4322a4b69d7994b\",\n      \"url\": \"/api/storefront/taxons/5d5dbde9d4322a4b69d7994b\",\n      \"name\": \"Mens\",\n      \"depth\": 1,\n      \"navigable_url\": null,\n      \"parent_id\": \"5d5dbde9d4322a4b69d7994c\",\n      \"parent_ids\": [\n        \"5d5dbde9d4322a4b69d7994c\"\n      ],\n      \"position\": 0\n    },\n    {\n      \"id\": \"5d5dbde9d4322a4b69d7994d\",\n      \"url\": \"/api/storefront/taxons/5d5dbde9d4322a4b69d7994d\",\n      \"name\": \"Shirts\",\n      \"depth\": 2,\n      \"navigable_url\": \"http://www.example.com/api/storefront/categories/shirts\",\n      \"parent_id\": \"5d5dbde9d4322a4b69d7994b\",\n      \"parent_ids\": [\n        \"5d5dbde9d4322a4b69d7994c\",\n        \"5d5dbde9d4322a4b69d7994b\"\n      ],\n      \"position\": 0\n    }\n  ],\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbdead4322a4b69d7994e\",\n      \"type\": \"text\",\n      \"area\": \"above_results\",\n      \"data\": {\n        \"text\": \"text\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbdead4322a4b69d7994e\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbdead4322a4b69d7994e&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;text&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</div>\\n</div>\\n\"\n    },\n    {\n      \"id\": \"5d5dbdead4322a4b69d7994f\",\n      \"type\": \"text\",\n      \"area\": \"below_results\",\n      \"data\": {\n        \"text\": \"text\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbdead4322a4b69d7994f\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbdead4322a4b69d7994f&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;text&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</div>\\n</div>\\n\"\n    }\n  ],\n  \"first_page\": true,\n  \"second_page\": false,\n  \"last_page\": true,\n  \"page\": 1,\n  \"next_page\": null,\n  \"prev_page\": null,\n  \"per_page\": 20,\n  \"total_results\": 1,\n  \"total_pages\": 1,\n  \"facets\": [\n    {\n      \"type\": \"terms\",\n      \"name\": \"Size\",\n      \"display_name\": \"Size\",\n      \"results\": [\n        {\n          \"name\": \"Small\",\n          \"count\": 1\n        },\n        {\n          \"name\": \"Medium\",\n          \"count\": 1\n        },\n        {\n          \"name\": \"Large\",\n          \"count\": 1\n        }\n      ]\n    }\n  ],\n  \"products\": [\n    {\n      \"id\": \"698F65A27B\",\n      \"name\": \"Sweet Shirt\",\n      \"description\": null,\n      \"slug\": \"sweet-shirt\",\n      \"browser_title\": \"Sweet Shirt\",\n      \"meta_description\": null,\n      \"template\": \"generic\",\n      \"customizations\": null,\n      \"details\": {\n        \"size\": [\n          \"Small\"\n        ],\n        \"color\": [\n          \"Red\"\n        ]\n      },\n      \"digital\": false,\n      \"filters\": {\n        \"size\": [\n          \"Small\",\n          \"Medium\",\n          \"Large\"\n        ],\n        \"color\": \"Blue\"\n      },\n      \"purchasable\": true,\n      \"inventory_status\": \"\",\n      \"variants\": [\n        {\n          \"id\": \"5d5dbde9d4322a4b69d79946\",\n          \"name\": \"SKU\",\n          \"sku\": \"SKU\",\n          \"details\": {\n            \"color\": [\n              \"Blue\"\n            ]\n          }\n        }\n      ],\n      \"sell_min_price\": null,\n      \"sell_max_price\": {\n        \"cents\": 200.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"on_sale\": false,\n      \"original_min_price\": {\n        \"cents\": 200.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"original_max_price\": {\n        \"cents\": 200.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"images\": [\n        {\n          \"id\": \"5d5dbde9d4322a4b69d79947\",\n          \"option\": \"Blue\",\n          \"position\": 0,\n          \"primary\": true,\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/small.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/medium.jpg?c=0\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/small_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/medium_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/large_thumb.jpg?c=0\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/detail.jpg?c=0\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/super_zoom.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/favicon.jpg?c=0\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5dbde9d4322a4b69d79947/favicon_ico.jpg?c=0\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/categories/shirts?page=1&sort=price_desc\" -X GET "
+    }
+  ],
+  "resource": "Categories",
+  "description": "Showing a category",
+  "route": "/api/storefront/categories/:slug",
+  "explanation": "            This endpoint includes everything you need to render a category,\n            including any associated content, products, and filters.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/categories/showing_a_listing_of_categories.json

@@ -0,0 +1,55 @@
+{
+  "parameters": [
+    {
+      "name": "page",
+      "description": "Page number"
+    }
+  ],
+  "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",
+        "Date": "Wed, 21 Aug 2019 21:55:54 GMT",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "ETag": "W/\"05d38d1f97f462a1b9640dc566fe2b0c\"",
+        "X-Request-Id": "62b39080-9666-4d5a-855f-011a8589dfd2",
+        "X-Runtime": "0.007178",
+        "Expires": "0",
+        "Content-Length": "273"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/categories?page=1",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"categories\": [\n    {\n      \"id\": \"5d5dbdead4322a4b69d79953\",\n      \"name\": \"Shirts\",\n      \"slug\": \"shirts\",\n      \"url\": \"http://www.example.com/api/storefront/categories/shirts\"\n    },\n    {\n      \"id\": \"5d5dbdead4322a4b69d7995b\",\n      \"name\": \"Pants\",\n      \"slug\": \"pants\",\n      \"url\": \"http://www.example.com/api/storefront/categories/pants\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/categories?page=1\" -X GET "
+    }
+  ],
+  "resource": "Categories",
+  "description": "Showing a listing of categories",
+  "route": "/api/storefront/categories",
+  "explanation": "            This endpoint will give you a paginated list of all active\n            categories, that is, all categories that could be shown on the\n            storefront.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/checkout/completing_a_checkout.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"42c810ba3850b046095e8bc333af1006\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "eceea6b9-e6b8-4e6d-a68c-fb122c4199ed",
+        "X-Runtime": "1.190671",
+        "Expires": "0",
+        "Content-Length": "4695"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/checkouts/11BC06CCE9/complete",
+      "request_body": "{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"11BC06CCE9\",\n    \"url\": \"http://www.example.com/api/storefront/orders/11BC06CCE9\",\n    \"user_id\": null,\n    \"email\": \"susanb@workarea.com\",\n    \"placed_at\": \"2019-08-21T21:50:56.383Z\",\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5d5dbcbed4322a4b69d78746\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 2000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 2000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": \"Express\",\n    \"shipping_address\": {\n      \"id\": \"5d5dbcbed4322a4b69d78754\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": null,\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"billing_address\": {\n      \"id\": \"5d5dbcbed4322a4b69d7877e\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": null,\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"tenders\": [\n      {\n        \"type\": \"credit_card\",\n        \"amount\": {\n          \"cents\": 2000.0,\n          \"currency_iso\": \"USD\"\n        },\n        \"issuer\": \"Visa\",\n        \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n        \"month\": 3,\n        \"year\": 2021\n      }\n    ]\n  },\n  \"fulfillment\": {\n    \"status\": \"Open\",\n    \"packages\": [\n\n    ],\n    \"pending_items\": [\n      {\n        \"id\": \"5d5dbcbed4322a4b69d78746\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"canceled_items\": [\n\n    ]\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/checkouts/11BC06CCE9/complete\" -d '{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Checkout",
+  "description": "Completing a checkout",
+  "route": "/api/storefront/checkouts/:id/complete",
+  "explanation": "            This endpoint completes checkout and places the order. Payment\n            tender information is required at this point, and should be included\n            with this request.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/checkout/showing_a_checkout.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"1fd4cacfacd8de1bf7720c2176a554d8\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "223aad0c-661e-447a-b1c8-066d96b76314",
+        "X-Runtime": "0.068846",
+        "Expires": "0",
+        "Content-Length": "2900"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/checkouts/7F02FF7887/reset",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"7F02FF7887\",\n    \"url\": \"http://www.example.com/api/storefront/orders/7F02FF7887\",\n    \"user_id\": null,\n    \"email\": \"sbaker@workarea.com\",\n    \"placed_at\": null,\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5d5dbcc4d4322a4b69d788c3\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": null,\n    \"tenders\": [\n\n    ]\n  },\n  \"checkout\": {\n    \"url\": \"http://www.example.com/api/storefront/checkouts/7F02FF7887\",\n    \"started_at\": \"2019-08-21T21:51:00.607Z\",\n    \"shippable\": false,\n    \"complete\": false,\n    \"addresses\": {\n      \"complete\": false,\n      \"email\": \"sbaker@workarea.com\",\n      \"problems\": [\n\n      ],\n      \"billing_address\": {\n        \"id\": \"5d5dbcc4d4322a4b69d788d8\",\n        \"first_name\": null,\n        \"last_name\": null,\n        \"company\": null,\n        \"street\": null,\n        \"street_2\": null,\n        \"city\": null,\n        \"country\": null,\n        \"region\": null,\n        \"postal_code\": null,\n        \"phone_number\": null,\n        \"phone_extension\": null,\n        \"problems\": [\n\n        ]\n      }\n    },\n    \"shipping\": {\n      \"complete\": false,\n      \"problems\": [\n\n      ],\n      \"shipping_service\": null,\n      \"shipping_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"shipping_options\": [\n\n      ]\n    },\n    \"payment\": {\n      \"complete\": false,\n      \"problems\": [\n\n      ],\n      \"tenders\": [\n\n      ]\n    }\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/checkouts/7F02FF7887/reset\" -X GET "
+    }
+  ],
+  "resource": "Checkout",
+  "description": "Showing a checkout",
+  "route": "/api/storefront/checkouts/:id/reset",
+  "explanation": "            This endpoint resets the checkout by wiping all private information\n            from the order and it's associated models. Use it for handling\n            timeouts, logouts, and any other situation where you want to ensure\n            the safety of the customer's information.\n",
+  "http_method": "GET"
+}

data/doc/api/storefront/checkout/updating_a_checkout.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"10e6eea76af719b8e603be0298aeffc1\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "53434664-9214-4df8-a1b4-593e5138d195",
+        "X-Runtime": "1.576336",
+        "Expires": "0",
+        "Content-Length": "3978"
+      },
+      "request_method": "PATCH",
+      "request_path": "/api/storefront/checkouts/E6D1C6D0CA",
+      "request_body": "{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"order\": {\n    \"id\": \"E6D1C6D0CA\",\n    \"url\": \"http://www.example.com/api/storefront/orders/E6D1C6D0CA\",\n    \"user_id\": null,\n    \"email\": \"susanb@workarea.com\",\n    \"placed_at\": null,\n    \"canceled_at\": null,\n    \"promo_codes\": [\n\n    ],\n    \"requires_shipping\": true,\n    \"items\": [\n      {\n        \"id\": \"5d5dbcc2d4322a4b69d7881a\",\n        \"product_id\": \"VINTEE\",\n        \"sku\": \"VT001\",\n        \"quantity\": 2,\n        \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n        \"options\": {\n        },\n        \"customizations\": {\n        },\n        \"product_image\": {\n          \"urls\": [\n            {\n              \"type\": \"small\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"small_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"medium_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"large_thumb\",\n              \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"detail\",\n              \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"super_zoom\",\n              \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n            },\n            {\n              \"type\": \"favicon_ico\",\n              \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n            }\n          ]\n        },\n        \"pricing\": {\n          \"price_adjustments\": [\n            {\n              \"description\": \"Item Subtotal\",\n              \"discount\": false,\n              \"amount\": {\n                \"cents\": 1000.0,\n                \"currency_iso\": \"USD\"\n              }\n            }\n          ],\n          \"total_price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"on_sale\": false,\n          \"original_unit_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"original_price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          },\n          \"customized\": false,\n          \"customizations_unit_price\": {\n            \"cents\": 0.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      }\n    ],\n    \"pricing\": {\n      \"price_adjustments\": [\n\n      ],\n      \"shipping_total\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"tax_total\": {\n        \"cents\": 0.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"subtotal_price\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"total_price\": {\n        \"cents\": 2000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"paid_amount\": {\n        \"cents\": 2000.0,\n        \"currency_iso\": \"USD\"\n      }\n    },\n    \"shipping_service\": \"Express\",\n    \"shipping_address\": {\n      \"id\": \"5d5dbcc2d4322a4b69d78828\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": null,\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"billing_address\": {\n      \"id\": \"5d5dbcc2d4322a4b69d78852\",\n      \"first_name\": \"Susan\",\n      \"last_name\": \"Baker\",\n      \"company\": null,\n      \"street\": \"350 Fifth Avenue\",\n      \"street_2\": null,\n      \"city\": \"New York\",\n      \"country\": \"US\",\n      \"region\": \"NY\",\n      \"postal_code\": \"10118\",\n      \"phone_number\": \"6465552390\",\n      \"phone_extension\": null\n    },\n    \"tenders\": [\n\n    ]\n  },\n  \"checkout\": {\n    \"url\": \"http://www.example.com/api/storefront/checkouts/E6D1C6D0CA\",\n    \"started_at\": \"2019-08-21T21:50:58.314Z\",\n    \"shippable\": true,\n    \"complete\": false,\n    \"addresses\": {\n      \"complete\": true,\n      \"email\": \"susanb@workarea.com\",\n      \"problems\": [\n\n      ],\n      \"shipping_address\": {\n        \"id\": \"5d5dbcc2d4322a4b69d78828\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"350 Fifth Avenue\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": \"6465552390\",\n        \"phone_extension\": null,\n        \"problems\": [\n\n        ]\n      },\n      \"billing_address\": {\n        \"id\": \"5d5dbcc2d4322a4b69d78852\",\n        \"first_name\": \"Susan\",\n        \"last_name\": \"Baker\",\n        \"company\": null,\n        \"street\": \"350 Fifth Avenue\",\n        \"street_2\": null,\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"region\": \"NY\",\n        \"postal_code\": \"10118\",\n        \"phone_number\": \"6465552390\",\n        \"phone_extension\": null,\n        \"problems\": [\n\n        ]\n      }\n    },\n    \"shipping\": {\n      \"complete\": true,\n      \"problems\": [\n\n      ],\n      \"shipping_service\": \"Express\",\n      \"shipping_total\": {\n        \"cents\": 1000.0,\n        \"currency_iso\": \"USD\"\n      },\n      \"shipping_options\": [\n        {\n          \"name\": \"Standard\",\n          \"price\": {\n            \"cents\": 500.0,\n            \"currency_iso\": \"USD\"\n          }\n        },\n        {\n          \"name\": \"Express\",\n          \"price\": {\n            \"cents\": 1000.0,\n            \"currency_iso\": \"USD\"\n          }\n        },\n        {\n          \"name\": \"Overnight\",\n          \"price\": {\n            \"cents\": 2000.0,\n            \"currency_iso\": \"USD\"\n          }\n        }\n      ]\n    },\n    \"payment\": {\n      \"complete\": false,\n      \"problems\": [\n\n      ],\n      \"tenders\": [\n\n      ]\n    }\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/checkouts/E6D1C6D0CA\" -d '{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Checkout",
+  "description": "Updating a checkout",
+  "route": "/api/storefront/checkouts/:id",
+  "explanation": "            Use this endpoint to make updates to checkout. This will typically\n            mean setting addresses and shipping options for the checkout.\n",
+  "http_method": "PATCH"
+}

data/doc/api/storefront/contacts/creating_a_contact.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"76880827332a021ed329f2d9accad414\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "5aeaea80-91ae-4792-817c-c62039897f8e",
+        "X-Runtime": "0.027782",
+        "Expires": "0",
+        "Content-Length": "228"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/contacts",
+      "request_body": "{\"name\":\"Name\",\"email\":\"email@example.com\",\"order_id\":\"OrderID\",\"subject\":\"orders\",\"message\":\"Message\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"inquiry\": {\n    \"_id\": \"5d5dbcd7d4322a4b69d789ab\",\n    \"created_at\": \"2019-08-21T21:51:19.702Z\",\n    \"email\": \"email@example.com\",\n    \"message\": \"Message\",\n    \"name\": \"Name\",\n    \"order_id\": \"OrderID\",\n    \"subject\": \"orders\",\n    \"updated_at\": \"2019-08-21T21:51:19.702Z\"\n  }\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/contacts\" -d '{\"name\":\"Name\",\"email\":\"email@example.com\",\"order_id\":\"OrderID\",\"subject\":\"orders\",\"message\":\"Message\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Contacts",
+  "description": "Creating a contact",
+  "route": "/api/storefront/contacts",
+  "explanation": "            This endpoints creates a customer service inquiry on behalf of the\n            customer, and will send an email to the address in\n            Workarea.config.email_to\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/email_signups/creating_an_email_signup.json

@@ -0,0 +1,51 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+        "Content-Type": "application/json"
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"32291d1d507a8f6b0b38211a17edd5ab\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "b391b107-687a-4ab2-9b62-92697a27ada3",
+        "X-Runtime": "0.006754",
+        "Expires": "0",
+        "Content-Length": "61"
+      },
+      "request_method": "POST",
+      "request_path": "/api/storefront/email_signups",
+      "request_body": "{\"email\":\"email@example.com\"}",
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"id\": \"5d5dbdc5d4322a4b69d7959c\",\n  \"email\": \"email@example.com\"\n}",
+      "response_content_type": "application/json",
+      "curl": "curl \"https://www.example.com/api/storefront/email_signups\" -d '{\"email\":\"email@example.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
+    }
+  ],
+  "resource": "Email Signups",
+  "description": "Creating an email signup",
+  "route": "/api/storefront/email_signups",
+  "explanation": "            Use this endpoint to create an email signup. This will usually be\n            forwarded to an Email Service Provider, but Workarea will keep a\n            record of it just in case.\n",
+  "http_method": "POST"
+}

data/doc/api/storefront/email_signups/showing_an_email_signup_content.json

@@ -0,0 +1,50 @@
+{
+  "parameters": [
+
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_headers": {
+      },
+      "request_query_parameters": {
+      },
+      "response_headers": {
+        "X-Frame-Options": "SAMEORIGIN",
+        "X-XSS-Protection": "1; mode=block",
+        "X-Content-Type-Options": "nosniff",
+        "X-Download-Options": "noopen",
+        "X-Permitted-Cross-Domain-Policies": "none",
+        "Referrer-Policy": "strict-origin-when-cross-origin",
+        "Content-Type": "application/json; charset=utf-8",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Headers": "*",
+        "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
+        "X-Requested-With": "",
+        "Vary": "X-Requested-With, X-Flash-Messages",
+        "ETag": "W/\"96ed7403230af7f94fa75ae4616e8d73\"",
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        "X-Request-Id": "2c53a37f-32d4-412c-af96-1e50dd316d36",
+        "X-Runtime": "0.007337",
+        "Expires": "0",
+        "Content-Length": "900"
+      },
+      "request_method": "GET",
+      "request_path": "/api/storefront/email_signups",
+      "request_body": null,
+      "request_content_type": null,
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\n  \"title\": \"Sign up for our email list\",\n  \"content_blocks\": [\n    {\n      \"id\": \"5d5dbdc5d4322a4b69d7959f\",\n      \"type\": \"text\",\n      \"area\": \"default\",\n      \"data\": {\n        \"text\": \"Here is some administrated content\"\n      },\n      \"hidden_breakpoints\": [\n\n      ],\n      \"position\": 0,\n      \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5dbdc5d4322a4b69d7959f\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5dbdc5d4322a4b69d7959f&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Here is some administrated content&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Here is some administrated content</div>\\n</div>\\n\"\n    }\n  ]\n}",
+      "response_content_type": "application/json",
+      "curl": "curl -g \"https://www.example.com/api/storefront/email_signups\" -X GET "
+    }
+  ],
+  "resource": "Email Signups",
+  "description": "Showing an email signup content",
+  "route": "/api/storefront/email_signups",
+  "explanation": "            This endpoint will return all relevant data for showing an email\n            sign up form.\n",
+  "http_method": "GET"
+}