Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/examples/Cart/CartFreezeCartAction.json

@@ -1,3 +1,4 @@
 {
-  "action": "freezeCart"
+  "action": "freezeCart",
+  "strategy": "HardFreeze"
 }

api-specs/api/types/cart/Cart.raml

@@ -113,6 +113,11 @@ properties:
     description: |
       Current status of the Cart.
     default: Active
+  freezeStrategy?:
+    type: FreezeStrategy
+    description: |
+      Determines freezing behavior when `cartState` is `Frozen`.
+    default: SoftFreeze
   billingAddress?:
     type: Address
     description: |

api-specs/api/types/cart/CartState.raml

@@ -30,3 +30,7 @@ enum:
       - [Change TaxMode](ctp:api:type:CartChangeTaxModeAction)
       - [Set LineItem Price](ctp:api:type:CartSetLineItemPriceAction)
       - [Set LineItem TotalPrice](ctp:api:type:CartSetLineItemTotalPriceAction)
+
+    Additionally, when using the `HardFreeze` [FreezeStrategy](ctp:api:type:FreezeStrategy), the following update actions are also not allowed:
+      - [Set ShippingMethod](ctp:api:type:CartSetShippingMethodAction)
+      - [Set CustomShippingMethod](ctp:api:type:CartSetCustomShippingMethodAction)

api-specs/api/types/cart/FreezeStrategy.raml

@@ -0,0 +1,14 @@
+#%RAML 1.0 DataType
+(package): Cart
+displayName: FreezeStrategy
+type: string
+description: |
+  Indicates how a [Cart](ctp:api:type:Cart) freeze behaves. For detailed behavior on each of these strategies, see [Freeze a Cart](/../api/carts-orders-overview#freeze-a-cart).
+enum:
+  - SoftFreeze
+  - HardFreeze
+(enumDescriptions):
+  SoftFreeze: |
+    More lenient Cart freeze strategy that locks prices as they were when the Cart was frozen. This is the default strategy when not explicitly specified, ensuring backwards compatibility.
+  HardFreeze: |
+    Stricter Cart freeze strategy that, in addition to the `SoftFreeze` behavior, also freezes Cart Discounts, Discount Codes, and Shipping Methods, ensuring the final price remains unchanged.

api-specs/api/types/cart/updates/CartFreezeCartAction.raml

@@ -5,7 +5,19 @@ displayName: CartFreezeCartAction
 discriminatorValue: freezeCart
 example: !include ../../../examples/Cart/CartFreezeCartAction.json
 description: |
-  Changes the [CartState](ctp:api:type:CartState) from `Active` to `Frozen`. Results in a [Frozen Cart](ctp:api:type:FrozenCarts).
-  Fails with [InvalidOperation](ctp:api:type:InvalidOperationError) error when the Cart is empty.
 
-  Freezing a Cart produces the [CartFrozen](ctp:api:type:CartFrozenMessage) Message.
+  Freezes the Cart based on the provided [FreezeStrategy](ctp:api:type:FreezeStrategy).
+
+  The following behavior occurs:
+    - Changes the Cart State from `Active` to `Frozen`.
+    - Sets the corresponding [FreezeStrategy](ctp:api:type:FreezeStrategy) on the Cart's `freezeStrategy` field.
+    - Produces the [CartFrozen](ctp:api:type:CartFrozenMessage) Message.
+
+  If the Cart is empty, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
+
+properties:
+  strategy?:
+    type: FreezeStrategy
+    description: |
+      Strategy that determines the freezing behavior.
+    default: SoftFreeze

api-specs/api/types/cart/updates/CartSetCustomShippingMethodAction.raml

@@ -11,6 +11,9 @@ description: |
 
   To unset a custom Shipping Method on a Cart, use the [Set ShippingMethod](ctp:api:type:CartSetShippingMethodAction) update action
   without the `shippingMethod` field instead.
+
+  This update is not allowed when the Cart is [frozen](/../api/carts-orders-overview#freeze-a-cart) with
+  the `HardFreeze` [FreezeStrategy](ctp:api:type:FreezeStrategy).
 properties:
   shippingMethodName:
     type: string

api-specs/api/types/cart/updates/CartSetShippingMethodAction.raml

@@ -6,6 +6,8 @@ discriminatorValue: setShippingMethod
 example: !include ../../../examples/Cart/CartSetShippingMethodAction.json
 description: |
   To set the Cart's Shipping Method the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
+
+  This update is not allowed when the Cart is [frozen](/../api/carts-orders-overview#freeze-a-cart) with the `HardFreeze` [FreezeStrategy](ctp:api:type:FreezeStrategy).
 properties:
   shippingMethod?:
     type: ShippingMethodResourceIdentifier

api-specs/api/types/types.raml

@@ -222,6 +222,7 @@ DiscountedTotalPricePortion: !include cart/DiscountedTotalPricePortion.raml
 ExternalLineItemTotalPrice: !include cart/ExternalLineItemTotalPrice.raml
 ExternalTaxAmountDraft: !include cart/ExternalTaxAmountDraft.raml
 ExternalTaxRateDraft: !include cart/ExternalTaxRateDraft.raml
+FreezeStrategy: !include cart/FreezeStrategy.raml
 InventoryMode: !include cart/InventoryMode.raml
 ItemShippingDetails: !include cart/ItemShippingDetails.raml
 ItemShippingDetailsDraft: !include cart/ItemShippingDetailsDraft.raml

api-specs/graphql/schema.sdl

@@ -1835,6 +1835,7 @@ type Cart implements Versioned & ReferenceExpandable {
   shippingCustomFields: CustomFieldsType
   discountTypeCombination: DiscountTypeCombination
   cartState: CartState!
+  freezeStrategy: FreezeStrategy
   key: String
   lock: CartLock
   custom: CustomFieldsType
@@ -4978,8 +4979,21 @@ input FixedPriceDiscountValueInput {
   money: [CartDiscountValueBaseMoneyInput!]!
 }
 
+enum FreezeStrategy {
+  """
+  More lenient version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
+  """
+  SoftFreeze
+
+  """
+  Stricter version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
+  """
+  HardFreeze
+}
+
 input FreezeCart {
   dummy: String
+  strategy: FreezeStrategy
 }
 
 interface Geometry {