Skip to content

Commit e8a8cc2

Browse files
TomA-RTomA-R
authored
DEVDOCS-6658: Replace placeholder values with realistic examples in Cart, Checkout and Orders API reference files (#1190)
# [DEVDOCS-6658] ## What changed? Replace placeholder values with realistic examples in Cart, Checkout and Orders API reference files [DEVDOCS-6658]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6658?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent d1a1af9 commit e8a8cc2

File tree

5 files changed

+252
-252
lines changed

5 files changed

+252
-252
lines changed

‎reference/carts.sf.yml‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ paths:
3737
3838
> #### Note
3939
> * Substitute your storefront domain for `yourstore.example.com`.
40-
> * The Send a Test Request feature is not currently supported for this endpoint.
40+
> * The Send a Test Request feature is not currently supported for this endpoint.
4141
operationId: getCart
4242
responses:
4343
'200':
@@ -51,7 +51,7 @@ paths:
5151
5252
> #### Note
5353
> * Substitute your storefront domain for `yourstore.example.com`.
54-
> * The Send a Test Request feature is not currently supported for this endpoint.
54+
> * The Send a Test Request feature is not currently supported for this endpoint.
5555
operationId: createCart
5656
parameters:
5757
- $ref: '#/components/parameters/ContentType'
@@ -82,7 +82,7 @@ paths:
8282
wrapTogether: true
8383
wrapDetails:
8484
- id: 1
85-
message: "Happy Birthday"
85+
message: "Happy Birthday"
8686
locale: en
8787
required: true
8888
responses:
@@ -103,7 +103,7 @@ paths:
103103
104104
> #### Note
105105
> * Substitute your storefront domain for `yourstore.example.com`.
106-
> * The Send a Test Request feature is not currently supported for this endpoint.
106+
> * The Send a Test Request feature is not currently supported for this endpoint.
107107
operationId: deleteCart
108108
responses:
109109
'204':
@@ -277,7 +277,7 @@ paths:
277277
278278
> #### Note
279279
> * Substitute your storefront domain for `yourstore.example.com`.
280-
> * The Send a Test Request feature is not currently supported for this endpoint.
280+
> * The Send a Test Request feature is not currently supported for this endpoint.
281281
operationId: updateCartCurrency
282282
parameters:
283283
- $ref: '#/components/parameters/Include'
@@ -1012,7 +1012,7 @@ components:
10121012
items:
10131013
type: object
10141014
properties:
1015-
optionId:
1015+
optionId:
10161016
type: integer
10171017
description: Modifier option ID.
10181018
example: 2
@@ -1046,7 +1046,7 @@ components:
10461046
items:
10471047
type: object
10481048
properties:
1049-
optionId:
1049+
optionId:
10501050
type: integer
10511051
description: Modifier option ID.
10521052
example: 2
@@ -1060,7 +1060,7 @@ components:
10601060
required:
10611061
- productId
10621062
- quantity
1063-
title: Product with a variant
1063+
title: Product with a variant
10641064
x-examples:
10651065
example-1:
10661066
productId: 0
@@ -1100,11 +1100,11 @@ components:
11001100
examples:
11011101
Example:
11021102
value:
1103-
id: string
1103+
id: "76f1bfe4-dbbe-4018-8ee6-2e3c36bf1518"
11041104
customerId: 0
1105-
email: string
1105+
email: "customer@example.com"
11061106
currency:
1107-
code: string
1107+
code: "USD"
11081108
decimalPlaces: 2
11091109
name: US Dollar
11101110
symbol: $
@@ -1212,11 +1212,11 @@ components:
12121212
examples:
12131213
example-1:
12141214
value:
1215-
id: string
1215+
id: "76f1bfe4-dbbe-4018-8ee6-2e3c36bf1518"
12161216
customerId: 0
1217-
email: string
1217+
email: "customer@example.com"
12181218
currency:
1219-
code: string
1219+
code: "USD"
12201220
decimalPlaces: 2
12211221
name: US Dollar
12221222
symbol: $
@@ -1225,14 +1225,14 @@ components:
12251225
discountAmount: 0
12261226
cartAmount: 0
12271227
coupons:
1228-
- code: string
1228+
- code: "SAVE10"
12291229
couponType: 0
12301230
discountedAmount: 0
12311231
displayName: $1.00 off the order total
1232-
id: string
1232+
id: "1"
12331233
discounts:
12341234
- discountedAmount: 0
1235-
id: string
1235+
id: "discount-123"
12361236
lineItems:
12371237
customItems: []
12381238
digitalItems:
@@ -1324,11 +1324,11 @@ components:
13241324
examples:
13251325
Example:
13261326
value:
1327-
id: string
1327+
id: "76f1bfe4-dbbe-4018-8ee6-2e3c36bf1518"
13281328
customerId: 0
1329-
email: string
1329+
email: "customer@example.com"
13301330
currency:
1331-
code: string
1331+
code: "USD"
13321332
decimalPlaces: 2
13331333
name: US Dollar
13341334
symbol: $
@@ -1337,14 +1337,14 @@ components:
13371337
discountAmount: 0
13381338
cartAmount: 0
13391339
coupons:
1340-
- code: string
1340+
- code: "SAVE10"
13411341
couponType: 0
13421342
discountedAmount: 0
13431343
displayName: $1.00 off the order total
1344-
id: string
1344+
id: "1"
13451345
discounts:
13461346
- discountedAmount: 0
1347-
id: string
1347+
id: "discount-123"
13481348
lineItems:
13491349
customItems: []
13501350
digitalItems:
@@ -1468,7 +1468,7 @@ components:
14681468
isTaxable: true
14691469
imageUrl: 'https://cdn11.bigcommerce.com/r-3b68d717e18793df0b51c71e16bc24664ad18b7c/themes/ClassicNext/images/ProductDefault.gif'
14701470
discounts:
1471-
- id: string
1471+
- id: "discount-456"
14721472
discountedAmount: 24.6
14731473
discountAmount: 24.6
14741474
couponAmount: 0
@@ -1497,11 +1497,11 @@ components:
14971497
examples:
14981498
Example:
14991499
value:
1500-
id: string
1500+
id: "76f1bfe4-dbbe-4018-8ee6-2e3c36bf1518"
15011501
customerId: 0
1502-
email: string
1502+
email: "customer@example.com"
15031503
currency:
1504-
code: string
1504+
code: "USD"
15051505
decimalPlaces: 2
15061506
name: US Dollar
15071507
symbol: $
@@ -1510,14 +1510,14 @@ components:
15101510
discountAmount: 0
15111511
cartAmount: 0
15121512
coupons:
1513-
- code: string
1513+
- code: "SAVE10"
15141514
couponType: 0
15151515
discountedAmount: 0
15161516
displayName: $1.00 off the order total
1517-
id: string
1517+
id: "1"
15181518
discounts:
1519-
- discountedAmount: 0
1520-
id: string
1519+
- discountedAmount: 10
1520+
id: "5af6a152-797a-4c60-b573-4e6822e1a4cd"
15211521
lineItems:
15221522
customItems: []
15231523
digitalItems:
@@ -1594,9 +1594,9 @@ components:
15941594
variantId: 7
15951595
giftWrapping: null
15961596
isShippingRequired: true
1597-
createdTime: string
1598-
updatedTime: string
1599-
locale: string
1597+
createdTime: "2024-01-15T10:30:00Z"
1598+
updatedTime: "2024-01-15T11:45:00Z"
1599+
locale: "en"
16001600
CartConflictErrorResponse:
16011601
description: 'Cart conflict'
16021602
content:

‎reference/carts.v3.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ paths:
490490
data:
491491
id: bc218c65-7a32-4ab7-8082-68730c074d02
492492
customer_id: 11
493-
email: ''
493+
email: 'customer@example.com'
494494
currency:
495495
code: USD
496496
tax_included: false
@@ -504,9 +504,9 @@ paths:
504504
parent_id: {}
505505
variant_id: 362
506506
product_id: 191
507-
sku: ''
507+
sku: 'OPENHOUSE-3'
508508
name: Openhouse No. 3
509-
url: 'http://id30h7ohwf.mybigcommerce.com/all/openhouse-no-3/'
509+
url: 'https://id30h7ohwf.mybigcommerce.com/all/openhouse-no-3/'
510510
quantity: 5
511511
taxable: true
512512
image_url: 'https://cdn8.bigcommerce.com/s-id30h7ohwf/products/191/images/475/openhousevol3_1024x1024__59692__16355.1534344544.330.500.jpg?c=2'
@@ -1922,7 +1922,7 @@ components:
19221922
description: The product URL.
19231923
type: string
19241924
format: uri
1925-
example: 'http://your-store-url.mybigcommerce.com/your-product/'
1925+
example: 'https://your-store-url.mybigcommerce.com/your-product/'
19261926
quantity:
19271927
type: number
19281928
example: 5
@@ -2114,7 +2114,7 @@ components:
21142114
description: The product URL.
21152115
type: string
21162116
format: uri
2117-
example: 'http://your-store-url.mybigcommerce.com/your-product/'
2117+
example: 'https://your-store-url.mybigcommerce.com/your-product/'
21182118
quantity:
21192119
type: number
21202120
example: 5
@@ -2284,7 +2284,7 @@ components:
22842284
description: The product URL.
22852285
type: string
22862286
format: uri
2287-
example: 'http://your-store-url.mybigcommerce.com/your-product/'
2287+
example: 'https://your-store-url.mybigcommerce.com/your-product/'
22882288
quantity:
22892289
type: number
22902290
example: 5
@@ -3170,7 +3170,7 @@ components:
31703170
description: The product URL.
31713171
type: string
31723172
format: uri
3173-
example: 'http://your-store-url.mybigcommerce.com/your-product/'
3173+
example: 'https://your-store-url.mybigcommerce.com/your-product/'
31743174
quantity:
31753175
type: number
31763176
example: 5

0 commit comments

Comments
 (0)