From 25696c4ae52eed8c4086ff0eede865b22c8e4243 Mon Sep 17 00:00:00 2001 From: Donald Nguyen Date: Tue, 26 Nov 2024 13:54:58 +1100 Subject: [PATCH 1/2] chore(promotions): PROMO-1123 IDE auto format: remove redundant empty space at the end of line for the Promotions v3 API --- reference/promotions.v3.yml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/reference/promotions.v3.yml b/reference/promotions.v3.yml index ea3c5868a..38b7eddea 100644 --- a/reference/promotions.v3.yml +++ b/reference/promotions.v3.yml @@ -34,7 +34,7 @@ paths: get: tags: - Promotions (Bulk) - summary: Get All Promotions + summary: Get All Promotions description: |- Returns a list of *promotions*. @@ -132,7 +132,7 @@ paths: get: tags: - Promotions (Single) - summary: Get Promotion + summary: Get Promotion description: |- Returns a single *promotion*. @@ -182,7 +182,7 @@ paths: delete: tags: - Promotions (Single) - summary: Delete Promotion + summary: Delete Promotion description: |- Deletes a promotion. @@ -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. @@ -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. @@ -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. @@ -1073,9 +1073,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 @@ -1483,7 +1483,7 @@ components: success: 0 failed: 0 422 - Error Deleting: - example: + example: errors: - status: 422 title: Errors occurred in bulk delete action. From 8454120229081844e3ba6edbab2f43c4ed2265a3 Mon Sep 17 00:00:00 2001 From: Donald Nguyen Date: Tue, 26 Nov 2024 13:55:41 +1100 Subject: [PATCH 2/2] doc(promotions): PROMO-1123 new field "display_name" in the Promotions v3 API --- reference/promotions.v3.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/reference/promotions.v3.yml b/reference/promotions.v3.yml index 38b7eddea..141a96bb7 100644 --- a/reference/promotions.v3.yml +++ b/reference/promotions.v3.yml @@ -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.' @@ -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: