Interface DiscountCodeImport

The data representation for a Discount Code to be imported that is persisted as a Discount Code in the Project.

interface DiscountCodeImport {
    cartDiscounts: CartDiscountKeyReference[];
    cartPredicate?: string;
    code: string;
    custom?: Custom;
    description?: LocalizedString;
    groups?: string[];
    isActive: boolean;
    key: string;
    maxApplications?: number;
    maxApplicationsPerCustomer?: number;
    name?: LocalizedString;
    validFrom?: string;
    validUntil?: string;
}

Hierarchy (view full)

Properties

cartDiscounts cartPredicate? code custom? description? groups? isActive key maxApplications? maxApplicationsPerCustomer? name? validFrom? validUntil?

Properties

Readonly cartDiscounts

cartDiscounts: CartDiscountKeyReference[]

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Optional Readonly cartPredicate

cartPredicate?: string

DiscountCode can only be applied to Carts that match this predicate.

Readonly code

code: string

User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.

Optional Readonly custom

custom?: Custom

Custom Fields of the DiscountCode.

Optional Readonly description

description?: LocalizedString

Maps to DiscountCode.description.

Optional Readonly groups

groups?: string[]

Groups to which the DiscountCode belongs.

Readonly isActive

isActive: boolean

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

Readonly key

key: string

User-defined unique identifier. If a Discount Code with this key exists, it will be updated with the imported data.

Optional Readonly maxApplications

maxApplications?: number

Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.

Optional Readonly maxApplicationsPerCustomer

maxApplicationsPerCustomer?: number

Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.

Optional Readonly name

name?: LocalizedString

Maps to DiscountCode.name.

Optional Readonly validFrom

validFrom?: string

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

Optional Readonly validUntil

validUntil?: string

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

Settings

Member Visibility

Theme

On This Page

cartDiscountscartPredicatecodecustomdescriptiongroupsisActivekeymaxApplicationsmaxApplicationsPerCustomernamevalidFromvalidUntil