Skip to content

Commit ddc8a6d

Browse files
committed
Updated API from documentation release
1 parent de2b678 commit ddc8a6d

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

api-specs/api/resources/as-associate.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ type: base
292292
example: !include ../examples/b2b-cart.example.json
293293
head:
294294
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
295-
description: Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
295+
description: Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
296296
post:
297297
displayName: Update cart by key in business unit
298298
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -336,7 +336,7 @@ type: base
336336
example: !include ../examples/b2b-cart.example.json
337337
head:
338338
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
339-
description: Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
339+
description: Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
340340
post:
341341
displayName: Update cart by id in business unit
342342
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]

api-specs/api/resources/carts.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ get:
2020
head:
2121
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
2222
displayName: Check if a Cart exists by Query Predicate
23-
description: Checks if one or more Carts exist for the provided query predicate. Returns a `200 OK` status if any Carts match the query predicate, or a `404 Not Found` otherwise.
23+
description: Checks if one or more Carts exist for the provided query predicate. Returns a `200 OK` status if any Carts match the query predicate, or [Not Found](/../api/errors#404-not-found) otherwise.
2424
queryParameters:
2525
where?:
2626
type: QueryPredicate[]
@@ -92,7 +92,7 @@ post:
9292
example: !include ../examples/cart.example.json
9393
head:
9494
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
95-
description: Checks if a Cart exists for a Customer. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
95+
description: Checks if a Cart exists for a Customer. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
9696
/key={key}:
9797
(methodName): withKey
9898
type:
@@ -112,7 +112,7 @@ post:
112112
example: !include ../examples/cart.example.json
113113
head:
114114
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
115-
description: Checks if a Cart exists for the provided `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
115+
description: Checks if a Cart exists for the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
116116
post:
117117
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
118118
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -153,7 +153,7 @@ post:
153153
example: !include ../examples/cart.example.json
154154
head:
155155
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
156-
description: Checks if a Cart exists for the provided `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise.
156+
description: Checks if a Cart exists for the provided `id`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
157157
post:
158158
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
159159
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).

