CHANGED_PATHS.md

Changes to documented REST API paths

This file serves as a record of changes to supported paths between this library and the @space48/bigcommerce-api it was adapted from.

Management V3

New paths

    | "PUT /checkouts/{checkoutId}"
    | "GET /payments/methods"
    | "GET /marketing/abandoned-cart-emails"
    | "POST /marketing/abandoned-cart-emails"
    | "GET /marketing/abandoned-cart-emails/{id}"
    | "PUT /marketing/abandoned-cart-emails/{id}"
    | "DELETE /marketing/abandoned-cart-emails/{id}"
    | "GET /marketing/abandoned-cart-emails/default"
    | "GET /marketing/abandoned-cart-emails/settings"
    | "PUT /marketing/abandoned-cart-emails/settings"
    | "GET /abandoned-carts/settings"
    | "PUT /abandoned-carts/settings"
    | "GET /abandoned-carts/settings/channels/{channel_id}"
    | "PUT /abandoned-carts/settings/channels/{channel_id}"
    | "GET /carts/settings"
    | "PUT /carts/settings"
    | "GET /carts/settings/channels/{channel_id}"
    | "PUT /carts/settings/channels/{channel_id}"
    | "GET /carts/{cart_id}/metafields"
    | "POST /carts/{cart_id}/metafields"
    | "GET /carts/{cart_id}/metafields/{metafield_id}"
    | "PUT /carts/{cart_id}/metafields/{metafield_id}"
    | "DELETE /carts/{cart_id}/metafields/{metafield_id}"
    | "GET /carts/metafields"
    | "POST /carts/metafields"
    | "PUT /carts/metafields"
    | "DELETE /carts/metafields"
    | "GET /catalog/brands/metafields"
    | "POST /catalog/brands/metafields"
    | "PUT /catalog/brands/metafields"
    | "DELETE /catalog/brands/metafields"
    | "GET /catalog/categories/metafields"
    | "POST /catalog/categories/metafields"
    | "PUT /catalog/categories/metafields"
    | "DELETE /catalog/categories/metafields"
    | "GET /catalog/trees/categories"
    | "POST /catalog/trees/categories"
    | "PUT /catalog/trees/categories"
    | "DELETE /catalog/trees/categories"
    | "GET /catalog/trees"
    | "PUT /catalog/trees"
    | "DELETE /catalog/trees"
    | "GET /catalog/trees/{tree_id}/categories"
    | "GET /catalog/variants/metafields"
    | "POST /catalog/variants/metafields"
    | "PUT /catalog/variants/metafields"
    | "DELETE /catalog/variants/metafields"
    | "GET /catalog/products/channel-assignments"
    | "PUT /catalog/products/channel-assignments"
    | "DELETE /catalog/products/channel-assignments"
    | "GET /catalog/products/category-assignments"
    | "PUT /catalog/products/category-assignments"
    | "DELETE /catalog/products/category-assignments"
    | "GET /catalog/products/metafields"
    | "POST /catalog/products/metafields"
    | "PUT /catalog/products/metafields"
    | "DELETE /catalog/products/metafields"
    | "PUT /channels/{channel_id}/site/checkout-url"
    | "DELETE /channels/{channel_id}/site/checkout-url"
    | "GET /channels/{channel_id}/channel-menus"
    | "POST /channels/{channel_id}/channel-menus"
    | "DELETE /channels/{channel_id}/channel-menus"
    | "GET /channels/{channel_id}/metafields"
    | "POST /channels/{channel_id}/metafields"
    | "GET /channels/{channel_id}/metafields/{metafield_id}"
    | "PUT /channels/{channel_id}/metafields/{metafield_id}"
    | "DELETE /channels/{channel_id}/metafields/{metafield_id}"
    | "GET /channels/metafields"
    | "POST /channels/metafields"
    | "PUT /channels/metafields"
    | "DELETE /channels/metafields"
    | "POST /checkouts/{checkoutId}/discounts"
    | "POST /checkouts/{checkoutId}/fees"
    | "PUT /checkouts/{checkoutId}/fees"
    | "DELETE /checkouts/{checkoutId}/fees"
    | "GET /checkouts/settings"
    | "PUT /checkouts/settings"
    | "POST /checkouts/{checkoutId}/token"
    | "GET /customers/{customerId}/metafields"
    | "POST /customers/{customerId}/metafields"
    | "GET /customers/{customerId}/metafields/{metafieldId}"
    | "PUT /customers/{customerId}/metafields/{metafieldId}"
    | "DELETE /customers/{customerId}/metafields/{metafieldId}"
    | "GET /customers/metafields"
    | "POST /customers/metafields"
    | "PUT /customers/metafields"
    | "DELETE /customers/metafields"
    | "PUT /inventory/adjustments/absolute"
    | "POST /inventory/adjustments/relative"
    | "GET /inventory/items"
    | "GET /inventory/locations/{location_id}/items"
    | "PUT /inventory/locations/{location_id}/items"
    | "GET /inventory/locations"
    | "POST /inventory/locations"
    | "PUT /inventory/locations"
    | "DELETE /inventory/locations"
    | "GET /inventory/locations/{location_id}/metafields"
    | "POST /inventory/locations/{location_id}/metafields"
    | "GET /inventory/locations/{location_id}/metafields/{metafield_id}"
    | "PUT /inventory/locations/{location_id}/metafields/{metafield_id}"
    | "DELETE /inventory/locations/{location_id}/metafields/{metafield_id}"
    | "GET /inventory/locations/metafields"
    | "POST /inventory/locations/metafields"
    | "PUT /inventory/locations/metafields"
    | "DELETE /inventory/locations/metafields"
    | "GET /orders/payment_actions/refunds/{refund_id}"
    | "GET /orders/settings"
    | "PUT /orders/settings"
    | "GET /orders/settings/channels/{channel_id}"
    | "PUT /orders/settings/channels/{channel_id}"
    | "GET /orders/metafields"
    | "POST /orders/metafields"
    | "PUT /orders/metafields"
    | "DELETE /orders/metafields"
    | "GET /content/page-widgets"
    | "POST /content/page-widgets"
    | "GET /content/pages/{pageId}"
    | "PUT /content/pages/{pageId}"
    | "DELETE /content/pages/{pageId}"
    | "POST /payments/access_tokens"
    | "GET /orders/pickups"
    | "POST /orders/pickups"
    | "PUT /orders/pickups"
    | "DELETE /orders/pickups"
    | "GET /pickup/methods"
    | "POST /pickup/methods"
    | "PUT /pickup/methods"
    | "DELETE /pickup/methods"
    | "POST /pickup/options"
    | "PUT /pricelists/records"
    | "PUT /pricelists/{price_list_id}/assignments"
    | "GET /promotions/settings"
    | "PUT /promotions/settings"
    | "GET /promotions"
    | "POST /promotions"
    | "DELETE /promotions"
    | "GET /promotions/{id}"
    | "PUT /promotions/{id}"
    | "DELETE /promotions/{id}"
    | "GET /promotions/{promotion_id}/codes"
    | "POST /promotions/{promotion_id}/codes"
    | "DELETE /promotions/{promotion_id}/codes"
    | "DELETE /promotions/{promotion_id}/codes/{code_id}"
    | "GET /storefront/redirects/imex/jobs"
    | "POST /storefront/redirects/imex/export"
    | "POST /storefront/redirects/imex/import"
    | "GET /storefront/redirects/imex/export/{uuid}/events"
    | "GET /storefront/redirects/imex/import/{uuid}/events"
    | "GET /storefront/redirects/imex/export/{uuid}/download"
    | "GET /segments"
    | "POST /segments"
    | "PUT /segments"
    | "DELETE /segments"
    | "GET /segments/{segmentId}/shopper-profiles"
    | "POST /segments/{segmentId}/shopper-profiles"
    | "DELETE /segments/{segmentId}/shopper-profiles"
    | "GET /shopper-profiles"
    | "POST /shopper-profiles"
    | "DELETE /shopper-profiles"
    | "GET /shopper-profiles/{shopperProfileId}/segments"
    | "GET /settings/analytics"
    | "GET /settings/analytics/{id}"
    | "PUT /settings/analytics/{id}"
    | "GET /settings/catalog"
    | "PUT /settings/catalog"
    | "POST /settings/favicon/image"
    | "GET /settings/inventory/notifications"
    | "PUT /settings/inventory/notifications"
    | "GET /settings/logo"
    | "PUT /settings/logo"
    | "POST /settings/logo/image"
    | "GET /settings/store/profile"
    | "PUT /settings/store/profile"
    | "GET /settings/storefront/category"
    | "PUT /settings/storefront/category"
    | "GET /settings/storefront/product"
    | "PUT /settings/storefront/product"
    | "GET /settings/storefront/security"
    | "PUT /settings/storefront/security"
    | "GET /settings/inventory"
    | "PUT /settings/inventory"
    | "GET /settings/store/units-of-measurement"
    | "PUT /settings/store/units-of-measurement"
    | "GET /shipping/settings"
    | "PUT /shipping/settings"
    | "GET /shipping/settings/channels/{channel_id}"
    | "PUT /shipping/settings/channels/{channel_id}"
    | "GET /sites/{site_id}/certificate"
    | "PUT /sites/{site_id}/certificate"
    | "GET /sites/certificates"
    | "GET /store/systemlogs"
    | "GET /tax/properties"
    | "POST /tax/properties"
    | "PUT /tax/properties"
    | "DELETE /tax/properties"
    | "GET /tax/products/properties"
    | "PUT /tax/products/properties"
    | "DELETE /tax/products/properties"
    | "GET /tax/zones"
    | "POST /tax/zones"
    | "PUT /tax/zones"
    | "DELETE /tax/zones"
    | "GET /tax/rates"
    | "POST /tax/rates"
    | "PUT /tax/rates"
    | "DELETE /tax/rates"
    | "GET /tax/settings"
    | "PUT /tax/settings"
    | "POST /tax/zonecheck"
    | "GET /hooks/{webhook_id}"
    | "PUT /hooks/{webhook_id}"
    | "DELETE /hooks/{webhook_id}"
    | "GET /hooks/admin"
    | "PUT /hooks/admin"
    | "POST /content/widget-templates/{uuid}/preview"

