Interface CartDiscountDraft

interface CartDiscountDraft {
    cartPredicate: string;
    custom?: CustomFieldsDraft;
    description?: LocalizedString;
    isActive?: boolean;
    key?: string;
    name: LocalizedString;
    requiresDiscountCode?: boolean;
    sortOrder: string;
    stackingMode?: string;
    stores?: StoreResourceIdentifier[];
    target?: CartDiscountTarget;
    validFrom?: string;
    validUntil?: string;
    value: CartDiscountValueDraft;
}

Properties

cartPredicate custom? description? isActive? key? name requiresDiscountCode? sortOrder stackingMode? stores? target? validFrom? validUntil? value

Properties

Readonly cartPredicate

cartPredicate: string

Valid Cart Predicate.

Optional Readonly custom

custom?: CustomFieldsDraft

Custom Fields of the CartDiscount.

Optional Readonly description

description?: LocalizedString

Description of the CartDiscount.

Optional Readonly isActive

isActive?: boolean

Only active Discounts can be applied to the Cart. If the limit for active Cart Discounts is reached, a MaxCartDiscountsReached error is returned.

Optional Readonly key

key?: string

User-defined unique identifier for the CartDiscount.

Readonly name

name: LocalizedString

Name of the CartDiscount.

Optional Readonly requiresDiscountCode

requiresDiscountCode?: boolean

States whether the Discount can only be used in a connection with a DiscountCode.

Readonly sortOrder

sortOrder: string

Value between 0 and 1. A Discount with a higher sortOrder is prioritized. The sort order must be unambiguous among all CartDiscounts.

Optional Readonly stackingMode

stackingMode?: string

Specifies whether the application of this discount causes the following discounts to be ignored.

Optional Readonly stores

stores?: StoreResourceIdentifier[]

  • If defined, the Cart Discount applies on Carts having a 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, a MaxStoreReferencesReached error is returned.

    If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned.

Optional Readonly target

target?: CartDiscountTarget

Segment of the Cart that will be discounted.

Must not be set if the `value` is `giftLineItem`.

Optional Readonly validFrom

validFrom?: string

Date and time (UTC) from which the Discount is effective.

Optional Readonly validUntil

validUntil?: string

Date and time (UTC) until which the Discount is effective.

Readonly value

value: CartDiscountValueDraft

Effect of the CartDiscount on the target.

Settings

Member Visibility

Theme

On This Page

cartPredicatecustomdescriptionisActivekeynamerequiresDiscountCodesortOrderstackingModestorestargetvalidFromvalidUntilvalue