action

Yes

int

The action is required for imports but is null when returning export information. The valid values are:

ACTION_ADD
ACTION_UPDATE

Note that there is no DELETE action available for promotions. This means that you cannot accidentally delete promotions that are being used by merchandisers.

promotionPropertyValues

No

Map<String,String>

A map of promotion repository item property names and their corresponding values.

If you are not using templates, specify the PMDL rule for the promotion in this map. If you are using templates, you can use the templateValues map (see below in this table) to build the PMDL instead.

Note: The templateId and templateValues properties are separated from other promotion properties, and do not need to be included in the map (see below in this table).

promotionFolderPath

No

String

Promotions can be organized using a logical folder structure. This property specifies the full folder path. For example:

“/Summer/Shoes”

The Promotions Import Export API converts this path into individual promotion folders, creates those which do not already exist, and links them together into a tree structure.

Note that no two children of the same parent folder can have the same name, but folders can have the same name if they are child folders of different parent folders.

templateId

No

String

If the promotion is based on a template, the path and filename of the template to use.

templateValues

No

Map<String,String>

A map of template placeholders and their corresponding values.

See any of the existing promotions templates for an understanding of this mapping.

closenessQualifiers

No

List<ClosenessQualifierImportExportInfo>

A list of ClosenessQualifierImportExportInfo objects.

coupons

No

List<CouponImportExportInfo>

A list of CouponImportExportInfo objects.

action

Yes

int

The action is required for imports but is null when returning export information. The valid values are:

ACTION_ADD
ACTION_UPDATE
ACTION_DELETE

closenessQualifierPropertyValues

No

Map<String,String>

A map of closeness qualifier repository item property names and their corresponding values.

closenessQualifierTemplateValues

No

Map<String,String>

A map of template placeholders and their corresponding values, specifically for the closeness qualifier section of the template.

action

Yes

int

The action is required for imports but is null when returning export information. The valid values are:

ACTION_ADD
ACTION_UPDATE
ACTION_DELETE

couponPropertyValues

Yes

Map<String,String>

A map of coupon repository item property names and their corresponding values.

couponFolderPath

No

String

Coupons can be organized using a logical folder structure. This property specifies the full folder path. For example:

“/Summer/Shoes”

The Promotions Import Export API converts this path into individual coupon folders, creates those which don’t already exist, and links them together into a tree structure.

Note no two children of the same parent folder can have the same name, but folders can have the same name if they are child folders of different parent folders.