api-specs/api/resources/in-store.raml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ uriParameters:
4747
],
4848
},
4949
]
50-
description: Checks if one or more Carts exist for the provided query predicate in a [Store](ctp:api:type:Store). Returns a `200 OK` status if any Carts match the query predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
50+
description: Checks if one or more Carts exist for the provided query predicate in a [Store](ctp:api:type:Store). Returns a `200 OK` status if any Carts match the query predicate or [Not Found](/../api/errors#404-not-found) otherwise.
5151
queryParameters:
5252
where?:
5353
type: QueryPredicate[]
@@ -128,7 +128,7 @@ uriParameters:
128128
],
129129
},
130130
]
131-
description: Checks if one or more Carts exist for a Customer in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
131+
description: Checks if one or more Carts exist for a Customer in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
132132
/key={key}:
133133
(methodName): withKey
134134
type:
@@ -174,7 +174,7 @@ uriParameters:
174174
],
175175
},
176176
]
177-
description: Checks if a Cart exists for the provided `key` in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
177+
description: Checks if a Cart exists for the provided `key` in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
178178
post:
179179
displayName: Update Cart in Store by Key
180180
securedBy:
@@ -304,7 +304,7 @@ uriParameters:
304304
],
305305
},
306306
]
307-
description: Checks if a Cart exists for the provided `id` in a Store. Returns a `200 OK` status if the Cart exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
307+
description: Checks if a Cart exists for the provided `id` in a Store. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
308308
post:
309309
displayName: Update Cart in Store by ID
310310
securedBy:
@@ -399,7 +399,7 @@ uriParameters:
399399
],
400400
},
401401
]
402-
description: Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
402+
description: Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
403403
queryParameters:
404404
where?:
405405
type: QueryPredicate[]
@@ -526,7 +526,7 @@ uriParameters:
526526
],
527527
},
528528
]
529-
description: Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
529+
description: Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
530530
post:
531531
displayName: Update Order in Store by OrderNumber
532532
securedBy:
@@ -614,7 +614,7 @@ uriParameters:
614614
],
615615
},
616616
]
617-
description: Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
617+
description: Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
618618
post:
619619
displayName: Update Order in Store by ID
620620
securedBy:
@@ -713,7 +713,7 @@ uriParameters:
713713
},
714714
]
715715
description: |
716-
Checks if a Cart exists for a Store that matches the given Query Predicate, and contains a matching `customerId` or `anonymousId`. Returns a `200 OK` status if any Carts match these conditions, or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
716+
Checks if a Cart exists for a Store that matches the given Query Predicate, and contains a matching `customerId` or `anonymousId`. Returns a `200 OK` status if any Carts match these conditions, or [Not Found](/../api/errors#404-not-found) otherwise.
717717
queryParameters:
718718
where?:
719719
type: QueryPredicate[]
@@ -1792,7 +1792,7 @@ uriParameters:
17921792
scopes:
17931793
- 'view_customers:{projectKey}'
17941794
- 'view_customers:{projectKey}:{storeKey}'
1795-
description: Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
1795+
description: Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
17961796
queryParameters:
17971797
where?:
17981798
type: QueryPredicate[]
@@ -2244,7 +2244,7 @@ uriParameters:
22442244
],
22452245
},
22462246
]
2247-
description: Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
2247+
description: Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
22482248
queryParameters:
22492249
where?:
22502250
type: QueryPredicate[]
@@ -2324,7 +2324,7 @@ uriParameters:
23242324
],
23252325
},
23262326
]
2327-
description: Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
2327+
description: Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or [Not Found](/../api/errors#404-not-found) otherwise.
23282328
post:
23292329
displayName: Update ShoppingList in Store by Key
23302330
securedBy:
@@ -2431,7 +2431,7 @@ uriParameters:
24312431
],
24322432
},
24332433
]
2434-
description: Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
2434+
description: Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or [Not Found](/../api/errors#404-not-found) otherwise.
24352435
post:
24362436
displayName: Update ShoppingList in Store by ID
24372437
securedBy:
@@ -3291,7 +3291,7 @@ uriParameters:
32913291
],
32923292
},
32933293
]
3294-
description: Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3294+
description: Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
32953295
queryParameters:
32963296
where?:
32973297
type: QueryPredicate[]
@@ -3355,7 +3355,7 @@ uriParameters:
33553355
],
33563356
},
33573357
]
3358-
description: Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3358+
description: Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or [Not Found](/../api/errors#404-not-found) otherwise.
33593359
post:
33603360
displayName: Update QuoteRequest in Store by Key
33613361
securedBy:
@@ -3435,7 +3435,7 @@ uriParameters:
34353435
],
34363436
},
34373437
]
3438-
description: Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3438+
description: Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or [Not Found](/../api/errors#404-not-found) otherwise.
34393439
post:
34403440
displayName: Update QuoteRequest in Store by ID
34413441
securedBy:
@@ -3520,7 +3520,7 @@ uriParameters:
35203520
],
35213521
},
35223522
]
3523-
description: Checks if a StagedQuote exists for a given Query Predicate. Returns a `200 OK` status if any StagedQuotes match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3523+
description: Checks if a StagedQuote exists for a given Query Predicate. Returns a `200 OK` status if any StagedQuotes match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
35243524
queryParameters:
35253525
where?:
35263526
type: QueryPredicate[]
@@ -3583,7 +3583,7 @@ uriParameters:
35833583
],
35843584
},
35853585
]
3586-
description: Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3586+
description: Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or [Not Found](/../api/errors#404-not-found) otherwise.
35873587
post:
35883588
displayName: Update StagedQuote in Store by Key
35893589
securedBy:
@@ -3663,7 +3663,7 @@ uriParameters:
36633663
],
36643664
},
36653665
]
3666-
description: Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3666+
description: Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or [Not Found](/../api/errors#404-not-found) otherwise.
36673667
post:
36683668
displayName: Update StagedQuote in Store by ID
36693669
securedBy:
@@ -3748,7 +3748,7 @@ uriParameters:
37483748
],
37493749
},
37503750
]
3751-
description: Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3751+
description: Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or [Not Found](/../api/errors#404-not-found) otherwise.
37523752
queryParameters:
37533753
where?:
37543754
type: QueryPredicate[]
@@ -3811,7 +3811,7 @@ uriParameters:
38113811
],
38123812
},
38133813
]
3814-
description: Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3814+
description: Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or [Not Found](/../api/errors#404-not-found) otherwise.
38153815
post:
38163816
displayName: Update Quote in Store by Key
38173817
securedBy:
@@ -3891,7 +3891,7 @@ uriParameters:
38913891
],
38923892
},
38933893
]
3894-
description: Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
3894+
description: Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or [Not Found](/../api/errors#404-not-found) otherwise.
38953895
post:
38963896
displayName: Update Quote in Store by ID
38973897
securedBy:

0 commit comments

Comments
 (0)