Skip to content

Commit 8cd6b5e

Browse files
DEVDOCS-6697 - Remove code object from Create a Promotion API Spec (#1225)
<!-- Ticket number or summary of work --> # [DEVDOCS-6697] ## What changed? <!-- Provide a bulleted list in the present tense --> * Removed code object from create a promotion API reference as this is for internal use only and not to be shown publicly. ## Release notes draft Removed code object from create a promotion API reference as this is for internal use only and not to be shown publicly. ping @bigcommerce/dev-docs @bc-terra [DEVDOCS-6697]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6697?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent de1ed89 commit 8cd6b5e

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

reference/promotions.v3.yml

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ info:
44
version: '1.0'
55
description: |
66
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+
88
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.
99
1010
To learn more about promotions, consult the [Promotions Overview](/docs/store-operations/promotions).
@@ -279,15 +279,15 @@ paths:
279279
content: {}
280280
'422':
281281
$ref: '#/components/responses/BulkDeleteResponse'
282-
282+
283283
'/promotions/{promotion_id}/codegen':
284284
post:
285285
tags:
286286
- Coupon Codes (Bulk)
287287
summary: Generate Multiple Coupon Codes
288288
description: |-
289289
Generate a batch of coupon codes for a particular bulk coupon promotion.
290-
290+
291291
**Note:**
292292
* 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.
293293
* The default rate limit for this endpoint is 10 concurrent requests.
@@ -351,7 +351,6 @@ paths:
351351
schema:
352352
$ref: '#/components/schemas/ErrorResponse'
353353

354-
355354
'/promotions/codes':
356355
parameters:
357356
- $ref: '#/components/parameters/Accept'
@@ -361,7 +360,7 @@ paths:
361360
summary: Get A Coupon Code
362361
description: |-
363362
Get a coupon with a given coupon code.
364-
363+
365364
**Note:**
366365
The default rate limit for this endpoint is 40 concurrent requests.
367366
operationId: getCouponCodeByCode
@@ -376,7 +375,7 @@ paths:
376375
summary: Delete A Coupon Code
377376
description: |-
378377
Deletes a coupon with a given coupon code.
379-
378+
380379
**Note:**
381380
The default rate limit for this endpoint is 40 concurrent requests.
382381
operationId: deleteCouponCodeByCode
@@ -536,8 +535,6 @@ components:
536535
- $ref: '#/components/schemas/PromotionBase'
537536
- type: object
538537
properties:
539-
codes:
540-
$ref: '#/components/schemas/CouponCode'
541538
coupon_overrides_automatic_when_offering_higher_discounts:
542539
type: boolean
543540
example: false
@@ -599,9 +596,9 @@ components:
599596
type: object
600597
properties:
601598
has_multiple_codes:
602-
type: boolean
603-
example: false
604-
default: false
599+
type: boolean
600+
example: false
601+
default: false
605602
coupon_type:
606603
type: string
607604
enum:
@@ -1256,11 +1253,7 @@ components:
12561253
CursorPagination:
12571254
title: Cursor Pagination
12581255
type: object
1259-
required: [
1260-
count,
1261-
per_page,
1262-
links
1263-
]
1256+
required: [count, per_page, links]
12641257
properties:
12651258
count:
12661259
type: integer
@@ -1390,7 +1383,7 @@ components:
13901383
- CART_PAGE
13911384
- CHECKOUT_PAGE
13921385
items:
1393-
type: string
1386+
type: string
13941387
description: |-
13951388
**Notification**
13961389
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:
14511444
items:
14521445
minItems: 1
14531446
type: string
1454-
example: "0439538491"
1447+
example: '0439538491'
14551448
CouponCode:
14561449
description: A `CouponCode` object encapsulates attributes of a coupon code.
14571450
type: object
@@ -1816,8 +1809,8 @@ components:
18161809
title: Errors occurred in bulk delete action.
18171810
type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
18181811
errors:
1819-
0.constraint: "Failed for id=12. Error: constraint reference error."
1820-
2.code: "Failed for id=14. Error: some relating codes are still present."
1812+
0.constraint: 'Failed for id=12. Error: constraint reference error.'
1813+
2.code: 'Failed for id=14. Error: some relating codes are still present.'
18211814
meta:
18221815
total: 5
18231816
success: 3

0 commit comments

Comments
 (0)