Skip to content

Commit 72e5855

Browse files
committed
Updated API from documentation release
1 parent 169d29c commit 72e5855

34 files changed

+4276
-4475
lines changed

api-specs/api/api.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ resourceTypes:
269269
/extensions: !include resources/extensions.raml
270270
/api-clients: !include resources/api-clients.raml
271271
/stores: !include resources/stores.raml
272-
/in-store/key={storeKey}: !include resources/in-store.raml
272+
/in-store/key={storeKey}: !include resources/in-store/in-store.raml
273273
/standalone-prices: !include resources/standalone-prices.raml
274274
/in-business-unit/key={businessUnitKey}: !include resources/in-business-unit.raml
275275
/attribute-groups: !include resources/attribute-groups.raml

api-specs/api/resources/carts.raml

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ type:
1010
(createable): CartDraft
1111
description: A shopping cart holds product variants and can be ordered.
1212
get:
13-
displayName: Query Carts
1413
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
1514
description: Retrieves Carts in the Project.
1615
responses:
@@ -19,14 +18,13 @@ get:
1918
application/json:
2019
example: !include ../examples/carts.example.json
2120
head:
22-
displayName: Check if Cart exists by Query Predicate
2321
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
22+
displayName: Check if a Cart exists by Query Predicate
2423
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.
2524
queryParameters:
2625
where?:
2726
type: QueryPredicate[]
2827
post:
29-
displayName: Create Cart
3028
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
3129
description: |
3230
@@ -89,7 +87,6 @@ post:
8987
uriParameterName: customerId
9088
resourceType: Cart
9189
get:
92-
displayName: Get Cart by Customer ID
9390
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
9491
description: |
9592
Retrieves the most recently modified active Cart of a Customer with [CartOrigin](ctp:api:type:CartOrigin) `Customer`. If no active Cart exists, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
@@ -101,7 +98,6 @@ post:
10198
application/json:
10299
example: !include ../examples/cart.example.json
103100
head:
104-
displayName: Check if Cart exists by Customer ID
105101
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
106102
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.
107103
/key={key}:
@@ -112,7 +108,6 @@ post:
112108
resourceType: Cart
113109
resourceUpdateType: CartUpdate
114110
get:
115-
displayName: Get Cart by Key
116111
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
117112
description: |
118113
Retrieves a Cart with the provided `key`.
@@ -123,11 +118,9 @@ post:
123118
application/json:
124119
example: !include ../examples/cart.example.json
125120
head:
126-
displayName: Check if Cart exists by Key
127121
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
128122
description: Checks if a Cart exists with the provided `key`. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
129123
post:
130-
displayName: Update Cart by Key
131124
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
132125
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
133126
body:
@@ -139,7 +132,6 @@ post:
139132
application/json:
140133
example: !include ../examples/cart.example.json
141134
delete:
142-
displayName: Delete Cart by Key
143135
is:
144136
- dataErasure
145137
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
@@ -157,7 +149,6 @@ post:
157149
resourceType: Cart
158150
resourceUpdateType: CartUpdate
159151
get:
160-
displayName: Get Cart by ID
161152
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
162153
description: |
163154
Retrieves a Cart with the provided `id`.
@@ -168,11 +159,9 @@ post:
168159
application/json:
169160
example: !include ../examples/cart.example.json
170161
head:
171-
displayName: Check if Cart exists by ID
172162
securedBy: [oauth_2_0: { scopes: ['view_orders:{projectKey}'] }]
173163
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.
174164
post:
175-
displayName: Update Cart by ID
176165
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]
177166
description: Updates a Cart in the Project using one or more [update actions](/../api/projects/carts#update-actions).
178167
body:
@@ -184,7 +173,6 @@ post:
184173
application/json:
185174
example: !include ../examples/cart.example.json
186175
delete:
187-
displayName: Delete Cart by ID
188176
is:
189177
- dataErasure
190178
securedBy: [oauth_2_0: { scopes: ['manage_orders:{projectKey}'] }]

api-specs/api/resources/categories.raml

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ type:
1010
(createable): CategoryDraft
1111
description: Categories are used to organize products in a hierarchical structure.
1212
get:
13-
displayName: Query Categories
1413
description: |
1514
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
1615
securedBy:
@@ -27,7 +26,6 @@ get:
2726
application/json:
2827
example: !include ../examples/categories.example.json
2928
head:
30-
displayName: Check if Category exists by Query Predicate
3129
securedBy:
3230
[
3331
oauth_2_0:
@@ -46,7 +44,6 @@ head:
4644
[Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
4745
[Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
4846
post:
49-
displayName: Create Category
5047
description: |
5148
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
5249
@@ -75,7 +72,6 @@ post:
7572
resourceType: Category
7673
resourceUpdateType: CategoryUpdate
7774
get:
78-
displayName: Get Category by Key
7975
description: |
8076
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
8177
securedBy:
@@ -92,7 +88,6 @@ post:
9288
application/json:
9389
example: !include ../examples/category.example.json
9490
head:
95-
displayName: Check if Category exists by Key
9691
securedBy:
9792
[
9893
oauth_2_0:
@@ -103,7 +98,6 @@ post:
10398
]
10499
description: Checks if a Category exists with the provided `key`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.
105100
post:
106-
displayName: Update Category by Key
107101
description: |
108102
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
109103
securedBy:
@@ -126,7 +120,6 @@ post:
126120
application/json:
127121
example: !include ../examples/category.example.json
128122
delete:
129-
displayName: Delete Category by Key
130123
description: |
131124
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
132125
securedBy:
@@ -153,7 +146,6 @@ post:
153146
resourceType: Category
154147
resourceUpdateType: CategoryUpdate
155148
get:
156-
displayName: Get Category by ID
157149
description: |
158150
Either the [scope](/../api/scopes) `view_products:{projectKey}` or `view_categories:{projectKey}` is required.
159151
securedBy:
@@ -170,7 +162,6 @@ post:
170162
application/json:
171163
example: !include ../examples/category.example.json
172164
head:
173-
displayName: Check if Category exists by ID
174165
securedBy:
175166
[
176167
oauth_2_0:
@@ -181,7 +172,6 @@ post:
181172
]
182173
description: Checks if a Category exists with the provided `id`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise.
183174
post:
184-
displayName: Update Category by ID
185175
description: |
186176
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
187177
securedBy:
@@ -204,7 +194,6 @@ post:
204194
application/json:
205195
example: !include ../examples/category.example.json
206196
delete:
207-
displayName: Delete Category by ID
208197
description: |
209198
Either the [scope](/../api/scopes) `manage_products:{projectKey}` or `manage_categories:{projectKey}` is required.
210199
securedBy:

0 commit comments

Comments
 (0)