Skip to content

Commit 33d20f6

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent f2c3348 commit 33d20f6

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

oas/api/openapi.yaml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3483,7 +3483,7 @@ paths:
34833483
- "view_shopping_lists:{projectKey}"
34843484
operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsGet
34853485
description: |-
3486-
Retrieves all ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
3486+
Retrieves ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
34873487
parameters:
34883488
- name: expand
34893489
in: query
@@ -5466,7 +5466,7 @@ paths:
54665466
- "view_business_units:{projectKey}"
54675467
operationId: ByProjectKeyBusinessUnitsKeyByKeyAssociatesByAssociateIdGet
54685468
description: |-
5469-
Retrieves all roles and permissions of an Associate in a Business Unit.
5469+
Retrieves roles and permissions of an Associate in a Business Unit.
54705470
responses:
54715471
"200":
54725472
description: |-
@@ -5796,7 +5796,7 @@ paths:
57965796
- "view_business_units:{projectKey}"
57975797
operationId: ByProjectKeyBusinessUnitsByBusinessUnitIdAssociatesByAssociateIdGet
57985798
description: |-
5799-
Retrieves all roles and permissions of an Associate in a Business Unit.
5799+
Retrieves roles and permissions of an Associate in a Business Unit.
58005800
responses:
58015801
"200":
58025802
description: |-
@@ -6372,7 +6372,7 @@ paths:
63726372
- "view_orders:{projectKey}"
63736373
operationId: ByProjectKeyCartsGet
63746374
description: |-
6375-
Retrieves all Carts in the Project.
6375+
Retrieves Carts in the Project.
63766376
parameters:
63776377
- name: expand
63786378
in: query
@@ -11555,7 +11555,7 @@ paths:
1155511555
- "view_business_units:{projectKey}"
1155611556
operationId: ByProjectKeyInStoreKeyByStoreKeyBusinessUnitsKeyByKeyAssociatesByAssociateIdGet
1155711557
description: |-
11558-
Retrieves all roles and permissions of an Associate in a Business Unit in a Store.
11558+
Retrieves roles and permissions of an Associate in a Business Unit in a Store.
1155911559
responses:
1156011560
"200":
1156111561
description: |-
@@ -11786,7 +11786,7 @@ paths:
1178611786
- "view_business_units:{projectKey}"
1178711787
operationId: ByProjectKeyInStoreKeyByStoreKeyBusinessUnitsByBusinessUnitIdAssociatesByAssociateIdGet
1178811788
description: |-
11789-
Retrieves all roles and permissions of an Associate in a Business Unit in a Store.
11789+
Retrieves roles and permissions of an Associate in a Business Unit in a Store.
1179011790
responses:
1179111791
"200":
1179211792
description: |-
@@ -12414,7 +12414,7 @@ paths:
1241412414
- "view_orders:{projectKey}:{storeKey}"
1241512415
operationId: ByProjectKeyInStoreKeyByStoreKeyCartsGet
1241612416
description: |-
12417-
Retrieves all Carts in a [Store](ctp:api:type:Store).
12417+
Retrieves Carts in a [Store](ctp:api:type:Store).
1241812418
parameters:
1241912419
- name: expand
1242012420
in: query
@@ -14456,7 +14456,7 @@ paths:
1445614456
- "anonymous_id:{id}"
1445714457
operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsGet
1445814458
description: |-
14459-
Returns all Carts that match a given Query Predicate and contain either a matching `customerId` or `anonymousId` in a Store.
14459+
Retrieves Carts for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store).
1446014460
parameters:
1446114461
- name: expand
1446214462
in: query
@@ -15431,7 +15431,7 @@ paths:
1543115431
- "anonymous_id:{id}"
1543215432
operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet
1543315433
description: |-
15434-
Retrieves all ShoppingLists for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns `200 OK` status if successful.
15434+
Retrieves ShoppingLists for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns `200 OK` status if successful.
1543515435

1543615436
A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
1543715437

