Reference - Promotion Code Group - XML Import Specification

Intershop Commerce Management / Experience Management / Promotions

Document Properties

Kbid

484Z20

Added to KB

17-Jul-2026

Status

online

Product

ICM 11
ICM 13

Last Modified

17-Jul-2026

Public Access

everyone

Doc Type

References

Product

ICM 12
ICM 14

Document Link

https://knowledge.intershop.com/kb/484Z20

Share Link

Share this document

Introduction

The promotion-code-group element defines a promotion code group within the Intershop Commerce Management marketing import/export framework. A promotion code group contains and assigns promotion codes, and holds additional attributes for labeling dependencies to assigned promotions.

It supports:

Time-based validity (start/end date)
Usage limits (global and per customer)
Target group assignments (consumer groups, affiliate partners, affiliate programs)
Application assignments
Promotion references
Custom attributes

Element: `promotion-code-group`

A promotion code group contains (assigns) the promotion codes and other attributes for labeling dependencies to assigned promotions.

Attributes

Attribute	Type	Required	Description
`id`	`simpleType.Generic.String.256`	Yes	Unique identifier of the promotion code group. Limited to 256 characters.

Child Elements (Sequence)

Element	Type	Min	Max	Description
`use-promotion-time`	`boolean`	1	1	If `true`, the time frame of the assigned promotion is used.
`start-date`	`simpleType.DateTime`		1	Start date of the promotion code group validity. Only relevant if `use-promotion-time` is `false`.
`end-date`	`simpleType.DateTime`		1	End date of the promotion code group validity. Only relevant if `use-promotion-time` is `false`.
`number-of-reuses`	`int`		1	Optional. Total number of allowed reuses of the contained promotion codes. `1` means all codes are single codes. If omitted or `0`, unlimited reuses are allowed.
`number-of-reuses-per-customer`	`int`		1	Optional. Maximum reuses of the contained promotion codes per customer. If omitted or `0`, unlimited reuses are allowed.
`enabled`	`boolean`	1	1	Specifies whether the promotion code group is active (`true`) or inactive (`false`).
`use-promotion-target-groups`	`boolean`	1	1	If `true`, the target groups of the assigned promotion are used. Otherwise `target-group` must be set.
`use-promotion-apps`	`boolean`	1	1	If `true`, the applications of the assigned promotion are used. Otherwise `applications` must be set.
`target-group`	`PCGTargetGroup`	1	1	References assigned user groups (consumer groups and affiliates). Only relevant if `use-promotion-target-groups` is `false`.
`applications`	`string`		unbounded	Defines assignment to an application. Each application must have its own element. Only relevant if `use-promotion-apps` is `false`.
`promotions`	`Promotions`	1	1	References assigned promotions by their IDs.
`custom-attributes`	`complexType.CustomAttributes`		1	Optional custom attributes for extensibility.

Complex Type: `Promotions`

Defines the assignment to one or more promotions.

Child Elements

Element	Type	Min	Max	Description
`promotion-id`	`simpleType.Generic.String.256`		unbounded	ID of a promotion assigned to this code group.

Complex Type: `PCGTargetGroup`

References assigned user groups for the promotion code group.

Child Elements

Element	Type	Min	Max	Description
`consumer-groups`	`PCGConsumerGroupsRef`		unbounded	References to assigned consumer groups.
`affiliates`	`PCGAffiliatesRef`		unbounded	References to assigned affiliate groups.

Complex Type: `PCGConsumerGroupsRef`

Container for consumer group references.

Child Elements

Element	Type	Min	Max	Description
`consumer-group`	`PCGConsumerGroupRef`		unbounded	Reference to a single consumer group.

Complex Type: `PCGAffiliatesRef`

Description: Container for affiliate references.

Child Elements

Element	Type	Min	Max	Description
`affiliate-partner`	`PCGAffiliatePartnerRef`		unbounded	Reference to an affiliate partner.
`affiliate-program`	`PCGAffiliateProgramRef`		unbounded	Reference to an affiliate program.

Complex Type: `PCGConsumerGroupRef`