Removed paths

    | "DELETE /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image"
    | "GET /catalog/categories/tree"
    | "POST /orders/payment_actions/refunds"
    | "POST /orders/payment_actions/refund_quotes"
    | "DELETE /settings/email-statuses"
    | "DELETE /settings/search/filters/contexts"
    | "DELETE /settings/storefront/robotstxt"
    | "DELETE /settings/storefront/search"
    | "DELETE /settings/storefront/seo"
    | "DELETE /settings/storefront/status"
    | "GET /hooks/{id}"
    | "PUT /hooks/{id}"
    | "DELETE /hooks/{id}"

Management V3

New Paths

    | "GET /countries/{country_id}/states/{id}"
    | "GET /orders/{order_id}/consignments"
    | "GET /orders/{order_id}/consignments/shipping/{shipping_consignment_id}/shipping_quotes"
    | "GET /orders/{order_id}/fees"
    | "GET /store/metafields"
    | "POST /store/metafields"
    | "PUT /store/metafields"
    | "DELETE /store/metafields"
    | "GET /store/metafields/{metafieldId}"
    | "PUT /store/metafields/{metafieldId}"
    | "DELETE /store/metafields/{metafieldId}"

Removed Paths

    | "DELETE /customer_groups"
    | "GET /countries/{country_id}/states{id}"