Skip to content

Commit cb53225

Browse files
committed
PROMO-1050 Add shipping discount action
1 parent 3ce9db1 commit cb53225

File tree

1 file changed

+37
-10
lines changed

1 file changed

+37
-10
lines changed

Diff for: reference/promotions.v3.yml

+37-10
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ paths:
3434
get:
3535
tags:
3636
- Promotions (Bulk)
37-
summary: Get All Promotions
37+
summary: Get All Promotions
3838
description: |-
3939
Returns a list of *promotions*.
4040
@@ -120,7 +120,7 @@ paths:
120120
get:
121121
tags:
122122
- Promotions (Single)
123-
summary: Get Promotion
123+
summary: Get Promotion
124124
description: |-
125125
Returns a single *promotion*.
126126
@@ -170,7 +170,7 @@ paths:
170170
delete:
171171
tags:
172172
- Promotions (Single)
173-
summary: Delete Promotion
173+
summary: Delete Promotion
174174
description: |-
175175
Deletes a promotion.
176176
@@ -189,7 +189,7 @@ paths:
189189
get:
190190
tags:
191191
- Coupon Codes (Bulk)
192-
summary: Get Coupon Codes
192+
summary: Get Coupon Codes
193193
description: |-
194194
Get codes for a particular promotion.
195195
@@ -204,7 +204,7 @@ paths:
204204
post:
205205
tags:
206206
- Coupon Codes (Single)
207-
summary: Create A Coupon Code
207+
summary: Create A Coupon Code
208208
description: |-
209209
Create a new code for the promotion.
210210
@@ -242,7 +242,7 @@ paths:
242242
delete:
243243
tags:
244244
- Coupon Codes (Bulk)
245-
summary: Delete Multiple Coupon Codes
245+
summary: Delete Multiple Coupon Codes
246246
description: |-
247247
Deletes multiple coupon codes relating to the given promotion. Currently, batches are limited to 50 coupon codes.
248248
@@ -819,6 +819,33 @@ components:
819819
minimum: 1
820820
required:
821821
- zone_ids
822+
ShippingDiscountAction:
823+
title: Shipping Discount Action
824+
type: object
825+
description: |-
826+
**Shipping Discount Action**
827+
Discounts shipping, optionally restricted to specific shipping methods.
828+
properties:
829+
shipping_discount:
830+
type: object
831+
properties:
832+
discount:
833+
$ref: '#/components/schemas/Discount'
834+
method_ids:
835+
description: ''
836+
oneOf:
837+
- type: string
838+
enum:
839+
- '*'
840+
description: All configured shipping methods.
841+
- type: array
842+
uniqueItems: true
843+
description: List of shipping method IDs to which the shipping discount can apply.
844+
items:
845+
type: integer
846+
minimum: 1
847+
required:
848+
- method_ids
822849
Discount:
823850
title: Discount
824851
description: '**Discount**'
@@ -928,9 +955,9 @@ components:
928955
type: array
929956
description: Specifies where the notification message will be displayed.
930957
example:
931-
- HOME_PAGE
932-
- PRODUCT_PAGE
933-
- CART_PAGE
958+
- HOME_PAGE
959+
- PRODUCT_PAGE
960+
- CART_PAGE
934961
- CHECKOUT_PAGE
935962
items:
936963
type: string
@@ -1338,7 +1365,7 @@ components:
13381365
success: 0
13391366
failed: 0
13401367
422 - Error Deleting:
1341-
example:
1368+
example:
13421369
errors:
13431370
- status: 422
13441371
title: Errors occurred in bulk delete action.

0 commit comments

Comments
 (0)