Reference to a specific consumer group with reuse settings.

Attributes

Attribute	Type	Required	Description
`id`	`string`	Yes	ID of the referenced consumer group.
`domain`	`string`	Yes	Domain of the consumer group.

Child Elements

Element	Type	Min	Max	Description
`number-of-reuses`	`int`		1	Optional. Maximum reuses for this group. If omitted or `0`, unlimited reuses are allowed.
`number-of-redemptions`	`int`	1	1	Number of redemptions for this consumer group.

Complex Type: `PCGAffiliatePartnerRef`

Reference to a specific affiliate partner with reuse settings.

Attributes

Attribute	Type	Required	Description
`id`	`string`	Yes	ID of the referenced affiliate partner.
`domain`	`string`	Yes	Domain of the affiliate partner.

Child Elements

Element	Type	Min	Max	Description
`number-of-reuses`	`int`		1	Optional. Maximum reuses for this partner. If omitted or `0`, unlimited reuses are allowed.
`number-of-redemptions`	`int`	1	1	Number of redemptions for this affiliate partner.

Complex Type: `PCGAffiliateProgramRef`

Reference to a specific affiliate program with reuse settings.

Attributes

Attribute	Type	Required	Description
`id`	`string`	Yes	ID of the referenced affiliate program.
`partner`	`string`	Yes	Partner identifier of the affiliate program.
`domain`	`string`	Yes	Domain of the affiliate program.

Child Elements

Element	Type	Min	Max	Description
`number-of-reuses`	`int`		1	Optional. Maximum reuses for this program. If omitted or `0`, unlimited reuses are allowed.
`number-of-redemptions`	`int`	1	1	Number of redemptions for this affiliate program.

Full XSD Schema

