docs(promotions): PROMO-1368 update to coupon_overrides_other_promotions

update to coupon_overrides_other_promotions

Author: YevenLourance

reference/promotions.v3.yml

@@ -510,14 +510,25 @@ components:
           properties:
             codes:
               $ref: '#/components/schemas/CouponCode'
+            coupon_overrides_other_promotions:
+              type: boolean
+              example: false
+              default: false
+              description: |-
+                This field only has effect when `can_be_used_with_other_promotions` is `false`:
+                - When the property is set to `true`, the coupon will always override all applied promotions, including both automatic and coupon promotions.
+                - When the property is set to `false`, the coupon will not be applied if any promotions are already applied.
+                Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
             coupon_overrides_automatic_when_offering_higher_discounts:
+              deprecated: true
               type: boolean
               example: false
               default: false
               description: |-
+                This property has been deprecated and `coupon_overrides_other_promotions` should be used instead.
                 This field only has effect when `can_be_used_with_other_promotions` is `false`:
                 - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
-                - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
+                - When the property is set to `false`, the coupon will not be applied if automatic promotions are already applied.
                 Trying to set the value of this field to `true` when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
             coupon_type:
               type: string
@@ -538,14 +549,25 @@ components:
           properties:
             codes:
               $ref: '#/components/schemas/CouponCode'
+            coupon_overrides_other_promotions:
+              type: boolean
+              example: false
+              default: false
+              description: |-
+                - When this property is set to `true`, the coupon will always override all applied promotions, including both automatic and coupon promotions.
+                - When this property is set to `false`, the coupon will not be applied if any promotions are already applied.
+                
+                N.B.: This field only has effect when `can_be_used_with_other_promotions` is `false`. Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
             coupon_overrides_automatic_when_offering_higher_discounts:
+              deprecated: true
               type: boolean
               example: false
               default: false
               description: |-
+                This property has been deprecated and `coupon_overrides_other_promotions` should be used instead.
                 This field only has effect when `can_be_used_with_other_promotions` is `false`:
                 - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
-                - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
+                - When the property is set to `false`, the coupon will not be applied if automatic promotions are already applied.
                 Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
             redemption_type:
               type: string
@@ -585,11 +607,10 @@ components:
               example: false
               default: false
               description: |-
-                This field only has effect when the `redemption_type` is `COUPON` and `can_be_used_with_other_promotions` is `false`:
-                - When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
-                - When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
-
-                Trying to set the value of this field to `true` when the `redemption_type` is not `COUPON`, or when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
+                - When this property is set to `true`, the coupon will always override all applied promotions, including both automatic and coupon promotions.
+                - When this property is set to `false`, the coupon will not be applied if any promotions are already applied.
+                
+                N.B.: This field only has effect when `can_be_used_with_other_promotions` is `false`. Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
             redemption_type:
               type: string
               description: The type of the promotion. Promotions applied automatically have a value of `AUTOMATIC` whereas promotions requiring a coupon have a value of `COUPON`.