Promo Groups

Data in this section is described in accordance with the Conexxus Standard: https://www.conexxus.org/.

In this section, the following information about the Promo Groups data is presented:

Promo Groups Settings in CStoreOffice®
Promo Groups Data Mapping Table
XML Example with Promo Groups Data
Promo Groups Data Export via the Business Documents API

Promo Groups Settings in CStoreOffice®

Promo Groups data used by the system is taken from the account price book. In CStoreOffice®, you can find promo group data in the Promo Group form:

This form can be opened from the Price Book > Promo Groups list. For more information, see Promo Groups.

Promo Groups Data Mapping Table

Promo Groups data from the above form is converted to XML data according to the Promo Group Data Mapping Table which is presented below.

Promo Groups Data Mapping Table

XML Path	Description
/NAXML-MaintenanceRequest/ TransmissionHeader/StoreLocationID	CSO Location ID.
/NAXML-MaintenanceRequest/ TransmissionHeader/VendorName	Permanent value CStoreOffice® representing CSO as source or information.
/NAXML-MaintenanceRequest/ TransmissionHeader/VendorModelVersion	XML version used for document - NAXML3.4.5.
/NAXML-MaintenanceRequest/ TransmissionHeader/Extension/AccounID	CSO Account ID used for data export.
/NAXML-MaintenanceRequest/ TransmissionHeader/Extension/AccountName	CSO Account Name used for data export.
XML Path	PB Source
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/ TableAction/@type	Saving mode for record passed in XML. Possible modes: initialize update Description for each mode can be found in XSD. For products hierarchy records it will be always passed as update.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/ RecordAction/@type	Action type for particular record passed create: Creates a new record. modify: Modifies an existing record. delete: Deletes a record. addchange: Adds a record, if no records exist, or modifies already existing record. In most cases only two actions are used for Price Groups: addchange: When passing a new record or updating an existing one. delete: When deleting a record.
XML Path	Description
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ Extension/TableName	Type of passed entities: Departments Categories ItemTags PriceGroups PromoGroups The PromoGroups entity is used for Promo Groups.
XML Path	PB Source
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ MerchandiseCode	Unique entity ID in CSO. Depending on the entity type the following IDs are applied: Departments: The CR Department # field's value from the CR Department form. Categories: The Category ID field's value from the Category form. PriceGroups: The Price Group ID field's value from the Price Group form. PromoGroups: The Promo Group ID field from the Promo Group form. ItemTags: Contains Tags ID hierarchy separated by dot. Level attribute is also passed. For example, the item tags ID can be equal to 9.1.2.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ MerchandiseCode/@level	Always passed if IDs hierarchy is passed (e.g. for tags), matches hierarchy level passed in the Merchandise Code tag. For example, if 9.1 is passed as the MCTDetail/MerchandiseCode value then level = 2. For root level tags level =1.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ ActiveFlag/@value	Activity flag for passed record. Is always passed as yes.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ MerchandiseCodeDescription	Entity name as it is saved in CSO. Depending on the entity type the following names are applied: Departments: The Name field's value from the CR Department form. Categories: The Category Name field's value from the Category form. PriceGroups: The Price Group Name field's value from the Price Group form. PromoGroups: The Promo Group Name field's value from the Promo Group form. ItemTags: The Name field's value from the Item Tag form.
In resulting XML: /NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ Extension In XSD Schema: nax:NAXML-MaintenanceRequest/ nax:MerchandiseCodeMaintenance/ nax:MCTDetail/nax:Extension	Additional fields available in CSO for entity, but not supported by Conexxus are passed in this extension section.

To learn more about CStoreOffice® forms and entities mentioned in the Description and PB Source columns, use the Promo Groups Settings in CStoreOffice® section or Petrosoft University Portal.

XML Example with Promo Groups Data

The example below is taken from the testing environment with testing data. No association with any real company, product, event, or data is intended or should be inferred.

XML Example with Promo Groups Data


<?xml version="1.0"?>
<NAXML-MaintenanceRequest xmlns="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" version="3.5">
  <TransmissionHeader>
    <StoreLocationID/>
    <VendorName/>
    <VendorModelVersion>NAXML3.4.5</VendorModelVersion>
    <Extension>
      <AccountID>xxx</AccountID>
      <AccountName>xxx</AccountName>
    </Extension>
  </TransmissionHeader>
  <MerchandiseCodeMaintenance>
    <TableAction type="update"/>
    <RecordAction type="addchange"/>
    <MCTDetail>
      <MerchandiseCode>46</MerchandiseCode>
      <ActiveFlag value="yes"/>
      <MerchandiseCodeDescription>NEWPORT CTN</MerchandiseCodeDescription>
      <Extension>
        <TableName>PromoGroups</TableName>
      </Extension>
    </MCTDetail>
  </MerchandiseCodeMaintenance>
</NAXML-MaintenanceRequest>

To download the XML Example with Promo Groups Data XML file, click here.

Promo Groups Data Export via the Business Documents API

To export the XML files with the Promo Groups data via the Business Documents API:

Start calling the API from the /account-level-resources endpoint.
Use promo-groups as the Document type identifier value.

For more information, see Calling the Business Documents API at the Account Level.