<xsd:schema xmlns:ns="http://www.intershop.com/xml/ns/enfinity/6.6/bc_marketing/impex"
            xmlns:jxb="https://jakarta.ee/xml/ns/jaxb"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
            elementFormDefault="qualified"
            jxb:version="3.0">

  <xsd:include schemaLocation="core.xsd"/>

  <!-- PromotionCodeGroup -->
  <xsd:element name="promotion-code-group">
    <xsd:complexType mixed="false">
      <xsd:annotation>
        <xsd:documentation>
          PromotionCodeGroup contains (assigns) the promotion codes and other attributes
          for labeling dependencies to assigned promotions.
        </xsd:documentation>
      </xsd:annotation>
      <xsd:sequence>
        <xsd:element name="use-promotion-time" type="xsd:boolean"/>
        <xsd:element name="start-date" type="simpleType.DateTime" minOccurs="0"/>
        <xsd:element name="end-date" type="simpleType.DateTime" minOccurs="0"/>
        <xsd:element name="number-of-reuses" type="xsd:int" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>
              This is an optional field. If not inside the import, the field is set to 0
              at the persistent object. 0 indicates unlimited reuses.
            </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="number-of-reuses-per-customer" type="xsd:int" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>
              This is an optional field. If not inside the import, the field is set to 0
              at the persistent object. 0 indicates unlimited reuses.
            </xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="enabled" type="xsd:boolean"/>
        <xsd:element name="use-promotion-target-groups" type="xsd:boolean"/>
        <xsd:element name="use-promotion-apps" type="xsd:boolean"/>
        <xsd:element name="target-group" type="PCGTargetGroup"/>
        <xsd:element name="applications" type="xsd:string" maxOccurs="unbounded" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>Defines assignment to an application.</xsd:documentation>
          </xsd:annotation>
        </xsd:element>
        <xsd:element name="promotions" type="Promotions"/>
        <xsd:element name="custom-attributes" type="complexType.CustomAttributes" minOccurs="0"/>
      </xsd:sequence>
      <xsd:attribute name="id" type="simpleType.Generic.String.256" use="required"/>
    </xsd:complexType>
  </xsd:element>

  <!-- Promotions -->
  <xsd:complexType name="Promotions">
    <xsd:annotation>
      <xsd:documentation>Defines assignment to a promotion.</xsd:documentation>
    </xsd:annotation>
    <xsd:sequence>
      <xsd:element name="promotion-id" type="simpleType.Generic.String.256"
                   minOccurs="0" maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>

  <!-- PCGTargetGroup -->
  <xsd:complexType name="PCGTargetGroup">
    <xsd:annotation>
      <xsd:documentation>References assigned userGroups.</xsd:documentation>
    </xsd:annotation>
    <xsd:sequence>
      <xsd:element name="consumer-groups" type="PCGConsumerGroupsRef"
                   minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="affiliates" type="PCGAffiliatesRef"
                   minOccurs="0" maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>

  <!-- PCGConsumerGroupsRef -->
  <xsd:complexType name="PCGConsumerGroupsRef">
    <xsd:sequence>
      <xsd:element name="consumer-group" type="PCGConsumerGroupRef"
                   minOccurs="0" maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>

  <!-- PCGAffiliatesRef -->
  <xsd:complexType name="PCGAffiliatesRef">
    <xsd:sequence>
      <xsd:element name="affiliate-partner" type="PCGAffiliatePartnerRef"
                   minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element name="affiliate-program" type="PCGAffiliateProgramRef"
                   minOccurs="0" maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>

  <!-- PCGConsumerGroupRef -->
  <xsd:complexType name="PCGConsumerGroupRef">
    <xsd:sequence>
      <xsd:element name="number-of-reuses" type="xsd:int" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>
            This is an optional field. If not inside the import, the field is set to 0
            at the persistent object. 0 indicates unlimited reuses.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="number-of-redemptions" type="xsd:int"/>
    </xsd:sequence>
    <xsd:attribute name="id" type="xsd:string" use="required"/>
    <xsd:attribute name="domain" type="xsd:string" use="required"/>
  </xsd:complexType>

  <!-- PCGAffiliatePartnerRef -->
  <xsd:complexType name="PCGAffiliatePartnerRef">
    <xsd:sequence>
      <xsd:element name="number-of-reuses" type="xsd:int" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>
            This is an optional field. If not inside the import, the field is set to 0
            at the persistent object. 0 indicates unlimited reuses.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="number-of-redemptions" type="xsd:int"/>
    </xsd:sequence>
    <xsd:attribute name="id" type="xsd:string" use="required"/>
    <xsd:attribute name="domain" type="xsd:string" use="required"/>
  </xsd:complexType>

  <!-- PCGAffiliateProgramRef -->
  <xsd:complexType name="PCGAffiliateProgramRef">
    <xsd:sequence>
      <xsd:element name="number-of-reuses" type="xsd:int" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>
            This is an optional field. If not inside the import, the field is set to 0
            at the persistent object. 0 indicates unlimited reuses.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="number-of-redemptions" type="xsd:int"/>
    </xsd:sequence>
    <xsd:attribute name="id" type="xsd:string" use="required"/>
    <xsd:attribute name="partner" type="xsd:string" use="required"/>
    <xsd:attribute name="domain" type="xsd:string" use="required"/>
  </xsd:complexType>

</xsd:schema>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Website, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Introduction

Element: promotion-code-group

Attributes

Child Elements (Sequence)

Complex Type: Promotions

Child Elements

Complex Type: PCGTargetGroup

Child Elements

Complex Type: PCGConsumerGroupsRef

Child Elements

Complex Type: PCGAffiliatesRef

Child Elements

Complex Type: PCGConsumerGroupRef

Attributes

Child Elements

Complex Type: PCGAffiliatePartnerRef

Attributes

Child Elements

Complex Type: PCGAffiliateProgramRef

Attributes

Child Elements

Full XSD Schema

Element: `promotion-code-group`

Complex Type: `Promotions`

Complex Type: `PCGTargetGroup`

Complex Type: `PCGConsumerGroupsRef`

Complex Type: `PCGAffiliatesRef`

Complex Type: `PCGConsumerGroupRef`

Complex Type: `PCGAffiliatePartnerRef`

Complex Type: `PCGAffiliateProgramRef`