matthewvolk · github-actions · Feb 28, 2025
diff --git a/src/generated/category-trees_catalog.v3.ts b/src/generated/category-trees_catalog.v3.ts
@@ -29,7 +29,7 @@ export interface paths {
      * - 16,000 categories per store limit.
      * - 1,000 categories per product limit.
      * - 50 characters category name length.
-     * - 8 levels of category depth limit.
+     * - 8 levels of child categories depth limit.
      * - 65,535 characters category description length limit.
      *
      * Creating a category requires:
@@ -63,7 +63,8 @@ export interface paths {
      * This single endpoint updates and creates category trees. If a tree object contains an ID, it is processed as an update operation using that ID. If you do not provide an ID, a new tree is created. The category tree `name` field is required to create trees, but is not required on the update.
      *
      * **Usage Notes**
-     * * `channel_id` is required to create a category tree. You can assign one `channel_id` to one category tree.
+     * * Channel ID in the `channels` field is required to create a category tree. You can only assign a category tree to one channel.
+     * * The `channels` field must be absent when updating a category tree. This field is currently unsupported during a category tree update.
      */
     put: operations["upsertCategoryTrees"];
     /**
@@ -590,7 +591,7 @@ export interface operations {
    * - 16,000 categories per store limit.
    * - 1,000 categories per product limit.
    * - 50 characters category name length.
-   * - 8 levels of category depth limit.
+   * - 8 levels of child categories depth limit.
    * - 65,535 characters category description length limit.
    *
    * Creating a category requires:
@@ -707,7 +708,8 @@ export interface operations {
    * This single endpoint updates and creates category trees. If a tree object contains an ID, it is processed as an update operation using that ID. If you do not provide an ID, a new tree is created. The category tree `name` field is required to create trees, but is not required on the update.
    *
    * **Usage Notes**
-   * * `channel_id` is required to create a category tree. You can assign one `channel_id` to one category tree.
+   * * Channel ID in the `channels` field is required to create a category tree. You can only assign a category tree to one channel.
+   * * The `channels` field must be absent when updating a category tree. This field is currently unsupported during a category tree update.
    */
   upsertCategoryTrees: {
     parameters: {

diff --git a/src/generated/checkouts.v3.ts b/src/generated/checkouts.v3.ts
@@ -182,6 +182,9 @@ export interface paths {
     /**
      * Delete order level fees from a checkout.
      * @description Delete fees from a checkout.
+     *
+     * > #### Note
+     * > * The `Try It` feature is not currently supported for this endpoint.
      */
     delete: operations["CheckoutsFeesByCheckoutIdDelete"];
   };
@@ -1025,6 +1028,8 @@ export interface components {
       order_confirmation_use_custom_checkout_script?: boolean;
       custom_order_confirmation_script_url?: string;
       custom_checkout_supports_uco_settings?: boolean;
+      custom_checkout_sri_hash?: string;
+      custom_order_confirmation_sri_hash?: string;
     };
     /** Checkouts settings request */
     CheckoutsSettingsRequest: {
@@ -1036,6 +1041,10 @@ export interface components {
       custom_order_confirmation_script_url?: string;
       /** @description Boolean value that specifies whether this checkout supports Optimized One-Page Checkout settings. */
       custom_checkout_supports_uco_settings?: boolean;
+      /** @description The Subresource Integrity (SRI) hash for the custom checkout script URL. */
+      custom_checkout_sri_hash?: string;
+      /** @description The Subresource Integrity (SRI) hash for the custom order confirmation script URL. */
+      custom_order_confirmation_sri_hash?: string;
     };
     /** Pickup Option */
     PickupOption: {
@@ -1685,6 +1694,9 @@ export interface operations {
   /**
    * Delete order level fees from a checkout.
    * @description Delete fees from a checkout.
+   *
+   * > #### Note
+   * > * The `Try It` feature is not currently supported for this endpoint.
    */
   CheckoutsFeesByCheckoutIdDelete: {
     parameters: {

diff --git a/src/generated/orders.v2.oas2.ts b/src/generated/orders.v2.oas2.ts
@@ -1445,7 +1445,7 @@ export interface components {
        */
       base_wrapping_cost?: string;
       /**
-       * @description Shows where the order originated. The channel_id will default to 1.
+       * @description Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders` endpoints return a validation error.
        * @example 1
        */
       channel_id?: number;
@@ -2088,7 +2088,7 @@ export interface components {
       base_wrapping_cost?: string;
       billing_address?: components["schemas"]["billingAddress_Put"];
       /**
-       * @description Shows where the order originated. The channel_id will default to 1.
+       * @description Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders` endpoints return a validation error.
        * @example 1
        */
       channel_id?: number;

diff --git a/src/generated/orders.v3.ts b/src/generated/orders.v3.ts
@@ -2165,7 +2165,7 @@ export interface components {
     ContentType: string;
     /** @description Specifies the page number in a limited (paginated) list of products. */
     PageParam?: number;
-    /** @description Filter items by minimum datevcreated. For example, `date_created:min=2019-09-04T00:00:00` or `date_created:min=2019-09-04`. Returns metafields created after this date. */
+    /** @description Filter items by minimum date created. For example, `date_created:min=2019-09-04T00:00:00` or `date_created:min=2019-09-04`. Returns metafields created after this date. */
     date_created_min?: string;
     /** @description Filter items by maximum date created. For example, `date_created:max=2019-09-04T00:00:00` or `date_created:max=2019-09-04`. Returns metafields created before this date. */
     date_created_max?: string;

diff --git a/src/generated/pricing.sf.ts b/src/generated/pricing.sf.ts
@@ -11,6 +11,8 @@ export interface paths {
      * Get Prices (Batch)
      * @description Calculate batch pricing for products for a specific channel, currency, and customer group.
      *
+     * The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the [currency](https://support.bigcommerce.com/s/article/Managing-Currencies?language=en_US#add) settings page.
+     *
      * **Limits**
      * * Limit of 50 concurrent requests.
      */
@@ -427,6 +429,8 @@ export interface operations {
    * Get Prices (Batch)
    * @description Calculate batch pricing for products for a specific channel, currency, and customer group.
    *
+   * The rounded prices in this endpoint's response will align with the currency's decimal precision as defined in the [currency](https://support.bigcommerce.com/s/article/Managing-Currencies?language=en_US#add) settings page.
+   *
    * **Limits**
    * * Limit of 50 concurrent requests.
    */

diff --git a/src/generated/products_catalog.v3.ts b/src/generated/products_catalog.v3.ts
@@ -1126,6 +1126,7 @@ export interface components {
       /** @description Length of the video. This will be filled in according to data on a host site. */
       length?: string;
     };
+    IncludeParamBase: ("bulk_pricing_rules" | "reviews" | "modifiers" | "options" | "parent_relations" | "custom_fields" | "channels" | "videos")[];
     /**
      * product_Put
      * @description The model for a PUT to update a product.
@@ -3291,7 +3292,7 @@ export interface components {
     /** @description Sort direction. Acceptable values are: `asc`, `desc`. */
     DirectionParam?: "asc" | "desc";
     /** @description Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date. */
-    SortParam?: "id" | "name" | "sku" | "price" | "date_modified" | "date_last_imported" | "inventory_level" | "is_visible" | "total_sold";
+    SortParam?: "id" | "name" | "sku" | "price" | "date_modified" | "date_last_imported" | "inventory_level" | "is_visible" | "total_sold" | "calculated_price";
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
     IncludeFieldsBulkPricingParam?: ("quantity_min" | "quantity_max" | "type" | "amount")[];
     /** @description Fields to include, in a comma-separated list. The ID and the specified fields will be returned. */
@@ -3314,8 +3315,13 @@ export interface components {
     CategoriesInParam?: number[];
     /** @description Pass a comma-separated list to filter by one or more channel IDs. */
     ChannelIdInParam?: number[];
-    /** @description A comma-separated list of sub-resources to return with a product object. When you specify `options` or `modifiers`, results are limited to 10 per page. */
-    IncludeParam?: ("bulk_pricing_rules" | "reviews" | "modifiers" | "options" | "parent_relations" | "custom_fields" | "channels")[];
+    /**
+     * @description A comma-separated list of sub-resources to return with a product object.
+     * When you specify `options` or `modifiers`, results are limited to 10 per page.
+     */
+    IncludeParamGetProducts?: components["schemas"]["IncludeParamBase"];
+    /** @description A comma-separated list of sub-resources to return with a product object. */
+    IncludeParamGetProduct?: components["schemas"]["IncludeParamBase"];
     IdMinParam?: number;
     IdMaxParam?: number;
     IdGreaterParam?: number;
@@ -3429,7 +3435,7 @@ export interface operations {
         "id:in"?: components["parameters"]["IdInParam"];
         "channel_id:in"?: components["parameters"]["ChannelIdInParam"];
         "id:not_in"?: components["parameters"]["IdNotInParam"];
-        include?: components["parameters"]["IncludeParam"];
+        include?: components["parameters"]["IncludeParamGetProducts"];
         include_fields?: components["parameters"]["IncludeFieldsParam"];
         exclude_fields?: components["parameters"]["ExcludeFieldsParam"];
         page?: components["parameters"]["PageParam"];
@@ -3842,7 +3848,7 @@ export interface operations {
   getProduct: {
     parameters: {
       query?: {
-        include?: components["parameters"]["IncludeParam"];
+        include?: components["parameters"]["IncludeParamGetProduct"];
         include_fields?: components["parameters"]["IncludeFieldsParam"];
         exclude_fields?: components["parameters"]["ExcludeFieldsParam"];
       };

diff --git a/src/generated/segments.v3.ts b/src/generated/segments.v3.ts
@@ -43,6 +43,8 @@ export interface paths {
     /**
      * Get All Shopper Profiles in a Segment
      * @description Returns a list of *Shopper Profiles* that are associated with a given *Segment*.
+     *
+     * **NOTE**: The `modify` Customers OAuth scope is a requirement for this endpoint.
      */
     get: operations["GetSegmentProfiles"];
     /**
@@ -453,6 +455,8 @@ export interface operations {
   /**
    * Get All Shopper Profiles in a Segment
    * @description Returns a list of *Shopper Profiles* that are associated with a given *Segment*.
+   *
+   * **NOTE**: The `modify` Customers OAuth scope is a requirement for this endpoint.
    */
   GetSegmentProfiles: {
     parameters: {

diff --git a/src/generated/shipping.v3.ts b/src/generated/shipping.v3.ts
@@ -50,12 +50,12 @@ export interface paths {
   "/shipping/settings": {
     /**
      * Get Shipping Settings
-     * @description Get shipping settings.
+     * @description Returns the global-level shipping settings.
      */
     get: operations["getShippingSettings"];
     /**
      * Update Shipping Settings
-     * @description Updates shipping settings.
+     * @description Updates the global-level shipping settings.
      */
     put: operations["updateShippingSettings"];
     parameters: {
@@ -64,6 +64,27 @@ export interface paths {
       };
     };
   };
+  "/shipping/settings/channels/{channel_id}": {
+    /**
+     * Get Shipping Settings per Channel
+     * @description Returns shipping settings for a specific channel.
+     */
+    get: operations["getChannelShippingSettings"];
+    /**
+     * Update Shipping Settings per Channel
+     * @description Updates shipping settings for a specific channel.
+     */
+    put: operations["updateChannelShippingSettings"];
+    parameters: {
+      header: {
+        Accept: components["parameters"]["Accept"];
+      };
+      path: {
+        /** @description Channel ID */
+        channel_id: string;
+      };
+    };
+  };
 }
 
 export type webhooks = Record<string, never>;
@@ -111,7 +132,16 @@ export interface components {
          * @description Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria.
          * @example Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address.
          */
-        out_of_zone_delivery_message?: string;
+        out_of_delivery_zone_message?: string;
+      };
+    };
+    channelShippingSettings: {
+      checkout?: {
+        /**
+         * @description Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria.
+         * @example Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address.
+         */
+        out_of_delivery_zone_message?: string;
       };
     };
     /**
@@ -421,7 +451,7 @@ export interface operations {
   };
   /**
    * Get Shipping Settings
-   * @description Get shipping settings.
+   * @description Returns the global-level shipping settings.
    */
   getShippingSettings: {
     parameters: {
@@ -442,7 +472,7 @@ export interface operations {
   };
   /**
    * Update Shipping Settings
-   * @description Updates shipping settings.
+   * @description Updates the global-level shipping settings.
    */
   updateShippingSettings: {
     parameters: {
@@ -465,6 +495,104 @@ export interface operations {
           };
         };
       };
+      /** @description Bad Request. Input is invalid. */
+      400: {
+        content: {
+          "application/json": {
+            status?: number;
+            title?: string;
+            type?: string;
+            detail?: string;
+          };
+        };
+      };
+      /** @description The request body does not meet the specification. */
+      422: {
+        content: {
+          "application/json": {
+            status?: number;
+            title?: string;
+            type?: string;
+          };
+        };
+      };
+    };
+  };
+  /**
+   * Get Shipping Settings per Channel
+   * @description Returns shipping settings for a specific channel.
+   */
+  getChannelShippingSettings: {
+    parameters: {
+      header: {
+        Accept: components["parameters"]["Accept"];
+      };
+      path: {
+        /** @description Channel ID */
+        channel_id: string;
+      };
+    };
+    responses: {
+      200: {
+        content: {
+          "application/json": {
+            data?: components["schemas"]["channelShippingSettings"];
+            meta?: Record<string, never>;
+          };
+        };
+      };
+    };
+  };
+  /**
+   * Update Shipping Settings per Channel
+   * @description Updates shipping settings for a specific channel.
+   */
+  updateChannelShippingSettings: {
+    parameters: {
+      header: {
+        Accept: components["parameters"]["Accept"];
+        "Content-Type": components["parameters"]["ContentType"];
+      };
+      path: {
+        /** @description Channel ID */
+        channel_id: string;
+      };
+    };
+    requestBody?: {
+      content: {
+        "application/json": components["schemas"]["channelShippingSettings"];
+      };
+    };
+    responses: {
+      200: {
+        content: {
+          "application/json": {
+            data?: components["schemas"]["channelShippingSettings"];
+            meta?: Record<string, never>;
+          };
+        };
+      };
+      /** @description Bad Request. Input is invalid. */
+      400: {
+        content: {
+          "application/json": {
+            status?: number;
+            title?: string;
+            type?: string;
+            detail?: string;
+          };
+        };
+      };
+      /** @description The request body does not meet the specification. */
+      422: {
+        content: {
+          "application/json": {
+            status?: number;
+            title?: string;
+            type?: string;
+          };
+        };
+      };
     };
   };
 }