Interface DiscountCodeDraft

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

Properties

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

Properties

ReadonlycartDiscounts

cartDiscounts: CartDiscountResourceIdentifier[]

Specify what CartDiscounts the API applies when you add the DiscountCode to the Cart.

Optional ReadonlycartPredicate

cartPredicate?: string

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

Readonlycode

code: string

User-defined unique identifier for the DiscountCode that can be added to the Cart to apply the related CartDiscounts. It cannot be modified after the DiscountCode is created.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the DiscountCode.

Optional Readonlydescription

description?: LocalizedString

Description of the DiscountCode.

Optional Readonlygroups

groups?: string[]

Groups to which the DiscountCode will belong to.

Optional ReadonlyisActive

isActive?: boolean

Only active DiscountCodes can be applied to the Cart.

Optional Readonlykey

key?: string

User-defined unique identifier for the DiscountCode.

This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Discount Codes with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).

Optional ReadonlymaxApplications

maxApplications?: number

Number of times the DiscountCode can be applied.

If not set, the DiscountCode can be applied any number of times.

Optional ReadonlymaxApplicationsPerCustomer

maxApplicationsPerCustomer?: number

Number of times the DiscountCode can be applied per Customer.

If not set, the DiscountCode can be applied any number of times.

Optional Readonlyname

name?: LocalizedString

Name of the DiscountCode.

Optional ReadonlyvalidFrom

validFrom?: string

Date and time (UTC) from which the DiscountCode is effective. Must be earlier than validUntil.

Optional ReadonlyvalidUntil

validUntil?: string

Date and time (UTC) until which the DiscountCode is effective. Must be later than validFrom.

Settings

Member Visibility

On This Page

Properties