Skip to content

Commit 9e27b6b

Browse files
committed
Updated API from documentation release
1 parent a7aa20c commit 9e27b6b

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2158,6 +2158,7 @@ uriParameters:
21582158
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
21592159
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
21602160
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
2161+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
21612162
is:
21622163
- expandable
21632164
securedBy:

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ post:
149149
Retrieves all 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).
152+
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
152153
is:
153154
- expandable
154155
securedBy:
@@ -192,7 +193,7 @@ post:
192193
type: string
193194
description: |
194195
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.
196197
/matching-cart-location:
197198
type: base
198199
description: Get ShippingMethods for a cart and location
@@ -203,6 +204,7 @@ post:
203204
with a `predicate` that matches the given Cart.
204205
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
205206
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.
206208
is:
207209
- expandable
208210
securedBy:
@@ -270,7 +272,7 @@ post:
270272
displayName: Get ShippingMethods for an order edit
271273
description: |
272274
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.
274276
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
275277
securedBy:
276278
[
@@ -337,6 +339,7 @@ post:
337339
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
338340
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
339341
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.
340343
is:
341344
- expandable
342345
- sortable

api-specs/api/types/shipping-method/ShippingMethod.raml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ properties:
6464
default: true
6565
isDefault:
6666
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.
6869
predicate?:
6970
type: string
7071
description: |

api-specs/api/types/shipping-method/ShippingMethodDraft.raml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ properties:
3737
If set to `true`, the ShippingMethod can be used during the creation or update of a Cart or Order.
3838
default: true
3939
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.
4142
type: boolean
4243
predicate?:
4344
type: string

0 commit comments

Comments
 (0)