Skip to content

Commit 5f1660d

Browse files
committed
docs(promotions): PROMO-1368 update to coupon_overrides_other_promotions
update to coupon_overrides_other_promotions
1 parent 1c40926 commit 5f1660d

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

reference/promotions.v3.yml

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -510,14 +510,24 @@ components:
510510
properties:
511511
codes:
512512
$ref: '#/components/schemas/CouponCode'
513+
coupon_overrides_other_promotions:
514+
type: boolean
515+
example: false
516+
default: false
517+
description: |-
518+
- When the property is set to `true`, the coupon will always override all applied promotions, including both automatic and coupon promotions.
519+
- When the property is set to `false`, the coupon will not be applied if any promotions are already applied.
520+
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.
513521
coupon_overrides_automatic_when_offering_higher_discounts:
522+
deprecated: true
514523
type: boolean
515524
example: false
516525
default: false
517526
description: |-
527+
This property has been deprecated and `coupon_overrides_other_promotions` should be used instead.
518528
This field only has effect when `can_be_used_with_other_promotions` is `false`:
519529
- When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
520-
- When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
530+
- When the property is set to `false`, the coupon will not be applied if automatic promotions are already applied.
521531
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.
522532
coupon_type:
523533
type: string
@@ -538,14 +548,25 @@ components:
538548
properties:
539549
codes:
540550
$ref: '#/components/schemas/CouponCode'
551+
coupon_overrides_other_promotions:
552+
type: boolean
553+
example: false
554+
default: false
555+
description: |-
556+
- When this property is set to `true`, the coupon will always override all applied promotions, including both automatic and coupon promotions.
557+
- When this property is set to `false`, the coupon will not be applied if any promotions are already applied.
558+
559+
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.
541560
coupon_overrides_automatic_when_offering_higher_discounts:
561+
deprecated: true
542562
type: boolean
543563
example: false
544564
default: false
545565
description: |-
566+
This property has been deprecated and `coupon_overrides_other_promotions` should be used instead.
546567
This field only has effect when `can_be_used_with_other_promotions` is `false`:
547568
- When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
548-
- When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
569+
- When the property is set to `false`, the coupon will not be applied if automatic promotions are already applied.
549570
Trying to set the value of this field when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
550571
redemption_type:
551572
type: string
@@ -587,8 +608,7 @@ components:
587608
description: |-
588609
This field only has effect when the `redemption_type` is `COUPON` and `can_be_used_with_other_promotions` is `false`:
589610
- When the property is set to `true`, the coupon will override the applied automatic promotions if it provides a greater discount.
590-
- When the property is set to `fasle`, the coupon will not be applied if automatic promotions are already applied.
591-
611+
- When the property is set to `false`, the coupon will not be applied if automatic promotions are already applied.
592612
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.
593613
redemption_type:
594614
type: string

0 commit comments

Comments
 (0)