@@ -18985,7 +18985,7 @@ paths:
1898518985
- "manage_my_orders:{projectKey}:{storeKey}"
1898618986
operationId: ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
1898718987
description: |-
18988-
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
18988+
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
1898918989
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
1899018990
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
1899118991
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
@@ -19089,7 +19089,7 @@ paths:
1908919089
- "view_shopping_lists:{projectKey}:{storeKey}"
1909019090
operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsGet
1909119091
description: |-
19092-
Retrieves all ShoppingLists in a [Store](ctp:api:type:Store).
19092+
Retrieves ShoppingLists in a [Store](ctp:api:type:Store).
1909319093
parameters:
1909419094
- name: expand
1909519095
in: query
@@ -21090,7 +21090,7 @@ paths:
2109021090
- "customer_id:{id}"
2109121091
operationId: ByProjectKeyMeBusinessUnitsGet
2109221092
description: |-
21093-
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.
21093+
Retrieves Business Units for the authenticated Customer. Returns a `200 OK` status if successful, or a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
2109421094
parameters:
2109521095
- name: expand
2109621096
in: query
@@ -21536,7 +21536,7 @@ paths:
2153621536
- "anonymous_id:{id}"
2153721537
operationId: ByProjectKeyMeCartsGet
2153821538
description: |-
21539-
Returns all Carts that match a given Query Predicate and contain either a matching `customerId` or `anonymousId`.
21539+
Retrieves Carts for the authenticated Customer or anonymous user.
2154021540
parameters:
2154121541
- name: expand
2154221542
in: query
@@ -22556,7 +22556,7 @@ paths:
2255622556
- "anonymous_id:{id}"
2255722557
operationId: ByProjectKeyMePaymentsGet
2255822558
description: |-
22559-
Retrieves all [Payments](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
22559+
Retrieves [Payments](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
2256022560
parameters:
2256122561
- name: expand
2256222562
in: query
@@ -22932,7 +22932,7 @@ paths:
2293222932
- "customer_id:{id}"
2293322933
operationId: ByProjectKeyMeQuoteRequestsGet
2293422934
description: |-
22935-
Returns all Quote Requests that match a given Query Predicate. Returns a `200 OK` status if successful.
22935+
Retrieves Quote Requests for the authenticated Customer. Returns a `200 OK` status if successful.
2293622936
parameters:
2293722937
- name: expand
2293822938
in: query
@@ -23756,7 +23756,7 @@ paths:
2375623756
- "anonymous_id:{id}"
2375723757
operationId: ByProjectKeyMeShoppingListsGet
2375823758
description: |-
23759-
Retrieves all ShoppingLists for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
23759+
Retrieves ShoppingLists for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
2376023760

2376123761
A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
2376223762

@@ -25956,7 +25956,7 @@ paths:
2595625956
- "view_payments:{projectKey}"
2595725957
operationId: ByProjectKeyPaymentsGet
2595825958
description: |-
25959-
Retrieves all Payments in the Project.
25959+
Retrieves Payments in the Project.
2596025960
parameters:
2596125961
- name: expand
2596225962
in: query
@@ -32739,7 +32739,7 @@ paths:
3273932739
- "manage_my_orders:{projectKey}"
3274032740
operationId: ByProjectKeyShippingMethodsMatchingCartGet
3274132741
description: |-
32742-
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart.
32742+
Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart.
3274332743
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
3274432744
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
3274532745
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
@@ -32836,7 +32836,7 @@ paths:
3283632836
- "manage_my_orders:{projectKey}"
3283732837
operationId: ByProjectKeyShippingMethodsMatchingCartLocationGet
3283832838
description: |-
32839-
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
32839+
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location)
3284032840
with a `predicate` that matches the given Cart.
3284132841
Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
3284232842
This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction).
@@ -32962,7 +32962,7 @@ paths:
3296232962
- "manage_my_orders:{projectKey}"
3296332963
operationId: ByProjectKeyShippingMethodsMatchingLocationGet
3296432964
description: |-
32965-
Retrieves all the active ShippingMethods that can ship to the given [Location](/projects/zones#location).
32965+
Retrieves the active ShippingMethods that can ship to the given [Location](/projects/zones#location).
3296632966
ShippingMethods that have a `predicate` defined are automatically disqualified.
3296732967
If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency.
3296832968
Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`.
@@ -33097,7 +33097,7 @@ paths:
3309733097
- "view_shipping_methods:{projectKey}"
3309833098
operationId: ByProjectKeyShippingMethodsMatchingOrdereditGet
3309933099
description: |-
33100-
Retrieves all the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
33100+
Retrieves the active ShippingMethods that can ship to the given [Location](ctp:api:type:Location) for an [OrderEdit](ctp:api:type:OrderEdit).
3310133101
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.
3310233102
If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
3310333103
parameters:
@@ -33385,7 +33385,7 @@ paths:
3338533385
- "view_shopping_lists:{projectKey}"
3338633386
operationId: ByProjectKeyShoppingListsGet
3338733387
description: |-
33388-
Retrieves all ShoppingLists in the Project.
33388+
Retrieves ShoppingLists in the Project.
3338933389
parameters:
3339033390
- name: expand
3339133391
in: query

0 commit comments

Comments
 (0)