Skip to content

doc(promotions): PROMO-1123 new field "display_name" in the Promotions v3 API #682

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

Merged
donald-nguyen-bc merged 2 commits into from
Jan 7, 2025
Merged

doc(promotions): PROMO-1123 new field "display_name" in the Promotions v3 API #682

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25696c4
chore(promotions): PROMO-1123 IDE auto format: remove redundant empty…
donald-nguyen-bc Nov 26, 2024
8454120
doc(promotions): PROMO-1123 new field "display_name" in the Promotion…
donald-nguyen-bc Nov 26, 2024
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
25 changes: 15 additions & 10 deletions reference/promotions.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ paths:
get:
tags:
- Promotions (Bulk)
summary: Get All Promotions
summary: Get All Promotions
description: |-
Returns a list of *promotions*.

Expand Down Expand Up @@ -132,7 +132,7 @@ paths:
get:
tags:
- Promotions (Single)
summary: Get Promotion
summary: Get Promotion
description: |-
Returns a single *promotion*.

Expand Down Expand Up @@ -182,7 +182,7 @@ paths:
delete:
tags:
- Promotions (Single)
summary: Delete Promotion
summary: Delete Promotion
description: |-
Deletes a promotion.

Expand All @@ -201,7 +201,7 @@ paths:
get:
tags:
- Coupon Codes (Bulk)
summary: Get Coupon Codes
summary: Get Coupon Codes
description: |-
Get codes for a particular promotion.

Expand All @@ -220,7 +220,7 @@ paths:
post:
tags:
- Coupon Codes (Single)
summary: Create A Coupon Code
summary: Create A Coupon Code
description: |-
Create a new code for the promotion.

Expand Down Expand Up @@ -258,7 +258,7 @@ paths:
delete:
tags:
- Coupon Codes (Bulk)
summary: Delete Multiple Coupon Codes
summary: Delete Multiple Coupon Codes
description: |-
Deletes multiple coupon codes relating to the given promotion. Currently, batches are limited to 50 coupon codes.

Expand Down Expand Up @@ -320,6 +320,10 @@ components:
type: string
description: An internal name for this rule that the merchant can refer to.
example: Buy Product X Get Free Shipping
display_name:
type: string
description: Customer-facing name for this rule, that the merchant want to display to customers.
example: WOW!!! FREE SHIPPING for Product X
channels:
type: array
description: 'Channels that the promotion targets. Empty array [] means targeting all the channels. In POST request, if omitted, this field defaults to an empty array [] value.'
Expand Down Expand Up @@ -1073,9 +1077,9 @@ components:
type: array
description: Specifies where the notification message will be displayed.
example:
- HOME_PAGE
- PRODUCT_PAGE
- CART_PAGE
- HOME_PAGE
- PRODUCT_PAGE
- CART_PAGE
- CHECKOUT_PAGE
items:
type: string
Expand Down Expand Up @@ -1483,7 +1487,7 @@ components:
success: 0
failed: 0
422 - Error Deleting:
example:
example:
errors:
- status: 422
title: Errors occurred in bulk delete action.
Expand Down Expand Up @@ -1580,6 +1584,7 @@ components:
- id: 1
redemption_type: AUTOMATIC
name: Buy Product X Get Free Shipping
display_name: WOW!!! FREE SHIPPING for Product X
channels:
- id: 1
customer:
Expand Down
Loading