Skip to content

Commit 3ef38b7

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 91ef231 commit 3ef38b7

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

oas/api/openapi.yaml

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9235,9 +9235,6 @@ paths:
92359235
- "manage_customers:{projectKey}"
92369236
operationId: ByProjectKeyCustomersPost
92379237
description: |-
9238-
If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart).
9239-
Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`.
9240-
92419238
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
92429239
parameters:
92439240
- name: expand
@@ -13865,10 +13862,10 @@ paths:
1386513862
description: |-
1386613863
When using this endpoint, if omitted, the Customer `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter.
1386713864

13868-
If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart).
13869-
Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`.
1387013865
If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter.
1387113866

13867+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
13868+
1387213869
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
1387313870
parameters:
1387413871
- name: expand
@@ -14711,11 +14708,9 @@ paths:
1471114708
- "manage_customers:{projectKey}:{storeKey}"
1471214709
operationId: ByProjectKeyInStoreKeyByStoreKeyLoginPost
1471314710
description: |-
14714-
Authenticates a Customer associated with a [Store](ctp:api:type:Store). For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
14715-
14716-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
14711+
Authenticates a Customer associated with a [Store](ctp:api:type:Store).
1471714712

14718-
Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
14713+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
1471914714

1472014715
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error.
1472114716
requestBody:
@@ -15508,8 +15503,6 @@ paths:
1550815503
- If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart.
1550915504
- If the Customer already has a Cart, the most recently modified anonymous cart is handled according to [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
1551015505

15511-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
15512-
1551315506
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
1551415507
requestBody:
1551515508
content:
@@ -16675,7 +16668,7 @@ paths:
1667516668

1667616669
If omitted in the request body, the [Customer](ctp:api:type:Customer) `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter.
1667716670

16678-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
16671+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
1667916672

1668016673
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message.
1668116674
requestBody:
@@ -21363,13 +21356,9 @@ paths:
2136321356
- "manage_customers:{projectKey}"
2136421357
operationId: ByProjectKeyLoginPost
2136521358
description: |-
21366-
Authenticates a global Customer not associated with a Store.
21367-
For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers).
21368-
If the Customer is registered in a Store, use the [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) method.
21369-
21370-
Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in).
21359+
Authenticates a global Customer.
2137121360

21372-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
21361+
If the Customer has multiple active Carts, the anonymous Cart is [merged](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up) into the most recently modified active Cart.
2137321362

2137421363
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
2137521364
requestBody:
@@ -22648,8 +22637,6 @@ paths:
2264822637
- If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart.
2264922638
- If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode).
2265022639

22651-
A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#update-a-cart) with the latest prices, taxes, and discounts. During these updates, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
22652-
2265322640
If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned.
2265422641
requestBody:
2265522642
content:
@@ -48023,8 +48010,8 @@ components:
4802348010
x-annotation-package: "Customer"
4802448011
x-annotation-enumDescriptions:
4802548012
MergeWithExistingCustomerCart: "If set, the content of an anonymous [Cart is merged
48026-
during sign-in](/../api/customers-overview#cart-merge-during-sign-in) with the
48027-
Customer's most recently modified active Cart."
48013+
during sign-in](/../api/customers-overview#cart-merge-during-sign-in-and-sign-up)
48014+
with the Customer's most recently modified active Cart."
4802848015
UseAsNewActiveCustomerCart: "If set, an anonymous Cart is used as the new active Customer
4802948016
Cart, and no [LineItems](ctp:api:type:LineItem) or [CustomLineItems](ctp:api:type:CustomLineItem)
4803048017
are merged."

0 commit comments

Comments
 (0)