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 Summary)

Properties

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

Properties

ReadonlycartDiscounts

cartDiscounts: CartDiscountKeyReference[]

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

Optional ReadonlycartPredicate

cartPredicate?: string

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

Readonlycode

code: string

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

The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.

Optional Readonlycustom

custom?: Custom

Custom Fields of the DiscountCode.

Optional Readonlydescription

description?: LocalizedString

Maps to DiscountCode.description.

Optional Readonlygroups

groups?: string[]

Groups to which the DiscountCode belongs.

ReadonlyisActive

isActive: boolean

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

Readonlykey

key: string

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

Optional ReadonlymaxApplications

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 ReadonlymaxApplicationsPerCustomer

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 Readonlyname

name?: LocalizedString

Maps to DiscountCode.name.

Optional ReadonlyvalidFrom

validFrom?: string

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

Optional ReadonlyvalidUntil

validUntil?: string

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

Settings

Member Visibility

On This Page

Properties