@commercetools/platform-sdk
Advanced tools
Comparing version 4.10.1 to 4.11.0
@@ -46,3 +46,3 @@ /** | ||
/** | ||
* Updates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`. | ||
* Updates a [Cart](ctp:api:type:Cart) in the [Store](ctp:api:type:Store) specified by `storeKey`. | ||
* If the Cart exists in the Project but does not have the `store` field, or the `store` field references a different Store, a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned. | ||
@@ -49,0 +49,0 @@ * |
@@ -42,2 +42,5 @@ /** | ||
}): ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder; | ||
/** | ||
* Queries carts in a specific [Store](ctp:api:type:Store). | ||
*/ | ||
get(methodArgs?: { | ||
@@ -58,6 +61,6 @@ queryArgs?: { | ||
/** | ||
* The `store` field in the created [Cart](ctp:api:type:Cart) is set to the Store specified by the `storeKey` path parameter. | ||
* 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: [CountryNotConfiguredInStore](ctp:api:type:CountryNotConfiguredInStoreError) | ||
* | ||
*/ | ||
@@ -64,0 +67,0 @@ post(methodArgs: { |
@@ -32,3 +32,3 @@ /** | ||
* | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -35,0 +35,0 @@ */ |
@@ -33,3 +33,2 @@ /** | ||
* If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. | ||
* The new Associate is created with an empty set of roles. | ||
* | ||
@@ -36,0 +35,0 @@ */ |
@@ -44,3 +44,3 @@ /** | ||
/** | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -47,0 +47,0 @@ */ |
@@ -31,3 +31,3 @@ /** | ||
/** | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -34,0 +34,0 @@ */ |
@@ -31,3 +31,3 @@ /** | ||
/** | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -61,3 +61,3 @@ */ | ||
* | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -64,0 +64,0 @@ */ |
@@ -69,7 +69,7 @@ /** | ||
/** | ||
* When using this endpoint, if omitted, the Customer `stores` field is set to the Store specified in the path parameter. | ||
* When using this endpoint, if omitted, the Customer `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter. | ||
* | ||
* 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). | ||
* 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`. | ||
* If a Cart with a `store` field specified, the `store` field must reference the same Store specified in the `{storeKey}` path parameter. | ||
* 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. | ||
* Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. | ||
@@ -76,0 +76,0 @@ * |
@@ -7,2 +7,3 @@ /** | ||
import { executeRequest } from '../../shared/utils/common-types'; | ||
import { ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder } from '../cart-discounts/by-project-key-in-store-key-by-store-key-cart-discounts-request-builder'; | ||
import { ByProjectKeyInStoreKeyByStoreKeyCartsRequestBuilder } from '../carts/by-project-key-in-store-key-by-store-key-carts-request-builder'; | ||
@@ -63,2 +64,3 @@ import { ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder } from '../customers/by-project-key-in-store-key-by-store-key-customers-request-builder'; | ||
productSelectionAssignments(): ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsRequestBuilder; | ||
cartDiscounts(): ByProjectKeyInStoreKeyByStoreKeyCartDiscountsRequestBuilder; | ||
} |
@@ -29,5 +29,5 @@ /** | ||
/** | ||
* Authenticates a Customer associated with a Store. For more information, see [Global versus Store-specific Customers](/../api/customers-overview#global-versus-store-specific-customers). | ||
* 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). | ||
* | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns an [InvalidCredentials](ctp:api:type:InvalidCredentialsError) error. | ||
* 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. | ||
* | ||
@@ -34,0 +34,0 @@ */ |
@@ -29,3 +29,3 @@ /** | ||
/** | ||
* Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store. | ||
* Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store). | ||
* Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. | ||
@@ -32,0 +32,0 @@ * This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). |
@@ -31,4 +31,4 @@ /** | ||
/** | ||
* Returns an order by its ID from a specific Store. | ||
* If the order exists in the project but does not have the store field, | ||
* Returns an [Order](ctp:api:type:Order) by its ID from a specific [Store](ctp:api:type:Store). | ||
* If the Order exists in the Project but does not have the `store` field, | ||
* or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
@@ -47,4 +47,4 @@ * | ||
/** | ||
* Updates an order in the store specified by {storeKey}. | ||
* If the order exists in the project but does not have the store field, | ||
* Updates an [Order](ctp:api:type:Order) in the [Store](ctp:api:type:Store) specified by {storeKey}. | ||
* If the Order exists in the Project but does not have the `store` field, | ||
* or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
@@ -51,0 +51,0 @@ * |
@@ -31,6 +31,6 @@ /** | ||
/** | ||
* Returns an order by its order number from a specific Store. | ||
* Returns an order by its order number from a specific [Store](ctp:api:type:Store). | ||
* | ||
* If the order exists in the project but does not have the store field, | ||
* or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* If the Order exists in the Project but does not have the `store` field, | ||
* or the `store` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* In case the orderNumber does not match the regular expression [a-zA-Z0-9_\-]+, | ||
@@ -50,4 +50,5 @@ * it should be provided in URL-encoded format. | ||
/** | ||
* Updates an order in the store specified by {storeKey}. | ||
* If the order exists in the project but does not have the store field, | ||
* Updates an order in the [Store](ctp:api:type:Store) specified by {storeKey}. | ||
* | ||
* If the [Order](ctp:api:type:Order) exists in the Project but does not have the `store` field, | ||
* or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
@@ -54,0 +55,0 @@ * In case the orderNumber does not match the regular expression [a-zA-Z0-9_\-]+, |
@@ -37,3 +37,3 @@ /** | ||
/** | ||
* Queries orders in a specific Store. | ||
* Queries orders in a specific [Store](ctp:api:type:Store). | ||
*/ | ||
@@ -55,4 +55,4 @@ get(methodArgs?: { | ||
/** | ||
* Creates an order from a Cart from a specific Store. | ||
* When using this endpoint the orders's store field is always set to the store specified in the path parameter. | ||
* Creates an order from a Cart from a specific [Store](ctp:api:type:Store). | ||
* When using this endpoint the orders's `store` field is always set to the [Store](ctp:api:type:Store) specified in the path parameter. | ||
* The cart must have a shipping address set before creating an order. When using the Platform TaxMode, | ||
@@ -59,0 +59,0 @@ * the shipping address is used for tax calculation. |
@@ -29,3 +29,3 @@ /** | ||
/** | ||
* Queries Product Selection assignments over all Product Selections that are active in a specific Store. | ||
* Queries Product Selection assignments in a specific [Store](ctp:api:type:Store). | ||
* | ||
@@ -32,0 +32,0 @@ * The response will include duplicate Products whenever more than one active Product Selection of the Store |
@@ -31,3 +31,3 @@ /** | ||
* | ||
* If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error. | ||
* 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. | ||
* | ||
@@ -34,0 +34,0 @@ */ |
@@ -32,3 +32,3 @@ /** | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -47,3 +47,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -63,3 +63,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -66,0 +66,0 @@ * |
@@ -32,3 +32,3 @@ /** | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
* | ||
@@ -46,3 +46,3 @@ */ | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -62,3 +62,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -65,0 +65,0 @@ * |
@@ -52,3 +52,3 @@ /** | ||
/** | ||
* When using this endpoint, the `store` field of a ShoppingList is always set to the Store specified in the path parameter. | ||
* When using this endpoint, the `store` field of a ShoppingList is always set to the [Store](ctp:api:type:Store) specified in the path parameter. | ||
* | ||
@@ -55,0 +55,0 @@ */ |
@@ -31,3 +31,3 @@ /** | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -46,3 +46,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -62,3 +62,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -65,0 +65,0 @@ * |
@@ -31,3 +31,3 @@ /** | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -46,3 +46,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -62,3 +62,3 @@ * | ||
/** | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different Store, | ||
* If a ShoppingList exists in a Project but does _not_ have the `store` field, or the `store` field references a different [Store](ctp:api:type:Store), | ||
* the [ResourceNotFound](/errors#404-not-found-1) error is returned. | ||
@@ -65,0 +65,0 @@ * |
@@ -51,3 +51,3 @@ /** | ||
/** | ||
* When using this endpoint, the `store` field of a ShoppingList is always set to the Store specified in the path parameter. | ||
* When using this endpoint, the `store` field of a ShoppingList is always set to the [Store](ctp:api:type:Store) specified in the path parameter. | ||
* | ||
@@ -54,0 +54,0 @@ */ |
@@ -30,3 +30,3 @@ /** | ||
/** | ||
* If omitted in the request body, the [Customer](ctp:api:type:Customer) `stores` field is set to the Store specified in the path parameter. | ||
* 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. | ||
* | ||
@@ -33,0 +33,0 @@ * Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. |
@@ -9,2 +9,3 @@ /** | ||
import { ProductReference, ProductResourceIdentifier } from './product'; | ||
import { StoreKeyReference, StoreResourceIdentifier } from './store'; | ||
import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type'; | ||
@@ -93,2 +94,9 @@ export interface CartDiscount extends BaseResource { | ||
/** | ||
* - If a value exists, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field. | ||
* - If empty, the Cart Discount applies on all [Carts](ctp:api:type:Cart), irrespective of a Store. | ||
* | ||
* | ||
*/ | ||
readonly stores: StoreKeyReference[]; | ||
/** | ||
* Indicates if the CartDiscount is active and can be applied to the Cart. | ||
@@ -184,3 +192,15 @@ * | ||
/** | ||
* - If defined, the Cart Discount applies on [Carts](ctp:api:type:Cart) having a [Store](ctp:api:type:Store) matching any Store defined for this field. | ||
* - If not defined, the Cart Discount applies on all Carts, irrespective of a Store. | ||
* | ||
* If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned. | ||
* | ||
* If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned. | ||
* | ||
* | ||
*/ | ||
readonly stores?: StoreResourceIdentifier[]; | ||
/** | ||
* Only active Discounts can be applied to the Cart. | ||
* If the [limit](/../api/limits#cart-discounts) for active Cart Discounts is reached, a [MaxCartDiscountsReached](ctp:api:type:MaxCartDiscountsReachedError) error is returned. | ||
* | ||
@@ -347,3 +367,3 @@ * | ||
} | ||
export type CartDiscountUpdateAction = CartDiscountChangeCartPredicateAction | CartDiscountChangeIsActiveAction | CartDiscountChangeNameAction | CartDiscountChangeRequiresDiscountCodeAction | CartDiscountChangeSortOrderAction | CartDiscountChangeStackingModeAction | CartDiscountChangeTargetAction | CartDiscountChangeValueAction | CartDiscountSetCustomFieldAction | CartDiscountSetCustomTypeAction | CartDiscountSetDescriptionAction | CartDiscountSetKeyAction | CartDiscountSetValidFromAction | CartDiscountSetValidFromAndUntilAction | CartDiscountSetValidUntilAction; | ||
export type CartDiscountUpdateAction = CartDiscountAddStoreAction | CartDiscountChangeCartPredicateAction | CartDiscountChangeIsActiveAction | CartDiscountChangeNameAction | CartDiscountChangeRequiresDiscountCodeAction | CartDiscountChangeSortOrderAction | CartDiscountChangeStackingModeAction | CartDiscountChangeTargetAction | CartDiscountChangeValueAction | CartDiscountRemoveStoreAction | CartDiscountSetCustomFieldAction | CartDiscountSetCustomTypeAction | CartDiscountSetDescriptionAction | CartDiscountSetKeyAction | CartDiscountSetStoresAction | CartDiscountSetValidFromAction | CartDiscountSetValidFromAndUntilAction | CartDiscountSetValidUntilAction; | ||
export type CartDiscountValue = CartDiscountValueAbsolute | CartDiscountValueFixed | CartDiscountValueGiftLineItem | CartDiscountValueRelative; | ||
@@ -428,2 +448,7 @@ /** | ||
} | ||
/** | ||
* Can only be used in a [CartDiscountDraft](ctp:api:type:CartDiscountDraft) with no `target` specified. | ||
* Hence, this type can not be used in the [Change Value](ctp:api:type:CartDiscountChangeValueAction) update action. | ||
* | ||
*/ | ||
export interface CartDiscountValueGiftLineItemDraft { | ||
@@ -558,2 +583,20 @@ readonly type: 'giftLineItem'; | ||
export type StackingMode = 'Stacking' | 'StopAfterThisDiscount' | string; | ||
/** | ||
* If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. | ||
* | ||
*/ | ||
export interface CartDiscountAddStoreAction { | ||
readonly action: 'addStore'; | ||
/** | ||
* [Store](ctp:api:type:Store) to add. | ||
* | ||
* A failed update can return the following errors: | ||
* | ||
* - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned. | ||
* - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned. | ||
* | ||
* | ||
*/ | ||
readonly store: StoreResourceIdentifier; | ||
} | ||
export interface CartDiscountChangeCartPredicateAction { | ||
@@ -574,3 +617,5 @@ readonly action: 'changeCartPredicate'; | ||
* | ||
* If the limit for active Cart Discounts is reached, a [MaxCartDiscountsReached](ctp:api:type:MaxCartDiscountsReachedError) error is returned. | ||
* | ||
* | ||
*/ | ||
@@ -626,2 +671,7 @@ readonly isActive: boolean; | ||
} | ||
/** | ||
* Changes the [CartDiscountValue](ctp:api:type:CartDiscountValue) for [relative](ctp:api:type:CartDiscountValueRelative), [absolute](ctp:api:type:CartDiscountValueAbsolute) and [fixed price](ctp:api:type:CartDiscountValueFixed) CartDiscounts. | ||
* Changing to [Gift Line Item](ctp:api:type:CartDiscountValueGiftLineItem) is not supported. | ||
* | ||
*/ | ||
export interface CartDiscountChangeValueAction { | ||
@@ -631,2 +681,3 @@ readonly action: 'changeValue'; | ||
* New value to set. | ||
* When trying to set a [CartDiscountValueGiftLineItemDraft](ctp:api:type:CartDiscountValueGiftLineItemDraft) an [InvalidInput](ctp:api:type:InvalidInputError) error is returned. | ||
* | ||
@@ -637,2 +688,15 @@ * | ||
} | ||
/** | ||
* If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. | ||
* | ||
*/ | ||
export interface CartDiscountRemoveStoreAction { | ||
readonly action: 'removeStore'; | ||
/** | ||
* [Store](ctp:api:type:Store) to remove. | ||
* | ||
* | ||
*/ | ||
readonly store: StoreResourceIdentifier; | ||
} | ||
export interface CartDiscountSetCustomFieldAction { | ||
@@ -689,2 +753,22 @@ readonly action: 'setCustomField'; | ||
} | ||
/** | ||
* If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned. | ||
* | ||
*/ | ||
export interface CartDiscountSetStoresAction { | ||
readonly action: 'setStores'; | ||
/** | ||
* [Stores](ctp:api:type:Store) to set. | ||
* Overrides the current list of Stores. | ||
* If empty, any existing values will be removed. | ||
* | ||
* A failed update can return the following errors: | ||
* | ||
* - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts-stores), a [MaxStoreReferencesReached](ctp:api:type:MaxStoreReferencesReachedError) error is returned. | ||
* - If the referenced Stores exceed the [limit](/../api/limits#cart-discounts) for Cart Discounts that do not require a Discount Code, a [StoreCartDiscountsLimitReached](ctp:api:type:StoreCartDiscountsLimitReachedError) error is returned. | ||
* | ||
* | ||
*/ | ||
readonly stores?: StoreResourceIdentifier[]; | ||
} | ||
export interface CartDiscountSetValidFromAction { | ||
@@ -691,0 +775,0 @@ readonly action: 'setValidFrom'; |
@@ -335,4 +335,10 @@ /** | ||
/** | ||
* User-defined unique identifier of the Custom Line Item. | ||
* | ||
* | ||
*/ | ||
readonly key?: string; | ||
/** | ||
* | ||
*/ | ||
readonly quantity?: number; | ||
@@ -379,4 +385,10 @@ /** | ||
/** | ||
* User-defined unique identifier of the Shipping Method in a Cart with `Multi` [ShippingMode](ctp:api:type:ShippingMode). | ||
* | ||
* | ||
*/ | ||
readonly shippingKey?: string; | ||
/** | ||
* | ||
*/ | ||
readonly items?: DeliveryItem[]; | ||
@@ -383,0 +395,0 @@ /** |
@@ -444,3 +444,3 @@ /** | ||
export interface StandalonePriceSetPriceTiersAction { | ||
readonly action: 'setPriceTier'; | ||
readonly action: 'setPriceTiers'; | ||
/** | ||
@@ -447,0 +447,0 @@ * Value to set. If empty, any existing value will be removed. |
@@ -7,3 +7,3 @@ { | ||
"name": "@commercetools/platform-sdk", | ||
"version": "4.10.1", | ||
"version": "4.11.0", | ||
"engines": { | ||
@@ -10,0 +10,0 @@ "node": ">=14" |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
4706349
292
122825
2
9
1
83830