Skip to content

PROMO-1256 PROMO-1257 PROMO-1296: Added prefix, suffix, delimiter, exclude_characters and code_length fields for bulk coupon api /v3/promotions/{promotion id}/codegen #1090

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

Closed
bc-anshumishra wants to merge 2 commits into from
+32 −0
Closed

PROMO-1256 PROMO-1257 PROMO-1296: Added prefix, suffix, delimiter, exclude_characters and code_length fields for bulk coupon api /v3/promotions/{promotion id}/codegen #1090

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f45037
PROMO-1256 PROMO-1257 PROMO-1296: Added prefix, suffix, delimiter, ex…
bc-anshumishra Sep 25, 2025
8b190e4
addressed PR comments
bc-anshumishra Oct 13, 2025
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
32 changes: 32 additions & 0 deletions reference/promotions.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,38 @@ paths:
example: 5
minimum: 0
maximum: 100000
prefix:
pattern: '[A-Z0-9_-]'
Copy link
Copy Markdown
Contributor

@donald-nguyen-bc donald-nguyen-bc Oct 8, 2025

Choose a reason for hiding this comment

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

probably we don't need to wrap text inside those single quotes ?

Suggested change
pattern: '[A-Z0-9_-]'
pattern: [A-Z0-9_-]

Copy link
Copy Markdown
Contributor

@donald-nguyen-bc donald-nguyen-bc Oct 8, 2025

Choose a reason for hiding this comment

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

also applied to other lines in PR as well

Copy link
Copy Markdown
Contributor

@donald-nguyen-bc donald-nguyen-bc Oct 12, 2025

Choose a reason for hiding this comment

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

hey Anshu, may you pls help to update the doc for this comment as well ?

type: string
description: The fixed text that will appear at the beginning of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.
example: PRE
maxLength: 20
suffix:
pattern: '[A-Z0-9_-]'
Comment on lines +324 to +330
Copy link

Copilot AI Sep 25, 2025

Choose a reason for hiding this comment

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

The regex pattern '[A-Z0-9_-]' only matches a single character, but the field descriptions indicate these are for text/strings that can contain multiple characters. The pattern should be '[A-Z0-9_-]*' or '[A-Z0-9_-]+' to match zero or more, or one or more characters respectively.

Suggested change
pattern: '[A-Z0-9_-]'
type: string
description: 'The fixed text or characters that will appear at the beginning of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.'
example: PRE-
maxLength: 20
suffix:
pattern: '[A-Z0-9_-]'
pattern: '[A-Z0-9_-]*'
type: string
description: 'The fixed text or characters that will appear at the beginning of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.'
example: PRE-
maxLength: 20
suffix:
pattern: '[A-Z0-9_-]*'

Copilot uses AI. Check for mistakes.
Comment on lines +324 to +330
Copy link

Copilot AI Sep 25, 2025

Choose a reason for hiding this comment

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

The regex pattern '[A-Z0-9_-]' only matches a single character, but the field descriptions indicate these are for text/strings that can contain multiple characters. The pattern should be '[A-Z0-9_-]*' or '[A-Z0-9_-]+' to match zero or more, or one or more characters respectively.

Suggested change
pattern: '[A-Z0-9_-]'
type: string
description: 'The fixed text or characters that will appear at the beginning of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.'
example: PRE-
maxLength: 20
suffix:
pattern: '[A-Z0-9_-]'
pattern: '[A-Z0-9_-]*'
type: string
description: 'The fixed text or characters that will appear at the beginning of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.'
example: PRE-
maxLength: 20
suffix:
pattern: '[A-Z0-9_-]*'

Copilot uses AI. Check for mistakes.
type: string
description: The fixed text that will appear at the end of every generated coupon code. Only capital letters, numbers, underscores and hyphens are allowed.
example: POST
maxLength: 20
delimiter:
pattern: '[_-]'
type: string
description: An optional single character (_ or -) that will be placed between the prefix and the randomly generated code, and again between the randomly generated code and the suffix. It will only be applied if a valid prefix or suffix is present.
example: _
maxLength: 1
exclude_characters:
type: array
items:
type: string
pattern: '[A-Z0-9]'
description: An optional array of single length string elements to exclude from the generated coupon codes. Only capital letters and numbers are allowed. The default value is an empty array [].
example: ["1", "2", "3", "4", "5", "A", "B", "C", "D", "E"]
maxLength: 26
code_length:
type: integer
description: The length of the random string to be generated for each coupon code. The value must be between 6 and 16. The default length is 16. The total length of each generated coupon code is calculated as `:` code_length + length of prefix with delimiter + length of suffix with delimiter. The maximum total length of a coupon code is 50.
example: 10
minimum: 6
maximum: 16
required: true
responses:
'201':
Expand Down