docs(promotions): PROMO-869 split promotion models into Draft, Patch … #968
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and Saved as each state has different expectations on what props are required
jpajar
reviewed
Jun 10, 2025
reference/promotions.v3.yml
Outdated
| @@ -1158,11 +1297,6 @@ components: | |||
| description: 'A unique code that can be used to manually apply a discount. Only letters, numbers, white spaces, underscores and hyphens are allowed.' | |||
| example: TEST-COUPON-CODE | |||
| maxLength: 50 | |||
| current_uses: | |||
There was a problem hiding this comment.
I noticed this was removed, are we no longer tracking current_uses for CouponCode?
There was a problem hiding this comment.
Ah good catch. No this shouldn't be removed. 😅
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…and Saved as each state has different expectations on what props are required
What changed?
Refactor promotion models to separate them into "Draft", "Patch" and "Saved" models to be used depending on context.
Here we can correct expectations for the SavedPromotions so id is always available. And for patch payloads where no properties are required.
Release notes draft
No behaviour changes here
Anything else?
ping @bigcommerce/team-promotions