Promotion and Campaign Object Import/Export

Use the promotion.xsd schema file to import campaigns and promotions. Promotions can be assigned to multiple campaigns.

Granularity: selected promotion. See Exporting Individual Promotions.

Business Manager Import Location

Online Marketing > Import & Export

Administration > Site Development > Import & Export

Globally Excluded Products Import/Export

Global Product Exclusions rules are imported as part of promotion import. An empty Global Product Exclusions rule isn't exported. Global product exclusion rule are replicated with the campaigns and promotions of the site. New promotion-level settings are replicated with the promotion.

The promotion.xsd top level element <promotions> contains the element <global-promotion-settings> of complex type PromotionSettings. This element is the container of the <global-excluded-products> rule.

The <global-promotion-settings> element is optional and can occur at most once. The complex types ProductPromotionRule and OrderPromotionRule support the flag <disable-global-excluded-products>.

A site always owns a PromotionSettings instance. This instance can never be deleted, but only reset. The following is how the different modes behave:

<promotion-settings> UPDATE/MERGE REPLACE DELETE
with <global-excluded-products> Global excluded product rule is created or updated. PromotionSettings instance is reset to its initial state (means all of its values are removed), after that global excluded products rule is new created. PromotionSettings instance is reset to its initial state (means all of its values are removed).
with <global-excluded-products/> empty Global excluded product rule is removed, if it exists. PromotionSettings instance is reset to its initial state (means all of its values are removed), after that global excluded products rule is NOT new created. PromotionSettings instance is reset to its initial state (means all of its values are removed).
empty PromotionSettings instance isn't touched. PromotionSettings instance is reset to its initial state (means all of its values are removed). PromotionSettings instance is reset to its initial state (means all of its values are removed).
undefined PromotionSettings instance isn't touched. PromotionSettings instance isn't touched. PromotionSettings instance isn't touched.
Note: If promotions are created with no <disable-global-excluded-products> flag, import sets the default value to FALSE. The import always updates the global-excluded-products rule completely. There is no partial update of the rule.

Attribute Operators

Promotion product and shipping product rules support operators for system and custom attributes.

System Attribute Operators

Attribute Operators
ID

is equal

is not equal

starts with

ends with

Brand

exists

doesn't exist

is equal

is not equal

starts with

ends with

Custom Attribute Operators

This table lists the operators available for any custom attributes you choose to create. The operators available differ by the data type of the attribute.
Data Type Operators
String and Set-of-String

exists

doesn't exist

is equal

is not equal

starts with

ends with

Enum-of-String

is equal

is not equal

starts with

ends with

Integer, Set-of-Integer and Enum-of-Integer

exists

doesn't exist

is equal

is not equal

is greater than or equals

is less than or equals

Boolean

exists

doesn't exist

is equal

Promotion-Campaign-Assignment

The <promotion-campaign-assignment> element is at the top level in the XML for assignment of promotions to campaigns.

  • Each <promotion-campaign-assignment> element requires a <promotion-id> and <campaign-id> that match a valid promotion and campaign. If a promotion or campaign isn't found, an error message is logged and the element is skipped. All contained elements are optional. When optional elements are not provided for existing assignments in MERGE or UPDATE modes, the corresponding values are not changed. When optional elements are not provided for new assignments in MERGE and REPLACE modes, default values are used.
  • Deletes are supported for the <promotion-campaign-assignment> element using mode="delete". When only a <promotion-id> or <campaign-id> is provided, it's a wildcard delete of either assignments of a specified promotion to all campaigns, or the assignments of all promotions to a specified campaign. When both <promotion-id> and <campaign-id> are provided, it's a delete of the assignment of the specified promotion to the specified campaign. A warning message is logged if the wildcard delete can't be performed because no assignments match the criteria.

Trimmed Whitespace

When editing the product rules of promotions and shipping methods, it's possible to enter IDs for Products, Price Books, Brands or Catalog Categories with leading and trailing white spaces. The IDs are trimmed when saving a product rule in Business Manager. The promotion and shipping method export also trims the IDs contained in the product rules of existing promotions or shipping methods.

Pipelets

ImportPromotions

ExportPromotions