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
Copy file name to clipboardExpand all lines: api-specs/api/resources/shipping-methods.raml
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -149,6 +149,7 @@ post:
149
149
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart.
150
150
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
151
151
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
152
+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
152
153
is:
153
154
- expandable
154
155
securedBy:
@@ -192,7 +193,7 @@ post:
192
193
type: string
193
194
description: |
194
195
ID of the Cart with a shipping address set.
195
-
description: Checks if an active ShippingMethod exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
196
+
description: Checks if an active ShippingMethod exists for the given Cart. If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise.
196
197
/matching-cart-location:
197
198
type: base
198
199
description: Get ShippingMethods for a cart and location
@@ -203,6 +204,7 @@ post:
203
204
with a `predicate` that matches the given Cart.
204
205
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
205
206
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
207
+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
206
208
is:
207
209
- expandable
208
210
securedBy:
@@ -270,7 +272,7 @@ post:
270
272
displayName: Get ShippingMethods for an order edit
271
273
description: |
272
274
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
273
-
275
+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
274
276
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
275
277
securedBy:
276
278
[
@@ -337,6 +339,7 @@ post:
337
339
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
338
340
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
339
341
If the `currency` parameter is given, exactly one ShippingRate will contain it.
342
+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
Copy file name to clipboardExpand all lines: api-specs/api/types/shipping-method/ShippingMethod.raml
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,8 @@ properties:
64
64
default: true
65
65
isDefault:
66
66
type: boolean
67
-
description: If `true`, this ShippingMethod is the [Project](ctp:api:type:Project)'s default ShippingMethod.
67
+
description: |
68
+
If `true`, this ShippingMethod is the [Project](ctp:api:type:Project)'s default ShippingMethod. When retrieving [matching Shipping Methods](/projects/shippingMethods#get-matching-shipping-methods), it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.
Copy file name to clipboardExpand all lines: api-specs/api/types/shipping-method/ShippingMethodDraft.raml
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,8 @@ properties:
37
37
If set to `true`, the ShippingMethod can be used during the creation or update of a Cart or Order.
38
38
default: true
39
39
isDefault:
40
-
description: If set to `true`, the ShippingMethod will be the [Project](ctp:api:type:Project)'s default ShippingMethod.
40
+
description: |
41
+
If set to `true`, the ShippingMethod will be the [Project](ctp:api:type:Project)'s default ShippingMethod. When retrieving [matching Shipping Methods](/projects/shippingMethods#get-matching-shipping-methods), it is returned as the first item in the array. This flag does not automatically apply the Shipping Method to Carts.
0 commit comments