Skip to content

Commit f2c3348

Browse files
committed
Updated API from documentation release
1 parent c3e6bf1 commit f2c3348

File tree

8 files changed

+22
-22
lines changed

8 files changed

+22
-22
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ type: base
402402
shopping-lists e.g. for wishlist support
403403
get:
404404
displayName: Query ShoppingLists in BusinessUnit
405-
description: Retrieves all ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
405+
description: Retrieves ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
406406
securedBy: [oauth_2_0: { scopes: ['view_shopping_lists:{projectKey}'] }]
407407
queryParameters:
408408
expand:

api-specs/api/resources/business-units.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ post:
112112
get:
113113
displayName: Get Associate in BusinessUnit by Key
114114
description: |
115-
Retrieves all roles and permissions of an Associate in a Business Unit.
115+
Retrieves roles and permissions of an Associate in a Business Unit.
116116
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
117117
responses:
118118
200:
@@ -132,7 +132,7 @@ post:
132132
get:
133133
displayName: Get Associate in BusinessUnit by ID
134134
description: |
135-
Retrieves all roles and permissions of an Associate in a Business Unit.
135+
Retrieves roles and permissions of an Associate in a Business Unit.
136136
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
137137
responses:
138138
200:

api-specs/api/resources/carts.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ type:
1111
description: A shopping cart holds product variants and can be ordered.
1212
get:
1313
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
14-
description: Retrieves all Carts in the Project.
14+
description: Retrieves Carts in the Project.
1515
responses:
1616
200:
1717
body:

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ uriParameters:
2828
},
2929
]
3030
displayName: Query Carts in Store
31-
description: Retrieves all Carts in a [Store](ctp:api:type:Store).
31+
description: Retrieves Carts in a [Store](ctp:api:type:Store).
3232
responses:
3333
200:
3434
body:
@@ -699,7 +699,7 @@ uriParameters:
699699
},
700700
]
701701
description: |
702-
Returns all Carts that match a given Query Predicate and contain either a matching `customerId` or `anonymousId` in a Store.
702+
Retrieves Carts for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store).
703703
responses:
704704
200:
705705
body:
@@ -1118,7 +1118,7 @@ uriParameters:
11181118
get:
11191119
displayName: Query My ShoppingLists in Store
11201120
description: |
1121-
Retrieves all ShoppingLists for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns `200 OK` status if successful.
1121+
Retrieves ShoppingLists for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns `200 OK` status if successful.
11221122
11231123
A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
11241124
@@ -2169,7 +2169,7 @@ uriParameters:
21692169
get:
21702170
displayName: Get ShippingMethods for a cart in a store
21712171
description: |
2172-
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
2172+
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
21732173
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
21742174
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
21752175
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
@@ -2223,7 +2223,7 @@ uriParameters:
22232223
shopping-lists e.g. for wishlist support
22242224
get:
22252225
displayName: Query ShoppingLists in Store
2226-
description: Retrieves all ShoppingLists in a [Store](ctp:api:type:Store).
2226+
description: Retrieves ShoppingLists in a [Store](ctp:api:type:Store).
22272227
securedBy:
22282228
[
22292229
oauth_2_0:
@@ -4180,7 +4180,7 @@ uriParameters:
41804180
get:
41814181
displayName: Get Associate in BusinessUnit in Store by Key
41824182
description: |
4183-
Retrieves all roles and permissions of an Associate in a Business Unit in a Store.
4183+
Retrieves roles and permissions of an Associate in a Business Unit in a Store.
41844184
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
41854185
responses:
41864186
200:
@@ -4200,7 +4200,7 @@ uriParameters:
42004200
get:
42014201
displayName: Get Associate in BusinessUnit in Store by ID
42024202
description: |
4203-
Retrieves all roles and permissions of an Associate in a Business Unit in a Store.
4203+
Retrieves roles and permissions of an Associate in a Business Unit in a Store.
42044204
securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
42054205
responses:
42064206
200:

api-specs/api/resources/me.raml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ delete:
255255
get:
256256
displayName: Query My Business Units
257257
description: |
258-
Returns all of the authenticated Customer’s Business Units in a Project. Returns a `200 OK` status if successful, or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
258+
Retrieves Business Units for the authenticated Customer. Returns a `200 OK` status if successful, or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
259259
260260
securedBy:
261261
[
@@ -443,7 +443,7 @@ delete:
443443
},
444444
]
445445
description: |
446-
Returns all Carts that match a given Query Predicate and contain either a matching `customerId` or `anonymousId`.
446+
Retrieves Carts for the authenticated Customer or anonymous user.
447447
responses:
448448
200:
449449
body:
@@ -873,7 +873,7 @@ delete:
873873
specific user.
874874
get:
875875
displayName: Query My Payments
876-
description: Retrieves all [Payments](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
876+
description: Retrieves [Payments](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
877877
securedBy:
878878
[
879879
oauth_2_0:
@@ -1040,7 +1040,7 @@ delete:
10401040
get:
10411041
displayName: Query My QuoteRequests
10421042
description: |
1043-
Returns all Quote Requests that match a given Query Predicate. Returns a `200 OK` status if successful.
1043+
Retrieves Quote Requests for the authenticated Customer. Returns a `200 OK` status if successful.
10441044
securedBy:
10451045
[
10461046
oauth_2_0:
@@ -1331,7 +1331,7 @@ delete:
13311331
},
13321332
]
13331333
description: |
1334-
Retrieves all ShoppingLists for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
1334+
Retrieves ShoppingLists for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
13351335
13361336
A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
13371337

api-specs/api/resources/payments.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description:
1313
refunding money
1414
get:
1515
securedBy: [oauth_2_0: { scopes: ['view_payments:{projectKey}'] }]
16-
description: Retrieves all Payments in the Project.
16+
description: Retrieves Payments in the Project.
1717
responses:
1818
200:
1919
body:

api-specs/api/resources/shipping-methods.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ post:
146146
get:
147147
displayName: Get ShippingMethods for a cart
148148
description: |
149-
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart.
149+
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart.
150150
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
151151
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
152152
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
@@ -200,7 +200,7 @@ post:
200200
get:
201201
displayName: Get ShippingMethods for a cart and location
202202
description: |
203-
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
203+
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
204204
with a `predicate` that matches the given Cart.
205205
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
206206
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
@@ -271,7 +271,7 @@ post:
271271
get:
272272
displayName: Get ShippingMethods for an order edit
273273
description: |
274-
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
274+
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
275275
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
276276
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
277277
securedBy:
@@ -334,7 +334,7 @@ post:
334334
get:
335335
displayName: Get ShippingMethods for a location
336336
description: |
337-
Retrieves all the active ShippingMethods that can ship to the given [Location](/projects/zones#location).
337+
Retrieves the active ShippingMethods that can ship to the given [Location](/projects/zones#location).
338338
ShippingMethods that have a `predicate` defined are automatically disqualified.
339339
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
340340
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.

api-specs/api/resources/shopping-lists.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ get:
1717
When expanding `variant` and `productSlug` on [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem), [expand the entire array](/general-concepts#reference-expansion). You cannot expand a single element (for example, `expand=lineItems[0].variant` is not supported).
1818
type: Expansion[]
1919
required: false
20-
description: Retrieves all ShoppingLists in the Project.
20+
description: Retrieves ShoppingLists in the Project.
2121
responses:
2222
200:
2323
body:

0 commit comments

Comments
 (0)