You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference/promotions.v3.yml
+13-20Lines changed: 13 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ info:
4
4
version: '1.0'
5
5
description: |
6
6
A *promotion* is composed of a condition that a customer can satisfy, such as increasing their cart value above a certain amount or adding an item to their cart.
7
-
7
+
8
8
After the customer satisfies the condition, an action takes place, such as a free item being added to the cart or a discount applying itself to the order total.
9
9
10
10
To learn more about promotions, consult the [Promotions Overview](/docs/store-operations/promotions).
@@ -279,15 +279,15 @@ paths:
279
279
content: {}
280
280
'422':
281
281
$ref: '#/components/responses/BulkDeleteResponse'
282
-
282
+
283
283
'/promotions/{promotion_id}/codegen':
284
284
post:
285
285
tags:
286
286
- Coupon Codes (Bulk)
287
287
summary: Generate Multiple Coupon Codes
288
288
description: |-
289
289
Generate a batch of coupon codes for a particular bulk coupon promotion.
290
-
290
+
291
291
**Note:**
292
292
* batch_size (number of codes generated per request) is limited to 250. If batch_size is not an integer or larger than 250, it will return a 422 error code.
293
293
* The default rate limit for this endpoint is 10 concurrent requests.
@@ -351,7 +351,6 @@ paths:
351
351
schema:
352
352
$ref: '#/components/schemas/ErrorResponse'
353
353
354
-
355
354
'/promotions/codes':
356
355
parameters:
357
356
- $ref: '#/components/parameters/Accept'
@@ -361,7 +360,7 @@ paths:
361
360
summary: Get A Coupon Code
362
361
description: |-
363
362
Get a coupon with a given coupon code.
364
-
363
+
365
364
**Note:**
366
365
The default rate limit for this endpoint is 40 concurrent requests.
367
366
operationId: getCouponCodeByCode
@@ -376,7 +375,7 @@ paths:
376
375
summary: Delete A Coupon Code
377
376
description: |-
378
377
Deletes a coupon with a given coupon code.
379
-
378
+
380
379
**Note:**
381
380
The default rate limit for this endpoint is 40 concurrent requests.
A notification displayed to the user based on the result of executing a promotion, for example, a "Congratulations! Youʼve received free shipping!" message when the shopper receives free shipping.
@@ -1451,7 +1444,7 @@ components:
1451
1444
items:
1452
1445
minItems: 1
1453
1446
type: string
1454
-
example: "0439538491"
1447
+
example: '0439538491'
1455
1448
CouponCode:
1456
1449
description: A `CouponCode` object encapsulates attributes of a coupon code.
0 commit comments