You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Creates a [Cart](ctp:api:type:Cart) in the [BusinessUnit](ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on [CartDraft](ctp:api:type:CartDraft) is ignored for this request.
258
+
Creates a Cart in the [BusinessUnit](ctp:api:type:BusinessUnit) referenced by `businessUnitKey`. As such, the `businessUnit` field on [CartDraft](ctp:api:type:CartDraft) is ignored for this request.
259
259
Creating a Cart can fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match the Cart.
description: Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate, or a `404 Not Found` otherwise.
22
+
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.
If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, or if the Shipping Method is not active, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
Copy file name to clipboardExpand all lines: api-specs/api/resources/in-store.raml
+20-8Lines changed: 20 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ uriParameters:
28
28
},
29
29
]
30
30
displayName: Query Carts in Store
31
-
description: Queries Carts in a specific [Store](ctp:api:type:Store).
31
+
description: Retrieves all Carts in a [Store](ctp:api:type:Store).
32
32
responses:
33
33
200:
34
34
body:
@@ -47,12 +47,11 @@ uriParameters:
47
47
],
48
48
},
49
49
]
50
-
description: Checks if a Cart exists for a given Query Predicate. 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 a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
51
51
queryParameters:
52
52
where?:
53
53
type: QueryPredicate[]
54
54
post:
55
-
displayName: Create Cart in Store
56
55
securedBy:
57
56
[
58
57
oauth_2_0:
@@ -64,8 +63,9 @@ uriParameters:
64
63
],
65
64
},
66
65
]
66
+
displayName: Create Cart in Store
67
67
description: |
68
-
Creates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`.
68
+
Creates a Cart in a [Store](ctp:api:type:Store).
69
69
70
70
If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, or if the Shipping Method is not active, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
71
71
@@ -128,7 +128,7 @@ uriParameters:
128
128
],
129
129
},
130
130
]
131
-
description: Checks if a Cart of a Customer exists. 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 a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
132
132
/key={key}:
133
133
(methodName): withKey
134
134
type:
@@ -150,6 +150,9 @@ uriParameters:
150
150
},
151
151
]
152
152
description: |
153
+
154
+
Retrieves a Cart with the provided `key` in a [Store](ctp:api:type:Store).
155
+
153
156
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
154
157
155
158
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
@@ -171,7 +174,7 @@ uriParameters:
171
174
],
172
175
},
173
176
]
174
-
description: Checks if a Cart exists for a given `key`. 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 a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
175
178
post:
176
179
displayName: Update Cart in Store by Key
177
180
securedBy:
@@ -186,6 +189,8 @@ uriParameters:
186
189
},
187
190
]
188
191
description: |
192
+
Updates a Cart in a [Store](ctp:api:type:Store) using one or more [update actions](/../projects/carts#update-actions).
193
+
189
194
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
190
195
body:
191
196
application/json:
@@ -198,6 +203,8 @@ uriParameters:
198
203
delete:
199
204
displayName: Delete Cart in Store by Key
200
205
description: |
206
+
Deletes a Cart in a [Store](ctp:api:type:Store).
207
+
201
208
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
202
209
is:
203
210
- dataErasure
@@ -274,6 +281,8 @@ uriParameters:
274
281
},
275
282
]
276
283
description: |
284
+
Retrieves a Cart with the provided `id` in a [Store](ctp:api:type:Store).
285
+
277
286
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
278
287
279
288
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the [Recalculate](ctp:api:type:CartRecalculateAction) update action.
@@ -295,7 +304,7 @@ uriParameters:
295
304
],
296
305
},
297
306
]
298
-
description: Checks if a Cart exists for a given `id`. 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 a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
299
308
post:
300
309
displayName: Update Cart in Store by ID
301
310
securedBy:
@@ -310,7 +319,8 @@ uriParameters:
310
319
},
311
320
]
312
321
description: |
313
-
Updates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`.
322
+
Updates a Cart in a [Store](ctp:api:type:Store) using one or more [update actions](/../projects/carts#update-actions).
323
+
314
324
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
315
325
body:
316
326
application/json:
@@ -323,6 +333,8 @@ uriParameters:
323
333
delete:
324
334
displayName: Delete Cart in Store by ID
325
335
description: |
336
+
Deletes a Cart in a [Store](ctp:api:type:Store).
337
+
326
338
If the Cart exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
0 commit comments