⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

PROMO-1368 update API to use coupon_overrides_other_promotions #1213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YevenLourance wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −32
Open

PROMO-1368 update API to use coupon_overrides_other_promotions #1213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 45 additions & 32 deletions reference/promotions.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
version: '1.0'
description: |
A *promotion* is composed of a condition that a customer can satisfy, such as increasing their cart value above a certain amount or adding an item to their cart.

After the customer satisfies the condition, an action takes place, such as a free item being added to the cart or a discount applying itself to the order total.

To learn more about promotions, consult the [Promotions Overview](/docs/store-operations/promotions).
Expand Down Expand Up @@ -279,15 +279,15 @@ paths:
content: {}
'422':
$ref: '#/components/responses/BulkDeleteResponse'

'/promotions/{promotion_id}/codegen':
post:
tags:
- Coupon Codes (Bulk)
summary: Generate Multiple Coupon Codes
description: |-
Generate a batch of coupon codes for a particular bulk coupon promotion.

**Note:**
* batch_size (number of codes generated per request) is limited to 250. If batch_size is not an integer or larger than 250, it will return a 422 error code.
* The default rate limit for this endpoint is 10 concurrent requests.
Expand Down Expand Up @@ -360,7 +360,7 @@ paths:
summary: Get A Coupon Code
description: |-
Get a coupon with a given coupon code.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.
operationId: getCouponCodeByCode
Expand All @@ -375,7 +375,7 @@ paths:
summary: Delete A Coupon Code
description: |-
Deletes a coupon with a given coupon code.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.
operationId: deleteCouponCodeByCode
Expand Down Expand Up @@ -509,15 +509,10 @@ components:
properties:
codes:
$ref: '#/components/schemas/CouponCode'
coupon_overrides_other_promotions:
$ref: '#/components/schemas/CouponOverridesOtherPromotions'
coupon_overrides_automatic_when_offering_higher_discounts:
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 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 `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
$ref: '#/components/schemas/CouponOverridesAutomaticWhenOfferingHigherDiscounts'
coupon_type:
type: string
enum:
Expand All @@ -535,15 +530,12 @@ components:
- $ref: '#/components/schemas/PromotionBase'
- type: object
properties:
codes:
$ref: '#/components/schemas/CouponCode'
Comment on lines +533 to +534
Copy link
Contributor

@donald-nguyen-bc donald-nguyen-bc Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

coupon_overrides_other_promotions:
$ref: '#/components/schemas/CouponOverridesOtherPromotions'
coupon_overrides_automatic_when_offering_higher_discounts:
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 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 when `can_be_used_with_other_promotions` is `true` will yield a 422 error response.
$ref: '#/components/schemas/CouponOverridesAutomaticWhenOfferingHigherDiscounts'
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`.
Expand Down Expand Up @@ -577,16 +569,12 @@ components:
$ref: '#/components/schemas/CreatedFrom'
codes:
$ref: '#/components/schemas/CouponCode'
coupon_overrides_automatic_when_offering_higher_discounts:
type: boolean
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.
coupon_overrides_other_promotions:
$ref: '#/components/schemas/CouponOverridesOtherPromotions'

coupon_overrides_automatic_when_offering_higher_discounts:
$ref: '#/components/schemas/CouponOverridesAutomaticWhenOfferingHigherDiscounts'
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`.
Expand Down Expand Up @@ -621,7 +609,7 @@ components:
- start_date
- status
- can_be_used_with_other_promotions
- coupon_overrides_automatic_when_offering_higher_discounts
- coupon_overrides_other_promotions
- coupon_type
PatchAutomaticPromotion:
title: Patch Automatic Promotion
Expand Down Expand Up @@ -1253,7 +1241,10 @@ components:
CursorPagination:
title: Cursor Pagination
type: object
required: [count, per_page, links]
required:
- count
- per_page
- links
properties:
count:
type: integer
Expand Down Expand Up @@ -1745,6 +1736,28 @@ components:
$ref: '#/components/schemas/CustomerSegmentIdLimitation'
required:
- not
CouponOverridesAutomaticWhenOfferingHigherDiscounts:
title: CouponOverridesAutomaticWhenOfferingHigherDiscounts
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 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 `false`, 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.
CouponOverridesOtherPromotions:
title: CouponOverridesOtherPromotions
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.
Channel:
title: Channel
type: object
Expand Down