workarea-api 4.4.6

data/doc/api/admin/index.json

@@ -0,0 +1,1219 @@
+{
+  "resources": [
+    {
+      "name": "Categories",
+      "examples": [
+        {
+          "description": "Creating a category",
+          "link": "admin/categories/creating_a_category.json",
+          "groups": "all",
+          "route": "/api/admin/categories",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a category",
+          "link": "admin/categories/updating_a_category.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a category",
+          "link": "admin/categories/removing_a_category.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Showing a category",
+          "link": "admin/categories/showing_a_category.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Bulk upserting categories",
+          "link": "admin/categories/bulk_upserting_categories.json",
+          "groups": "all",
+          "route": "/api/admin/categories/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing categories",
+          "link": "admin/categories/listing_categories.json",
+          "groups": "all",
+          "route": "/api/admin/categories",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Payment Profiles",
+      "examples": [
+        {
+          "description": "Listing payment profiles",
+          "link": "admin/payment_profiles/listing_payment_profiles.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles",
+          "method": "GET"
+        },
+        {
+          "description": "Showing a payment profile",
+          "link": "admin/payment_profiles/showing_a_payment_profile.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a payment profile",
+          "link": "admin/payment_profiles/removing_a_payment_profile.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Creating a payment profile",
+          "link": "admin/payment_profiles/creating_a_payment_profile.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a payment profiles",
+          "link": "admin/payment_profiles/updating_a_payment_profiles.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Bulk upserting payment profiles",
+          "link": "admin/payment_profiles/bulk_upserting_payment_profiles.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/bulk",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Shipping Services",
+      "examples": [
+        {
+          "description": "Bulk upserting shipping_services",
+          "link": "admin/shipping_services/bulk_upserting_shipping_services.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a shipping_service",
+          "link": "admin/shipping_services/removing_a_shipping_service.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Creating a shipping_service",
+          "link": "admin/shipping_services/creating_a_shipping_service.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a shipping_service",
+          "link": "admin/shipping_services/updating_a_shipping_service.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing shipping_services",
+          "link": "admin/shipping_services/listing_shipping_services.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services",
+          "method": "GET"
+        },
+        {
+          "description": "Showing a shipping_service",
+          "link": "admin/shipping_services/showing_a_shipping_service.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Discounts",
+      "examples": [
+        {
+          "description": "Listing discounts",
+          "link": "admin/discounts/listing_discounts.json",
+          "groups": "all",
+          "route": "/api/admin/discounts",
+          "method": "GET"
+        },
+        {
+          "description": "Updating discounts",
+          "link": "admin/discounts/updating_discounts.json",
+          "groups": "all",
+          "route": "/api/admin/discounts/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Showing a discount",
+          "link": "admin/discounts/showing_a_discount.json",
+          "groups": "all",
+          "route": "/api/admin/discounts/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a discount",
+          "link": "admin/discounts/creating_a_discount.json",
+          "groups": "all",
+          "route": "/api/admin/discounts",
+          "method": "POST"
+        },
+        {
+          "description": "Removing a discount",
+          "link": "admin/discounts/removing_a_discount.json",
+          "groups": "all",
+          "route": "/api/admin/discounts/:id",
+          "method": "DELETE"
+        }
+      ]
+    },
+    {
+      "name": "Email Signups",
+      "examples": [
+        {
+          "description": "Listing email signups",
+          "link": "admin/email_signups/listing_email_signups.json",
+          "groups": "all",
+          "route": "/api/admin/email_signups",
+          "method": "GET"
+        },
+        {
+          "description": "Showing an email signup",
+          "link": "admin/email_signups/showing_an_email_signup.json",
+          "groups": "all",
+          "route": "/api/admin/email_signups/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Pricing SKUs",
+      "examples": [
+        {
+          "description": "Creating an pricing SKU",
+          "link": "admin/pricing_skus/creating_an_pricing_sku.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus",
+          "method": "POST"
+        },
+        {
+          "description": "Showing an pricing SKU",
+          "link": "admin/pricing_skus/showing_an_pricing_sku.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Updating an pricing SKU",
+          "link": "admin/pricing_skus/updating_an_pricing_sku.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing an pricing SKU",
+          "link": "admin/pricing_skus/removing_an_pricing_sku.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Bulk upserting pricing SKUs",
+          "link": "admin/pricing_skus/bulk_upserting_pricing_skus.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing pricing SKUs",
+          "link": "admin/pricing_skus/listing_pricing_skus.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Navigation menus",
+      "examples": [
+        {
+          "description": "Showing a navigation menu",
+          "link": "admin/navigation_menus/showing_a_navigation_menu.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_menus/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Listing menus",
+          "link": "admin/navigation_menus/listing_menus.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_menus",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a navigation menus",
+          "link": "admin/navigation_menus/updating_a_navigation_menus.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_menus/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating a menu",
+          "link": "admin/navigation_menus/creating_a_menu.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_menus",
+          "method": "POST"
+        },
+        {
+          "description": "Removing a navigation menu",
+          "link": "admin/navigation_menus/removing_a_navigation_menu.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_menus/:id",
+          "method": "DELETE"
+        }
+      ]
+    },
+    {
+      "name": "Navigation taxonomy",
+      "examples": [
+        {
+          "description": "Creating a taxon",
+          "link": "admin/navigation_taxonomy/creating_a_taxon.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons",
+          "method": "POST"
+        },
+        {
+          "description": "Listing taxons",
+          "link": "admin/navigation_taxonomy/listing_taxons.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons",
+          "method": "GET"
+        },
+        {
+          "description": "Bulk upserting navigation taxons",
+          "link": "admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Updating a navigation taxons",
+          "link": "admin/navigation_taxonomy/updating_a_navigation_taxons.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a navigation taxon",
+          "link": "admin/navigation_taxonomy/removing_a_navigation_taxon.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Showing a navigation taxon",
+          "link": "admin/navigation_taxonomy/showing_a_navigation_taxon.json",
+          "groups": "all",
+          "route": "/api/admin/navigation_taxons/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Payment transactions",
+      "examples": [
+        {
+          "description": "Showing a payment transaction",
+          "link": "admin/payment_transactions/showing_a_payment_transaction.json",
+          "groups": "all",
+          "route": "/api/admin/payment_transactions/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Listing payment transactions",
+          "link": "admin/payment_transactions/listing_payment_transactions.json",
+          "groups": "all",
+          "route": "/api/admin/payment_transactions",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Tax Categories",
+      "examples": [
+        {
+          "description": "Bulk upserting tax categories",
+          "link": "admin/tax_categories/bulk_upserting_tax_categories.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing tax categories",
+          "link": "admin/tax_categories/listing_tax_categories.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a tax category",
+          "link": "admin/tax_categories/removing_a_tax_category.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Showing a tax category",
+          "link": "admin/tax_categories/showing_a_tax_category.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a tax category",
+          "link": "admin/tax_categories/creating_a_tax_category.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a tax categories",
+          "link": "admin/tax_categories/updating_a_tax_categories.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:id",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Category Product Rules",
+      "examples": [
+        {
+          "description": "Listing category product rules",
+          "link": "admin/category_product_rules/listing_category_product_rules.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:category_id/product_rules",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a category product rule",
+          "link": "admin/category_product_rules/creating_a_category_product_rule.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:category_id/product_rules",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a category product rule",
+          "link": "admin/category_product_rules/updating_a_category_product_rule.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:category_id/product_rules/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a category product rule",
+          "link": "admin/category_product_rules/removing_a_category_product_rule.json",
+          "groups": "all",
+          "route": "/api/admin/categories/:category_id/product_rules/:id",
+          "method": "DELETE"
+        }
+      ]
+    },
+    {
+      "name": "Prices",
+      "examples": [
+        {
+          "description": "Listing pricing sku prices",
+          "link": "admin/prices/listing_pricing_sku_prices.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a pricing sku price",
+          "link": "admin/prices/removing_a_pricing_sku_price.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Creating a pricing sku price",
+          "link": "admin/prices/creating_a_pricing_sku_price.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a pricing sku price",
+          "link": "admin/prices/updating_a_pricing_sku_price.json",
+          "groups": "all",
+          "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Orders",
+      "examples": [
+        {
+          "description": "Listing orders",
+          "link": "admin/orders/listing_orders.json",
+          "groups": "all",
+          "route": "/api/admin/orders",
+          "method": "GET"
+        },
+        {
+          "description": "Viewing orders by date range",
+          "link": "admin/orders/viewing_orders_by_date_range.json",
+          "groups": "all",
+          "route": "/api/admin/orders",
+          "method": "GET"
+        },
+        {
+          "description": "Showing an order",
+          "link": "admin/orders/showing_an_order.json",
+          "groups": "all",
+          "route": "/api/admin/orders/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Pages",
+      "examples": [
+        {
+          "description": "Updating a page",
+          "link": "admin/pages/updating_a_page.json",
+          "groups": "all",
+          "route": "/api/admin/pages/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Bulk upserting pages",
+          "link": "admin/pages/bulk_upserting_pages.json",
+          "groups": "all",
+          "route": "/api/admin/pages/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a page",
+          "link": "admin/pages/removing_a_page.json",
+          "groups": "all",
+          "route": "/api/admin/pages/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Showing a page",
+          "link": "admin/pages/showing_a_page.json",
+          "groups": "all",
+          "route": "/api/admin/pages/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a page",
+          "link": "admin/pages/creating_a_page.json",
+          "groups": "all",
+          "route": "/api/admin/pages",
+          "method": "POST"
+        },
+        {
+          "description": "Listing pages",
+          "link": "admin/pages/listing_pages.json",
+          "groups": "all",
+          "route": "/api/admin/pages",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Saved Addresses",
+      "examples": [
+        {
+          "description": "Creating a saved address",
+          "link": "admin/saved_addresses/creating_a_saved_address.json",
+          "groups": "all",
+          "route": "/api/admin/users/:user_id/saved_addresses",
+          "method": "POST"
+        },
+        {
+          "description": "Updating a saved address",
+          "link": "admin/saved_addresses/updating_a_saved_address.json",
+          "groups": "all",
+          "route": "/api/admin/users/:user_id/saved_addresses/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a saved address",
+          "link": "admin/saved_addresses/removing_a_saved_address.json",
+          "groups": "all",
+          "route": "/api/admin/users/:user_id/saved_addresses/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Listing saved address",
+          "link": "admin/saved_addresses/listing_saved_address.json",
+          "groups": "all",
+          "route": "/api/admin/users/:user_id/saved_addresses",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Tax Rates",
+      "examples": [
+        {
+          "description": "Listing tax rates",
+          "link": "admin/tax_rates/listing_tax_rates.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:tax_category_id/rates",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a tax rate",
+          "link": "admin/tax_rates/removing_a_tax_rate.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Updating a tax rate",
+          "link": "admin/tax_rates/updating_a_tax_rate.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating a tax rate",
+          "link": "admin/tax_rates/creating_a_tax_rate.json",
+          "groups": "all",
+          "route": "/api/admin/tax_categories/:tax_category_id/rates",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Product Images",
+      "examples": [
+        {
+          "description": "Updating a product image",
+          "link": "admin/product_images/updating_a_product_image.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/images/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing product images",
+          "link": "admin/product_images/listing_product_images.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/images",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a product image",
+          "link": "admin/product_images/removing_a_product_image.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/images/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Creating a product image from URL",
+          "link": "admin/product_images/creating_a_product_image_from_url.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/images",
+          "method": "POST"
+        },
+        {
+          "description": "Creating a product image from Base64",
+          "link": "admin/product_images/creating_a_product_image_from_base64.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/images",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Fulfillment",
+      "examples": [
+        {
+          "description": "Showing fulfillment",
+          "link": "admin/fulfillment/showing_fulfillment.json",
+          "groups": "all",
+          "route": "/api/admin/fulfillments/:order_id",
+          "method": "GET"
+        },
+        {
+          "description": "Listing fulfillments",
+          "link": "admin/fulfillment/listing_fulfillments.json",
+          "groups": "all",
+          "route": "/api/admin/fulfillments",
+          "method": "GET"
+        },
+        {
+          "description": "Marking items as canceled",
+          "link": "admin/fulfillment/marking_items_as_canceled.json",
+          "groups": "all",
+          "route": "/api/admin/fulfillments/:order_id/cancel_items",
+          "method": "POST"
+        },
+        {
+          "description": "Marking items as shipped",
+          "link": "admin/fulfillment/marking_items_as_shipped.json",
+          "groups": "all",
+          "route": "/api/admin/fulfillments/:order_id/ship_items",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Content Assets",
+      "examples": [
+        {
+          "description": "Removing a content asset",
+          "link": "admin/content_assets/removing_a_content_asset.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Bulk upserting content assets",
+          "link": "admin/content_assets/bulk_upserting_content_assets.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing content assets",
+          "link": "admin/content_assets/listing_content_assets.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a content asset",
+          "link": "admin/content_assets/updating_a_content_asset.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Showing a content asset",
+          "link": "admin/content_assets/showing_a_content_asset.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a content asset",
+          "link": "admin/content_assets/creating_a_content_asset.json",
+          "groups": "all",
+          "route": "/api/admin/content_assets",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Release Changes",
+      "examples": [
+        {
+          "description": "Adding changes to a release",
+          "link": "admin/release_changes/adding_changes_to_a_release.json",
+          "groups": "all",
+          "route": "/api/admin/products/:id",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Promo Code Lists",
+      "examples": [
+        {
+          "description": "Bulk upserting promo code lists",
+          "link": "admin/promo_code_lists/bulk_upserting_promo_code_lists.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing promo code lists",
+          "link": "admin/promo_code_lists/listing_promo_code_lists.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a promo code list",
+          "link": "admin/promo_code_lists/creating_a_promo_code_list.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists",
+          "method": "POST"
+        },
+        {
+          "description": "Showing a promo code list",
+          "link": "admin/promo_code_lists/showing_a_promo_code_list.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a promo code list",
+          "link": "admin/promo_code_lists/updating_a_promo_code_list.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a promo code list",
+          "link": "admin/promo_code_lists/removing_a_promo_code_list.json",
+          "groups": "all",
+          "route": "/api/admin/promo_code_lists/:id",
+          "method": "DELETE"
+        }
+      ]
+    },
+    {
+      "name": "Variants",
+      "examples": [
+        {
+          "description": "Creating a product variant",
+          "link": "admin/variants/creating_a_product_variant.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/variants",
+          "method": "POST"
+        },
+        {
+          "description": "Removing a product variant",
+          "link": "admin/variants/removing_a_product_variant.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/variants/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Updating a product variant",
+          "link": "admin/variants/updating_a_product_variant.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/variants/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing product variants",
+          "link": "admin/variants/listing_product_variants.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/variants",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Payments",
+      "examples": [
+        {
+          "description": "Listing payments",
+          "link": "admin/payments/listing_payments.json",
+          "groups": "all",
+          "route": "/api/admin/payments",
+          "method": "GET"
+        },
+        {
+          "description": "Showing an payment",
+          "link": "admin/payments/showing_an_payment.json",
+          "groups": "all",
+          "route": "/api/admin/payments/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Products",
+      "examples": [
+        {
+          "description": "Removing a product",
+          "link": "admin/products/removing_a_product.json",
+          "groups": "all",
+          "route": "/api/admin/products/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Updating a product",
+          "link": "admin/products/updating_a_product.json",
+          "groups": "all",
+          "route": "/api/admin/products/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Showing a product",
+          "link": "admin/products/showing_a_product.json",
+          "groups": "all",
+          "route": "/api/admin/products/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Listing products",
+          "link": "admin/products/listing_products.json",
+          "groups": "all",
+          "route": "/api/admin/products",
+          "method": "GET"
+        },
+        {
+          "description": "Creating a product",
+          "link": "admin/products/creating_a_product.json",
+          "groups": "all",
+          "route": "/api/admin/products",
+          "method": "POST"
+        },
+        {
+          "description": "Bulk upserting products",
+          "link": "admin/products/bulk_upserting_products.json",
+          "groups": "all",
+          "route": "/api/admin/products/bulk",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Shipping Rates",
+      "examples": [
+        {
+          "description": "Updating a shipping rate",
+          "link": "admin/shipping_rates/updating_a_shipping_rate.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating a shipping rate",
+          "link": "admin/shipping_rates/creating_a_shipping_rate.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:shipping_service_id/rates",
+          "method": "POST"
+        },
+        {
+          "description": "Listing shipping rates",
+          "link": "admin/shipping_rates/listing_shipping_rates.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:shipping_service_id/rates",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a shipping rate",
+          "link": "admin/shipping_rates/removing_a_shipping_rate.json",
+          "groups": "all",
+          "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
+          "method": "DELETE"
+        }
+      ]
+    },
+    {
+      "name": "Recommendation Settings",
+      "examples": [
+        {
+          "description": "Showing recommendation settings",
+          "link": "admin/recommendation_settings/showing_recommendation_settings.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/recommendation_settings",
+          "method": "GET"
+        },
+        {
+          "description": "Updating recommendation settings",
+          "link": "admin/recommendation_settings/updating_recommendation_settings.json",
+          "groups": "all",
+          "route": "/api/admin/products/:product_id/recommendation_settings",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Saved Credit Cards",
+      "examples": [
+        {
+          "description": "Removing a saved credit card",
+          "link": "admin/saved_credit_cards/removing_a_saved_credit_card.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Listing saved credit cards",
+          "link": "admin/saved_credit_cards/listing_saved_credit_cards.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a saved credit card",
+          "link": "admin/saved_credit_cards/updating_a_saved_credit_card.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating a saved credit card",
+          "link": "admin/saved_credit_cards/creating_a_saved_credit_card.json",
+          "groups": "all",
+          "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Content",
+      "examples": [
+        {
+          "description": "Listing content",
+          "link": "admin/content/listing_content.json",
+          "groups": "all",
+          "route": "/api/admin/content",
+          "method": "POST"
+        },
+        {
+          "description": "Showing content",
+          "link": "admin/content/showing_content.json",
+          "groups": "all",
+          "route": "/api/admin/content/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Bulk upserting content",
+          "link": "admin/content/bulk_upserting_content.json",
+          "groups": "all",
+          "route": "/api/admin/content/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating content",
+          "link": "admin/content/creating_content.json",
+          "groups": "all",
+          "route": "/api/admin/content",
+          "method": "POST"
+        },
+        {
+          "description": "Updating content",
+          "link": "admin/content/updating_content.json",
+          "groups": "all",
+          "route": "/api/admin/content/:id",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Releases",
+      "examples": [
+        {
+          "description": "Listing releases",
+          "link": "admin/releases/listing_releases.json",
+          "groups": "all",
+          "route": "/api/admin/releases",
+          "method": "GET"
+        },
+        {
+          "description": "Showing a release",
+          "link": "admin/releases/showing_a_release.json",
+          "groups": "all",
+          "route": "/api/admin/releases/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a release",
+          "link": "admin/releases/updating_a_release.json",
+          "groups": "all",
+          "route": "/api/admin/releases/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Bulk upserting releases",
+          "link": "admin/releases/bulk_upserting_releases.json",
+          "groups": "all",
+          "route": "/api/admin/releases/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a release",
+          "link": "admin/releases/removing_a_release.json",
+          "groups": "all",
+          "route": "/api/admin/releases/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Creating a release",
+          "link": "admin/releases/creating_a_release.json",
+          "groups": "all",
+          "route": "/api/admin/releases",
+          "method": "POST"
+        }
+      ]
+    },
+    {
+      "name": "Users",
+      "examples": [
+        {
+          "description": "Creating a user",
+          "link": "admin/users/creating_a_user.json",
+          "groups": "all",
+          "route": "/api/admin/users",
+          "method": "POST"
+        },
+        {
+          "description": "Bulk upserting users",
+          "link": "admin/users/bulk_upserting_users.json",
+          "groups": "all",
+          "route": "/api/admin/users/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing a user",
+          "link": "admin/users/removing_a_user.json",
+          "groups": "all",
+          "route": "/api/admin/users/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Showing a user",
+          "link": "admin/users/showing_a_user.json",
+          "groups": "all",
+          "route": "/api/admin/users/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Listing users",
+          "link": "admin/users/listing_users.json",
+          "groups": "all",
+          "route": "/api/admin/users",
+          "method": "GET"
+        },
+        {
+          "description": "Updating a user",
+          "link": "admin/users/updating_a_user.json",
+          "groups": "all",
+          "route": "/api/admin/users/:id",
+          "method": "PATCH"
+        }
+      ]
+    },
+    {
+      "name": "Inventory SKUs",
+      "examples": [
+        {
+          "description": "Updating an inventory SKU",
+          "link": "admin/inventory_skus/updating_an_inventory_sku.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Removing an inventory SKU",
+          "link": "admin/inventory_skus/removing_an_inventory_sku.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus/:id",
+          "method": "DELETE"
+        },
+        {
+          "description": "Bulk upserting inventory SKUs",
+          "link": "admin/inventory_skus/bulk_upserting_inventory_skus.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating an inventory SKU",
+          "link": "admin/inventory_skus/creating_an_inventory_sku.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus",
+          "method": "POST"
+        },
+        {
+          "description": "Listing inventory SKUs",
+          "link": "admin/inventory_skus/listing_inventory_skus.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus",
+          "method": "GET"
+        },
+        {
+          "description": "Showing an inventory SKU",
+          "link": "admin/inventory_skus/showing_an_inventory_sku.json",
+          "groups": "all",
+          "route": "/api/admin/inventory_skus/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Shipping",
+      "examples": [
+        {
+          "description": "Listing shipments",
+          "link": "admin/shipping/listing_shipments.json",
+          "groups": "all",
+          "route": "/api/admin/shippings",
+          "method": "GET"
+        },
+        {
+          "description": "Showing a shipment",
+          "link": "admin/shipping/showing_a_shipment.json",
+          "groups": "all",
+          "route": "/api/admin/shippings/:id",
+          "method": "GET"
+        }
+      ]
+    },
+    {
+      "name": "Redirects",
+      "examples": [
+        {
+          "description": "Updating a redirects",
+          "link": "admin/redirects/updating_a_redirects.json",
+          "groups": "all",
+          "route": "/api/admin/redirects/:id",
+          "method": "PATCH"
+        },
+        {
+          "description": "Listing redirects",
+          "link": "admin/redirects/listing_redirects.json",
+          "groups": "all",
+          "route": "/api/admin/redirects",
+          "method": "GET"
+        },
+        {
+          "description": "Bulk upserting redirects",
+          "link": "admin/redirects/bulk_upserting_redirects.json",
+          "groups": "all",
+          "route": "/api/admin/redirects/bulk",
+          "method": "PATCH"
+        },
+        {
+          "description": "Creating a redirect",
+          "link": "admin/redirects/creating_a_redirect.json",
+          "groups": "all",
+          "route": "/api/admin/redirects",
+          "method": "POST"
+        },
+        {
+          "description": "Showing a redirect",
+          "link": "admin/redirects/showing_a_redirect.json",
+          "groups": "all",
+          "route": "/api/admin/redirects/:id",
+          "method": "GET"
+        },
+        {
+          "description": "Removing a redirect",
+          "link": "admin/redirects/removing_a_redirect.json",
+          "groups": "all",
+          "route": "/api/admin/redirects/:id",
+          "method": "DELETE"
+        }
+      ]
+    }
+  ]
+}