@gradientedge/commercetools-utils
    Preparing search index...

    Interface CartDiscount

    interface CartDiscount {
        cartPredicate: string;
        createdAt: string;
        createdBy?: CreatedBy;
        custom?: CustomFields;
        description?: LocalizedString;
        discountGroup?: DiscountGroupReference;
        id: string;
        isActive: boolean;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name: LocalizedString;
        references: Reference[];
        requiresDiscountCode: boolean;
        sortOrder: string;
        stackingMode: StackingMode;
        stores: StoreKeyReference[];
        target?: CartDiscountTarget;
        validFrom?: string;
        validUntil?: string;
        value: CartDiscountValue;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cartPredicate createdAt createdBy? custom? description? discountGroup? id isActive key? lastModifiedAt lastModifiedBy? name references requiresDiscountCode sortOrder stackingMode stores target? validFrom? validUntil? value version

    Properties

    cartPredicate: string

    Valid Cart Predicate.

    createdAt: string

    Date and time (UTC) the CartDiscount was initially created.

    createdBy?: CreatedBy

    IDs and references that created the CartDiscount.

    custom?: CustomFields

    Custom Fields of the CartDiscount.

    description?: LocalizedString

    Description of the CartDiscount.

    discountGroup?: DiscountGroupReference

    Reference to a DiscountGroup that the CartDiscount belongs to.

    id: string

    Unique identifier of the CartDiscount.

    isActive: boolean

    Indicates if the CartDiscount is active and can be applied to the Cart.

    key?: string

    User-defined unique identifier of the CartDiscount.

    lastModifiedAt: string

    Date and time (UTC) the CartDiscount was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the CartDiscount.

    name: LocalizedString

    Name of the CartDiscount.

    references: Reference[]

    References of all resources that are addressed in the predicate. The API generates this array from the predicate.

    requiresDiscountCode: boolean

    Indicates if the Discount is used in connection with a DiscountCode.

    sortOrder: string

    Value between 0 and 1 that determines the order in which the CartDiscounts are applied; a CartDiscount with a higher value is prioritized.

    It is unique among all CartDiscounts and DiscountGroups.

If the CartDiscount is part of a DiscountGroup, it uses the sort order of the DiscountGroup.
    stackingMode: StackingMode

    Indicates whether the application of the CartDiscount causes other discounts to be ignored.

    stores: StoreKeyReference[]
    • If a value exists, the Cart Discount applies on Carts having a Store matching any Store defined for this field.
      • If empty, the Cart Discount applies on all Carts, irrespective of a Store.
    target?: CartDiscountTarget

    Segment of the Cart that is discounted.

    Empty, if the `value` is `giftLineItem`.
    validFrom?: string

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

    validUntil?: string

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

    value: CartDiscountValue

    Effect of the CartDiscount on the target.

    version: number

    Current version of the CartDiscount.

    Settings

    Member Visibility

    On This Page

    Properties