Typescript SDK Type Docs
    Preparing search index...

    Interface DiscountGroup

    interface DiscountGroup {
        createdAt: string;
        createdBy?: CreatedBy;
        description?: LocalizedString;
        id: string;
        isActive: boolean;
        key: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name?: LocalizedString;
        sortOrder: string;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt createdBy? description? id isActive key lastModifiedAt lastModifiedBy? name? sortOrder version

    Properties

    createdAt: string

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

    createdBy?: CreatedBy

    IDs and references that created the DiscountGroup.

    description?: LocalizedString

    Description of the DiscountGroup.

    id: string

    Unique identifier of the DiscountGroup.

    isActive: boolean

    A DiscountGroup must be active for its CartDiscounts to be considered during discount application.

    key: string

    User-defined unique identifier of the DiscountGroup.

    lastModifiedAt: string

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

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the DiscountGroup.

    name?: LocalizedString

    Name of the DiscountGroup.

    sortOrder: string

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

    The sort order is unique among all DiscountGroups and CartDiscounts.
    version: number

    Current version of the DiscountGroup.

    Settings

    Member Visibility

    On This Page

    Properties