diff --git a/api-specs/api/examples/ShoppingList/ShoppingListSetAnonymousIdAction.json b/api-specs/api/examples/ShoppingList/ShoppingListSetAnonymousIdAction.json index ced3ac829..86fd3677d 100644 --- a/api-specs/api/examples/ShoppingList/ShoppingListSetAnonymousIdAction.json +++ b/api-specs/api/examples/ShoppingList/ShoppingListSetAnonymousIdAction.json @@ -1,4 +1,4 @@ { "action": "setAnonymousId", - "anonymousId": "ThisIsMyID" -} \ No newline at end of file + "anonymousId": "anonymousId" +} diff --git a/api-specs/api/resources/as-associate.raml b/api-specs/api/resources/as-associate.raml index 4e9d9fdaf..42d57ca5f 100644 --- a/api-specs/api/resources/as-associate.raml +++ b/api-specs/api/resources/as-associate.raml @@ -257,6 +257,14 @@ type: base description: | 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. 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. + + Specific Error Codes: + + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: example: !include ../examples/cart-create.example.json @@ -365,6 +373,12 @@ type: base The new Cart does not contain Payments or Deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. If the Cart exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. + + Specific Error Codes: + + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: example: !include ../examples/cart-replicate.example.json @@ -408,6 +422,16 @@ type: base Creates an Order from a [Cart](ctp:api:type:Cart) in a [BusinessUnit](ctp:api:type:BusinessUnit). The Cart must have a shipping address set before creating an Order. Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter. + + Specific Error Codes: + + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [OutOfStock](ctp:api:type:OutOfStockError) + - [PriceChanged](ctp:api:type:PriceChangedError) + - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) body: application/json: example: !include ../examples/order-create.example.json @@ -426,6 +450,11 @@ type: base description: | Creates an Order from a [Quote](ctp:api:type:Cart) in a [BusinessUnit](ctp:api:type:BusinessUnit). Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Quote does not reference the same BusinessUnit as the `businessUnitKey` path parameter. + + Specific Error Codes: + + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [OutOfStock](ctp:api:type:OutOfStockError) body: application/json: example: !include ../examples/order-from-quote.example.json diff --git a/api-specs/api/resources/carts.raml b/api-specs/api/resources/carts.raml index 5d8f4f58a..2ec7d4e4a 100644 --- a/api-specs/api/resources/carts.raml +++ b/api-specs/api/resources/carts.raml @@ -28,6 +28,14 @@ post: Creating a Cart fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error if the [ShippingMethod](ctp:api:type:ShippingMethod) referenced in the CartDraft has a `predicate` that does not match the Cart. + + Specific Error Codes: + + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: example: !include ../examples/cart-create.example.json @@ -46,6 +54,11 @@ post: The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` [CartState](ctp:api:type:CartState). The new Cart does not contain Payments or Deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. + + Specific Error Codes: + + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) body: application/json: example: !include ../examples/cart-replicate.example.json diff --git a/api-specs/api/resources/in-store.raml b/api-specs/api/resources/in-store.raml index 7a583364e..91f8b727c 100644 --- a/api-specs/api/resources/in-store.raml +++ b/api-specs/api/resources/in-store.raml @@ -67,6 +67,15 @@ uriParameters: Creates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`. When using this endpoint the Cart's `store` field is always set to the [Store](ctp:api:type:Store) specified in the path parameter. If the referenced [ShippingMethod](ctp:api:type:ShippingMethod) in the [CartDraft](ctp:api:type:CartDraft) has a predicate that does not match, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. + + Specific Error Codes: + + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) + body: application/json: example: !include ../examples/cart-create.example.json @@ -215,6 +224,11 @@ uriParameters: The replicated Cart preserves Customer information, Line Items and Custom Line Items, Custom Fields, Discount Codes, and other settings of the Cart or Order. If the Line Items become invalid, for example, due to removed Products or Prices, they are removed from the new Cart. If the Customer switches to another Customer Group, the new Cart is updated with the new value. It has up-to-date Tax Rates, Prices, and Line Item product data and is in `Active` [CartState](ctp:api:type:CartState). The new Cart does not contain payments or deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. + + Specific Error Codes: + + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) body: application/json: example: !include ../examples/cart-replicate.example.json @@ -390,7 +404,6 @@ uriParameters: The shipping address is used for tax calculation for a Cart with `Platform` [TaxMode](ctp:api:type:TaxMode). Creating an Order produces the [OrderCreated](ctp:api:type:OrderCreatedMessage) Message. - If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Order by querying a unique identifier supplied during the creation request, such as the Order number. @@ -701,7 +714,14 @@ uriParameters: The `store` field in the created [Cart](ctp:api:type:Cart) is set to the Store specified by the `storeKey` path parameter. - Specific Error Codes: [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) + Specific Error Codes: + + - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: example: !include ../examples/cart-create.example.json @@ -868,11 +888,15 @@ uriParameters: Specific Error Codes: + - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) + - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) - [OutOfStock](ctp:api:type:OutOfStockError) - [PriceChanged](ctp:api:type:PriceChangedError) - - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) - - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) - - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) + - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) securedBy: [ oauth_2_0: @@ -1427,6 +1451,8 @@ uriParameters: description: | 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. + A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) 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). + Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. securedBy: [ @@ -1459,9 +1485,10 @@ uriParameters: - If the Customer does not have a Cart, the most recently modified anonymous cart becomes the Customer's Cart. - If the Customer already has a Cart, the most recently modified anonymous cart is handled according to [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode). - If a Cart is returned as part of [CustomerSignInResult](ctp:api:type:CustomerSignInResult), it has been [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. + A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) 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). If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. + securedBy: [ oauth_2_0: @@ -1793,6 +1820,7 @@ uriParameters: If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. Simultaneously updating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error. + securedBy: - oauth_2_0: scopes: @@ -1833,9 +1861,12 @@ uriParameters: description: | 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). + A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) 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). + Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). 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. + securedBy: - oauth_2_0: scopes: diff --git a/api-specs/api/resources/login.raml b/api-specs/api/resources/login.raml index 7b16bd67f..6c344b25c 100644 --- a/api-specs/api/resources/login.raml +++ b/api-specs/api/resources/login.raml @@ -10,7 +10,10 @@ post: Triggers [Cart merge during sign-in](/../api/customers-overview#cart-merge-during-sign-in). + A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) 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). + If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. + securedBy: [oauth_2_0: { scopes: ['manage_customers:{projectKey}'] }] body: application/json: diff --git a/api-specs/api/resources/me.raml b/api-specs/api/resources/me.raml index e7faba916..e2bf4880c 100644 --- a/api-specs/api/resources/me.raml +++ b/api-specs/api/resources/me.raml @@ -128,9 +128,10 @@ delete: - If the Customer does not have a Cart yet, the most recently modified anonymous cart becomes the Customer's Cart. - If the Customer already has a Cart, the most recently modified anonymous cart is handled in accordance with [AnonymousCartSignInMode](ctp:api:type:AnonymousCartSignInMode). - A Cart returned as part of the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) is [recalculated](ctp:api:type:MyCartRecalculateAction) with up-to-date prices, taxes, discounts, and invalid line items removed. + A Cart returned in the [CustomerSignInResult](ctp:api:type:CustomerSignInResult) has any invalid Line Items removed and is [updated](/api/carts-orders-overview#cart-updates) 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). If an account with the given credentials is not found, an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error is returned. + securedBy: [oauth_2_0: { scopes: ['manage_my_profile:{projectKey}'] }] body: application/json: @@ -353,6 +354,14 @@ delete: ] description: | Creates a Cart for a given `customerId` or `anonymousId`. + + Specific Error Codes: + + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: example: !include ../examples/cart-create.example.json @@ -510,6 +519,12 @@ delete: The new Cart does not contain Payments or Deliveries. The [State](ctp:api:type:ItemState) of Line Items and Custom Line Items is reset to `initial`. If the Cart or Order to be replicated does not belong to the authenticated Customer, the API returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error + + Specific Error Codes: + + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) + body: application/json: type: ReplicaMyCartDraft @@ -570,10 +585,14 @@ delete: Specific Error Codes: + - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) + - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) + - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) - [OutOfStock](ctp:api:type:OutOfStockError) - [PriceChanged](ctp:api:type:PriceChangedError) - - [DiscountCodeNonApplicable](ctp:api:type:DiscountCodeNonApplicableError) - - [AssociateMissingPermission](ctp:api:type:AssociateMissingPermissionError) + - [ShippingMethodDoesNotMatchCart](ctp:api:type:ShippingMethodDoesNotMatchCartError) + - [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) + - [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) securedBy: [oauth_2_0: { scopes: ['manage_my_orders:{projectKey}'] }] body: application/json: diff --git a/api-specs/api/resources/orders.raml b/api-specs/api/resources/orders.raml index f8e04a55f..559c0cb61 100644 --- a/api-specs/api/resources/orders.raml +++ b/api-specs/api/resources/orders.raml @@ -89,11 +89,12 @@ post: Specific Error Codes: - - [OutOfStock](ctp:api:type:OutOfStockError) - - [PriceChanged](ctp:api:type:PriceChangedError) + - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) - [InvalidItemShippingDetails](ctp:api:type:InvalidItemShippingDetailsError) - [InvalidOperation](ctp:api:type:InvalidOperationError) - - [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) + - [OutOfStock](ctp:api:type:OutOfStockError) + - [PriceChanged](ctp:api:type:PriceChangedError) + securedBy: [oauth_2_0: { scopes: ['manage_quotes:{projectKey}'] }] body: application/json: diff --git a/api-specs/api/types/cart/updates/CartFreezeCartAction.raml b/api-specs/api/types/cart/updates/CartFreezeCartAction.raml index 202a95507..582826fd5 100644 --- a/api-specs/api/types/cart/updates/CartFreezeCartAction.raml +++ b/api-specs/api/types/cart/updates/CartFreezeCartAction.raml @@ -6,4 +6,4 @@ discriminatorValue: freezeCart example: !include ../../../examples/Cart/CartFreezeCartAction.json description: | Changes the [CartState](ctp:api:type:CartState) from `Active` to `Frozen`. Results in a [Frozen Cart](ctp:api:type:FrozenCarts). - Fails with [InvalidOperation](ctp:api:type:InvalidOperation) error when the Cart is empty. + Fails with [InvalidOperation](ctp:api:type:InvalidOperationError) error when the Cart is empty. diff --git a/api-specs/api/types/cart/updates/CartSetAnonymousIdAction.raml b/api-specs/api/types/cart/updates/CartSetAnonymousIdAction.raml index fca02b8ba..f928925b9 100644 --- a/api-specs/api/types/cart/updates/CartSetAnonymousIdAction.raml +++ b/api-specs/api/types/cart/updates/CartSetAnonymousIdAction.raml @@ -4,6 +4,8 @@ type: CartUpdateAction displayName: CartSetAnonymousIdAction discriminatorValue: setAnonymousId example: !include ../../../examples/Cart/CartSetAnonymousIdAction.json +description: | + If the Cart is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. properties: anonymousId?: type: string diff --git a/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml b/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml index e40f6bcca..5f01c474e 100644 --- a/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml +++ b/api-specs/api/types/cart/updates/CartSetCustomerGroupAction.raml @@ -5,10 +5,10 @@ displayName: CartSetCustomerGroupAction discriminatorValue: setCustomerGroup example: !include ../../../examples/Cart/CartSetCustomerGroupAction.json description: | - This update action can only be used if a Customer is not assigned to a Cart. - If a Customer is already assigned, the Cart has the same Customer Group as the assigned Customer. + This update action can only be used if a Customer is not assigned to the Cart. + If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer. - Setting the Customer Group also updates the [LineItem](ctp:api:type:LineItem) `prices` according to the Customer Group. + To reflect the new Customer Group, this update action can result in [updates to the Cart](/api/carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError). properties: customerGroup?: type: CustomerGroupResourceIdentifier diff --git a/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml b/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml index 25a600b95..4ca5ce63d 100644 --- a/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetCustomerGroupAction.raml @@ -6,6 +6,9 @@ discriminatorValue: setCustomerGroup example: !include ../../../examples/Customer/CustomerSetCustomerGroupAction.json description: | Setting the Customer Group of the Customer produces the [CustomerGroupSet](ctp:api:type:CustomerGroupSetMessage) Message. + + To reflect the new Customer Group, this update action can result in [updates](/api/carts-orders-overview#cart-updates) to the most recently modified active Cart. When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError). + properties: customerGroup?: type: CustomerGroupResourceIdentifier diff --git a/api-specs/api/types/error/CountryNotConfiguredInStoreError.raml b/api-specs/api/types/error/CountryNotConfiguredInStoreError.raml index c21056223..8180c7b04 100644 --- a/api-specs/api/types/error/CountryNotConfiguredInStoreError.raml +++ b/api-specs/api/types/error/CountryNotConfiguredInStoreError.raml @@ -10,12 +10,10 @@ description: | - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts. - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts. - - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. + - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import. - - [Set Country](ctp:api:type:StagedOrderSetCountryAction) on Order Edits. + - [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action on Order Edits. properties: code: diff --git a/api-specs/api/types/error/DiscountCodeNonApplicableError.raml b/api-specs/api/types/error/DiscountCodeNonApplicableError.raml index 40931e642..60cf5d807 100644 --- a/api-specs/api/types/error/DiscountCodeNonApplicableError.raml +++ b/api-specs/api/types/error/DiscountCodeNonApplicableError.raml @@ -8,8 +8,14 @@ description: | The error is returned as a failed response to: + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update action on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests and [Add DiscountCode](ctp:api:type:MyCartAddDiscountCodeAction) update action on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action on Order Edits. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. + properties: code: type: string diff --git a/api-specs/api/types/error/InvalidCredentialsError.raml b/api-specs/api/types/error/InvalidCredentialsError.raml index 5b9645d56..e0557e6a0 100644 --- a/api-specs/api/types/error/InvalidCredentialsError.raml +++ b/api-specs/api/types/error/InvalidCredentialsError.raml @@ -8,8 +8,8 @@ description: | The error is returned as a failed response to: - - [Authenticate a global Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. - - [Authenticating Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. properties: code: type: string diff --git a/api-specs/api/types/error/InvalidItemShippingDetailsError.raml b/api-specs/api/types/error/InvalidItemShippingDetailsError.raml index 8feed7889..f27883bbc 100644 --- a/api-specs/api/types/error/InvalidItemShippingDetailsError.raml +++ b/api-specs/api/types/error/InvalidItemShippingDetailsError.raml @@ -6,7 +6,18 @@ discriminatorValue: InvalidItemShippingDetails description: | Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details. - The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). + + The error is also returned as a failed response to: + + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:CartAddShoppingListAction), and [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update actions on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests, and [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction), and [Remove LineItem](ctp:api:type:MyCartRemoveLineItemAction) update actions on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:StagedOrderAddShoppingListAction), and [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update actions on Order Edits. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders. + properties: code: type: string diff --git a/api-specs/api/types/error/MatchingPriceNotFoundError.raml b/api-specs/api/types/error/MatchingPriceNotFoundError.raml index 403ca684d..a3d437e2d 100644 --- a/api-specs/api/types/error/MatchingPriceNotFoundError.raml +++ b/api-specs/api/types/error/MatchingPriceNotFoundError.raml @@ -6,12 +6,19 @@ discriminatorValue: MatchingPriceNotFound description: | Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel. - The error is returned as a failed response to: + The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction). - - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update actions on Carts. - - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update actions on Order Edits. + The error is also returned as a failed response to: + + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. + properties: code: type: string diff --git a/api-specs/api/types/error/MissingTaxRateForCountryError.raml b/api-specs/api/types/error/MissingTaxRateForCountryError.raml index 6182250c2..f1ad4d01f 100644 --- a/api-specs/api/types/error/MissingTaxRateForCountryError.raml +++ b/api-specs/api/types/error/MissingTaxRateForCountryError.raml @@ -6,10 +6,19 @@ discriminatorValue: MissingTaxRateForCountry description: | Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart. - The error is returned as a failed response to: + The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction). + + The error is also returned as a failed response to: + + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) on My Customer Profile. + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) requests on Associate Orders. - - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set Shipping Address](ctp:api:type:CartSetShippingAddressAction), [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), and [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update actions - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. properties: code: type: string diff --git a/api-specs/api/types/error/OutOfStockError.raml b/api-specs/api/types/error/OutOfStockError.raml index 742579476..41ea46e0a 100644 --- a/api-specs/api/types/error/OutOfStockError.raml +++ b/api-specs/api/types/error/OutOfStockError.raml @@ -8,8 +8,10 @@ description: | The error is returned as a failed response to: - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders. + properties: code: type: string diff --git a/api-specs/api/types/error/PriceChangedError.raml b/api-specs/api/types/error/PriceChangedError.raml index 001a16ab9..fea896c9c 100644 --- a/api-specs/api/types/error/PriceChangedError.raml +++ b/api-specs/api/types/error/PriceChangedError.raml @@ -6,12 +6,13 @@ discriminatorValue: PriceChanged description: | Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart. - The error is returned as a failed response to: + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) request on Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) request on My Orders. + The error is also returned as a failed response to: + + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. properties: code: diff --git a/api-specs/api/types/error/ShippingMethodDoesNotMatchCartError.raml b/api-specs/api/types/error/ShippingMethodDoesNotMatchCartError.raml index e778404e4..4b61e6f06 100644 --- a/api-specs/api/types/error/ShippingMethodDoesNotMatchCartError.raml +++ b/api-specs/api/types/error/ShippingMethodDoesNotMatchCartError.raml @@ -6,7 +6,14 @@ discriminatorValue: ShippingMethodDoesNotMatchCart description: | Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart). In this case, the [ShippingMethodState](ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`. - The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) or [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). + + The error is also returned as a failed response to: + + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. + properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLCountryNotConfiguredInStoreError.raml b/api-specs/api/types/error/graphql/GraphQLCountryNotConfiguredInStoreError.raml index 52524947a..e0ce191c1 100644 --- a/api-specs/api/types/error/graphql/GraphQLCountryNotConfiguredInStoreError.raml +++ b/api-specs/api/types/error/graphql/GraphQLCountryNotConfiguredInStoreError.raml @@ -10,12 +10,10 @@ description: | - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts. - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts. - - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. + - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import. - - [Set Country](ctp:api:type:StagedOrderSetCountryAction) on Order Edits. + - [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action on Order Edits. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLDiscountCodeNonApplicableError.raml b/api-specs/api/types/error/graphql/GraphQLDiscountCodeNonApplicableError.raml index f20606608..0424a3a59 100644 --- a/api-specs/api/types/error/graphql/GraphQLDiscountCodeNonApplicableError.raml +++ b/api-specs/api/types/error/graphql/GraphQLDiscountCodeNonApplicableError.raml @@ -8,8 +8,13 @@ description: | The error is returned as a failed response to: + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update action on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests and [Add DiscountCode](ctp:api:type:MyCartAddDiscountCodeAction) update action on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action on Order Edits. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLInvalidCredentialsError.raml b/api-specs/api/types/error/graphql/GraphQLInvalidCredentialsError.raml index f7c6d6264..b8fc33ada 100644 --- a/api-specs/api/types/error/graphql/GraphQLInvalidCredentialsError.raml +++ b/api-specs/api/types/error/graphql/GraphQLInvalidCredentialsError.raml @@ -8,8 +8,8 @@ description: | The error is returned as a failed response to: - - [Authenticate a global Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. - - [Authenticating Customer (Sign-in)](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate Customer (Sign-in) in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLInvalidItemShippingDetailsError.raml b/api-specs/api/types/error/graphql/GraphQLInvalidItemShippingDetailsError.raml index 954399021..51fee0846 100644 --- a/api-specs/api/types/error/graphql/GraphQLInvalidItemShippingDetailsError.raml +++ b/api-specs/api/types/error/graphql/GraphQLInvalidItemShippingDetailsError.raml @@ -6,7 +6,17 @@ discriminatorValue: InvalidItemShippingDetails description: | Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details. - The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). + + The error is also returned as a failed response to: + + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:CartAddShoppingListAction), and [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update actions on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests, and [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction), and [Remove LineItem](ctp:api:type:MyCartRemoveLineItemAction) update actions on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:StagedOrderAddShoppingListAction), and [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update actions on Order Edits. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLMatchingPriceNotFoundError.raml b/api-specs/api/types/error/graphql/GraphQLMatchingPriceNotFoundError.raml index 5e4aeb7b5..b0102a570 100644 --- a/api-specs/api/types/error/graphql/GraphQLMatchingPriceNotFoundError.raml +++ b/api-specs/api/types/error/graphql/GraphQLMatchingPriceNotFoundError.raml @@ -6,12 +6,18 @@ discriminatorValue: MatchingPriceNotFound description: | Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel. - The error is returned as a failed response to: + The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction). - - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update actions on Carts. - - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), and [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update actions on Order Edits. + The error is also returned as a failed response to: + + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile. + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLMissingTaxRateForCountryError.raml b/api-specs/api/types/error/graphql/GraphQLMissingTaxRateForCountryError.raml index 28435a514..008fe75ce 100644 --- a/api-specs/api/types/error/graphql/GraphQLMissingTaxRateForCountryError.raml +++ b/api-specs/api/types/error/graphql/GraphQLMissingTaxRateForCountryError.raml @@ -6,10 +6,18 @@ discriminatorValue: MissingTaxRateForCountry description: | Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart. - The error is returned as a failed response to: + The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction). - - [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set Shipping Address](ctp:api:type:CartSetShippingAddressAction), [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), and [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update actions - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. + The error is also returned as a failed response to: + + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers. + - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) on My Customer Profile. + - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts. + - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts. + - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) requests on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLOutOfStockError.raml b/api-specs/api/types/error/graphql/GraphQLOutOfStockError.raml index fff95941e..9acc2125c 100644 --- a/api-specs/api/types/error/graphql/GraphQLOutOfStockError.raml +++ b/api-specs/api/types/error/graphql/GraphQLOutOfStockError.raml @@ -8,8 +8,9 @@ description: | The error is returned as a failed response to: - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLPriceChangedError.raml b/api-specs/api/types/error/graphql/GraphQLPriceChangedError.raml index 56729acdd..417b1b22d 100644 --- a/api-specs/api/types/error/graphql/GraphQLPriceChangedError.raml +++ b/api-specs/api/types/error/graphql/GraphQLPriceChangedError.raml @@ -6,12 +6,13 @@ discriminatorValue: PriceChanged description: | Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart. - The error is returned as a failed response to: + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. - - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) request on Orders. - - [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) request on My Orders. + The error is also returned as a failed response to: + + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml b/api-specs/api/types/error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml index a8aed595f..3c1004073 100644 --- a/api-specs/api/types/error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml +++ b/api-specs/api/types/error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml @@ -6,7 +6,13 @@ discriminatorValue: ShippingMethodDoesNotMatchCart description: | Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart). In this case, the [ShippingMethodState](ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`. - The error is returned as a failed response to the [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) or [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests. + When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction). + + The error is also returned as a failed response to: + + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders. + - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders. + - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders. properties: code: type: string diff --git a/api-specs/api/types/message/OrderLineItemRemovedMessage.raml b/api-specs/api/types/message/OrderLineItemRemovedMessage.raml index 750fe63f4..1a83170f5 100644 --- a/api-specs/api/types/message/OrderLineItemRemovedMessage.raml +++ b/api-specs/api/types/message/OrderLineItemRemovedMessage.raml @@ -18,29 +18,29 @@ properties: type: number format: int64 description: | - Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newQuantity: type: number format: int64 description: | - [Line Item](ctp:api:type:LineItem) quantity after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Line Item](ctp:api:type:LineItem) quantity after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newState: type: ItemState[] description: | - [ItemStates](ctp:api:type:ItemState) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [ItemStates](ctp:api:type:ItemState) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newTotalPrice: type: CentPrecisionMoney description: | - `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newTaxedPrice?: type: TaxedItemPrice description: | - [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newPrice?: type: Price description: | - [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newShippingDetail?: type: ItemShippingDetails description: | - [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. diff --git a/api-specs/api/types/message/payload/OrderLineItemRemovedMessagePayload.raml b/api-specs/api/types/message/payload/OrderLineItemRemovedMessagePayload.raml index fe137e544..77896ba0d 100644 --- a/api-specs/api/types/message/payload/OrderLineItemRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderLineItemRemovedMessagePayload.raml @@ -18,29 +18,29 @@ properties: type: number format: int64 description: | - Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + Quantity of [Line Items](ctp:api:type:LineItem) that were removed during the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newQuantity: type: number format: int64 description: | - [Line Item](ctp:api:type:LineItem) quantity after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Line Item](ctp:api:type:LineItem) quantity after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newState: type: ItemState[] description: | - [ItemStates](ctp:api:type:ItemState) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [ItemStates](ctp:api:type:ItemState) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newTotalPrice: type: CentPrecisionMoney description: | - `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + `totalPrice` of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newTaxedPrice?: type: TaxedItemPrice description: | - [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [TaxedItemPrice](ctp:api:type:TaxedItemPrice) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newPrice?: type: Price description: | - [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Price](ctp:api:type:Price) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. newShippingDetail?: type: ItemShippingDetails description: | - [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove Line Item](ctp:api:type:StagedOrderRemoveLineItemAction) update action. + [Shipping Details](ctp:api:type:ItemShippingDetails) of the [Order](ctp:api:type:Order) after the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action. diff --git a/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml b/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml index 6374d0922..3f17f3e3c 100644 --- a/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml +++ b/api-specs/api/types/order-edit/updates/StagedOrderSetCustomerGroupAction.raml @@ -5,9 +5,10 @@ type: StagedOrderUpdateAction displayName: StagedOrderSetCustomerGroupAction discriminatorValue: setCustomerGroup description: | - This update action can only be used if a Customer is not assigned to a Cart. If a Customer is already assigned, the Cart has the same Customer Group as the assigned Customer. + This update action can only be used if a Customer is not assigned to a Cart. + If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer. - Setting the Customer Group also updates the [LineItem](ctp:api:type:LineItem) `prices` according to the Customer Group. + To reflect the new Customer Group, this update action can result in [updates to the Cart](/../carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError). properties: customerGroup?: type: CustomerGroupResourceIdentifier diff --git a/api-specs/api/types/payment/updates/PaymentSetAnonymousIdAction.raml b/api-specs/api/types/payment/updates/PaymentSetAnonymousIdAction.raml index 79d92d451..b5cd9f202 100644 --- a/api-specs/api/types/payment/updates/PaymentSetAnonymousIdAction.raml +++ b/api-specs/api/types/payment/updates/PaymentSetAnonymousIdAction.raml @@ -4,9 +4,10 @@ type: PaymentUpdateAction displayName: PaymentSetAnonymousIdAction discriminatorValue: setAnonymousId example: !include ../../../examples/Payment/PaymentSetAnonymousIdAction.json +description: | + If the Payment is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. properties: anonymousId?: type: string description: | - Value to set. - If empty, any existing value will be removed. + Value to set. If empty, any existing value will be removed. diff --git a/api-specs/api/types/shopping-list/updates/ShoppingListSetAnonymousIdAction.raml b/api-specs/api/types/shopping-list/updates/ShoppingListSetAnonymousIdAction.raml index a9be254dd..a666e0b26 100644 --- a/api-specs/api/types/shopping-list/updates/ShoppingListSetAnonymousIdAction.raml +++ b/api-specs/api/types/shopping-list/updates/ShoppingListSetAnonymousIdAction.raml @@ -4,6 +4,8 @@ type: ShoppingListUpdateAction displayName: ShoppingListSetAnonymousIdAction discriminatorValue: setAnonymousId example: !include ../../../examples/ShoppingList/ShoppingListSetAnonymousIdAction.json +description: | + If the Shopping List is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned. properties: anonymousId?: type: string