Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 9fb33bf8c337 · 2025-06-25T11:05:02.000Z
diff --git a/api-specs/api/resources/carts.raml b/api-specs/api/resources/carts.raml
@@ -52,11 +52,18 @@ post:
   post:
     displayName: Replicate cart
     description: |
-      Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order.
+      Creates a new Cart by replicating an existing Cart or Order.
 
-      The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` [CartState](ctp:api:type:CartState).
+      The following applies to the new Cart:
 
-      The new Cart does not contain Payments or Deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`.
+      - It contains the same Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the originating Cart or Order.
+      - If a Line Item becomes invalid, it is removed from the new Cart. A common reason for this is removed Products or Prices.
+      - Line items and Custom Line Items are reset to their initial [state](/projects/carts#itemstate).
+      - It contains no payments or delivery information.
+      - It contains up-to-date Tax Rates, Prices, and Line Item product data.
+      - The [CartState](/projects/carts#cartstate) is `Active`.
+      - If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices.
+      - If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a [direct update action](/projects/carts#update-actions).
 
       Specific Error Codes:
 
diff --git a/api-specs/api/resources/in-store.raml b/api-specs/api/resources/in-store.raml
@@ -229,11 +229,18 @@ uriParameters:
     post:
       displayName: Replicate Cart in Store
       description: |
-        Creates a new Cart by replicating an existing Cart or Order. Can be useful in cases where a customer wants to cancel a recent order to make some changes or reorder a previous order.
+        Creates a new Cart in a [Store](ctp:api:type:Store) by replicating an existing Cart or Order.
 
-        The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` [CartState](ctp:api:type:CartState).
+        The following applies to the new Cart:
 
-        The new Cart does not contain payments or deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`.
+        - It contains the same Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the originating Cart or Order.
+        - If a Line Item becomes invalid, it is removed from the new Cart. A common reason for this is removed Products or Prices.
+        - Line items and Custom Line Items are reset to their initial [state](/projects/carts#itemstate).
+        - It contains no payments or delivery information.
+        - It contains up-to-date Tax Rates, Prices, and Line Item product data.
+        - The [CartState](/projects/carts#cartstate) is `Active`.
+        - If using the `customerGroup` field (for a single Customer Group) and the referenced Customer switched to another Customer Group, the new Cart is automatically updated to reflect the new group and corresponding prices.
+        - If using the `customerGroupAssignments` field (for multiple Customer Groups), the Cart no longer keeps a direct reference to a Customer Group. If a Customer’s group assignments change, the Cart and its Line Item prices are not updated automatically. Prices are only updated when the Cart is changed via a [direct update action](/projects/carts#update-actions).
 
         Specific Error Codes:
 
@@ -1724,7 +1731,7 @@ uriParameters:
 
         If omitted in the request body, the [Customer](ctp:api:type:Customer) `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter.
 
-        A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+        A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
         Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message.
       securedBy:
@@ -1762,7 +1769,7 @@ uriParameters:
         - If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart.
         - If the Customer already has a Cart, the most recently modified anonymous cart is handled according to [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
 
-        A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+        A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
         If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
 
@@ -2176,7 +2183,7 @@ uriParameters:
     description: |
       Authenticates a Customer associated with a [Store](ctp:api:type:Store). For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
 
-      A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+      A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
       Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
 
diff --git a/api-specs/api/resources/login.raml b/api-specs/api/resources/login.raml
@@ -9,7 +9,7 @@ post:
 
     Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
 
-    A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+    A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
     If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
 
diff --git a/api-specs/api/resources/me.raml b/api-specs/api/resources/me.raml
@@ -179,7 +179,7 @@ delete:
       - If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart.
       - If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
 
-      A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+      A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
       If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
     securedBy:
diff --git a/api-specs/api/types/cart/updates/CartChangeTaxCalculationModeAction.raml b/api-specs/api/types/cart/updates/CartChangeTaxCalculationModeAction.raml
@@ -5,7 +5,7 @@ displayName: CartChangeTaxCalculationModeAction
 discriminatorValue: changeTaxCalculationMode
 example: !include ../../../examples/Cart/CartChangeTaxCalculationModeAction.json
 description: |
-  Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
+  Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#taxes).
 properties:
   taxCalculationMode:
     type: TaxCalculationMode
diff --git a/api-specs/api/types/cart/updates/CartChangeTaxRoundingModeAction.raml b/api-specs/api/types/cart/updates/CartChangeTaxRoundingModeAction.raml
@@ -5,7 +5,7 @@ displayName: CartChangeTaxRoundingModeAction
 discriminatorValue: changeTaxRoundingMode
 example: !include ../../../examples/Cart/CartChangeTaxRoundingModeAction.json
 description: |
-  Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
+  Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#taxes).
 properties:
   taxRoundingMode:
     type: RoundingMode
diff --git a/api-specs/api/types/cart/updates/CartRecalculateAction.raml b/api-specs/api/types/cart/updates/CartRecalculateAction.raml
@@ -5,7 +5,7 @@ displayName: CartRecalculateAction
 discriminatorValue: recalculate
 example: !include ../../../examples/Cart/CartRecalculateAction.json
 description: |
-  This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates)
+  This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#update-a-cart)
   to bring prices and discounts to the latest state. Those can become stale over time when no Cart updates have been performed for a while and
   prices on related Products have changed in the meanwhile.
 
diff --git a/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml b/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml
@@ -8,7 +8,7 @@ description: |
   This update action can only be used if a Customer is not assigned to the Cart.
   If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer.
 
-  To reflect the new Customer Group, this update action can result in [updates to the Cart](/api/carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+  To reflect the new Customer Group, this update action can result in [updates to the Cart](/api/carts-orders-overview#update-a-cart). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 properties:
   customerGroup?:
     type: CustomerGroupResourceIdentifier
diff --git a/api-specs/api/types/cart/updates/CartSetLineItemSupplyChannelAction.raml b/api-specs/api/types/cart/updates/CartSetLineItemSupplyChannelAction.raml
@@ -5,7 +5,7 @@ displayName: CartSetLineItemSupplyChannelAction
 discriminatorValue: setLineItemSupplyChannel
 example: !include ../../../examples/Cart/CartSetLineItemSupplyChannelAction.json
 description: |
-  Performing this action has no impact on inventory that should be reserved.
+  Performing this action does not reserve stock. Stock is only reserved at Order creation if the [InventoryMode](ctp:api:type:InventoryMode) of the Cart is `TrackOnly` or `ReserveOnOrder`.
 properties:
   lineItemId?:
     type: string
diff --git a/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml b/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml
@@ -7,7 +7,7 @@ example: !include ../../../examples/Customer/CustomerSetCustomerGroupAction.json
 description: |
   Setting the Customer Group of the Customer produces the [CustomerGroupSet](ctp:api:type:CustomerGroupSetMessage) Message.
 
-  To reflect the new Customer Group, this update action can result in [updates](/api/carts-orders-overview#cart-updates) to the most recently modified active Cart. When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+  To reflect the new Customer Group, this update action can result in [updates](/api/carts-orders-overview#update-a-cart) to the most recently modified active Cart. When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 
 properties:
   customerGroup?:
diff --git a/api-specs/api/types/me/updates/MyCartRecalculateAction.raml b/api-specs/api/types/me/updates/MyCartRecalculateAction.raml
@@ -5,7 +5,7 @@ displayName: MyCartRecalculateAction
 discriminatorValue: recalculate
 example: !include ../../../examples/Cart/CartRecalculateAction.json
 description: |
-  This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates)
+  This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#update-a-cart)
   to bring prices and discounts to the latest state. Those can become stale over time when no Cart updates have been performed for a while and
   prices on related Products have changed in the meanwhile.
 
diff --git a/api-specs/api/types/me/updates/MyCartSetLineItemSupplyChannelAction.raml b/api-specs/api/types/me/updates/MyCartSetLineItemSupplyChannelAction.raml
@@ -5,7 +5,7 @@ displayName: MyCartSetLineItemSupplyChannelAction
 discriminatorValue: setLineItemSupplyChannel
 example: !include ../../../examples/Cart/CartSetLineItemSupplyChannelAction.json
 description: |
-  Performing this action has no impact on inventory that should be reserved.
+  Performing this action does not reserve stock. Stock is only reserved at Order creation if the [InventoryMode](ctp:api:type:InventoryMode) of the Cart is `TrackOnly` or `ReserveOnOrder`.
 properties:
   lineItemId?:
     type: string
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderChangeTaxCalculationModeAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderChangeTaxCalculationModeAction.raml
@@ -5,7 +5,7 @@ type: StagedOrderUpdateAction
 displayName: StagedOrderChangeTaxCalculationModeAction
 discriminatorValue: changeTaxCalculationMode
 description: |
-  Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
+  Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#taxes).
 properties:
   taxCalculationMode:
     type: TaxCalculationMode
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderChangeTaxRoundingModeAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderChangeTaxRoundingModeAction.raml
@@ -4,7 +4,7 @@ example: !include ../../../examples/OrderEdit/StagedOrderChangeTaxRoundingModeAc
 type: StagedOrderUpdateAction
 displayName: StagedOrderChangeTaxRoundingModeAction
 description: |
-  Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
+  Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#taxes).
 discriminatorValue: changeTaxRoundingMode
 properties:
   taxRoundingMode:
diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml
@@ -8,7 +8,7 @@ description: |
   This update action can only be used if a Customer is not assigned to a Cart.
   If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer.
 
-  To reflect the new Customer Group, this update action can result in [updates to the Cart](/../api/carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
+  To reflect the new Customer Group, this update action can result in [updates to the Cart](/../api/carts-orders-overview#update-a-cart). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
 properties:
   customerGroup?:
     type: CustomerGroupResourceIdentifier
