Skip to content

PROMO-1393 add number of codes use #1237

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

Draft
YevenLourance wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Draft

PROMO-1393 add number of codes use #1237

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
10 changes: 10 additions & 0 deletions reference/promotions.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,14 @@ components:
- BULK
description: The type of the coupon promotion, whether it will have single or multiple codes.
example: BULK
number_of_codes:
type: integer
description: The total number of coupon codes for this promotion.
example: 1
number_of_used_codes:
type: integer
description: The number of coupon codes that have been used at least once.
example: 0
required:
- id
- name
Expand All @@ -623,6 +631,8 @@ components:
- can_be_used_with_other_promotions
- coupon_overrides_automatic_when_offering_higher_discounts
- coupon_type
- number_of_codes
- number_of_used_codes
Comment on lines +634 to +635
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.

the intention is to have those fields as optional, and we can query them in adhoc with "include" parameter, somethingg like "GET /promotions?include=number_of_codes,number_of_used_codes"

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.

@matt-evangelidis, atm we do have ?include=codes for our internal API usage right ?

https://github.com/bigcommerce/bigcommerce/blob/f55ee6e494b549fd758847f399ed1ef666a31c03/app/Promotion/Application/Api/V1/PromotionController.php#L344-L346

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.

probably we can do the same for those number_of_codes and number_of_used_codes, make it available for internal usage for now ?

Copy link
Contributor

@donald-nguyen-bc donald-nguyen-bc Jan 15, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

if so, probably we don't need to update this swagger doc.

Copy link
Contributor Author

@YevenLourance YevenLourance Jan 15, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

i will implement as GET /promotions?include=number_of_codes,number_of_used_codes then
do we want to hide if promotion is automatic or maybe number of codes are 0 for automatic promotions?

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.

probably we can return 0 for automatic promotions, similar to how we are handling the codes and multiple_codes ?

image

Copy link
Contributor Author

@YevenLourance YevenLourance Jan 15, 2026

Choose a reason for hiding this comment

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

thanks ! @donald-nguyen-bc ill try with that in my implementation 👍

PatchAutomaticPromotion:
title: Patch Automatic Promotion
description: 'A Partial **Automatic Promotion** that contains properties to patch.'
Expand Down