Item Tags

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

In this section, the following information about the Item Tags data is presented:

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

Item Tags Settings in CStoreOffice®

Item tags data used by the system is taken from the account price book. In CStoreOffice®, you can find item tags data in the Item Tags form:

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

Item Tags Data Mapping Table

Item Tags data from the above form is converted to XML data according to the Item Tags Data Mapping Table which is presented below.

Item Tags 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.
/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 ItemTags: addchange: When passing a new record or updating an existing one. delete: When deleting a record.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/ MCTDetail/Extension/TableName	Type of passed entities: Departments Categories ItemTags PriceGroups PromoGroups The ItemTags entity is used for Item Tags.
/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.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/ MCTDetail/Extension	Additional fields available in CSO for entity, but not supported by Conexxus are passed in this extension section.
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/ MCTDetail/LinkCode/@type	Type of passed link to price book items (if any is passed in the same document). Possible values: upcA, upcE, gtin, plu: If only one item is passed. itemList: list ID passed, links tag with list passed in /NAXML-MaintenanceRequest/ItemListMaintenance
/NAXML-MaintenanceRequest/ ItemListMaintenance	Identify section of items list.
/NAXML-MaintenanceRequest/ ItemListMaintenance/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/ ItemListMaintenance/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 for items list only addchange will be passed.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail	Indicates list beginning of item list details (item records).
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListID	List ID, equals to ID passed in LinkCode.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ ItemListDescription	List description according to template: Items for tag {MerchandiseCode}{ MerchandiseCodeDescription}
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListEntry	Section providing items details for each item assigned to a tag.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ ItemListEntry/ItemCode	Section for item code details.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListEntry/ ItemCode/POSCodeFormat/@format	Item code format. Possible values: upcA, gtin, plu, and so on. For items tag items list gtin value will be passed.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListEntry/ ItemCode/POSCodeFormat/@checkDigit	Indicates, if checkdigit included in item code passed. Possible values: present and absent.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListEntry/ ItemCode/POSCode	GTIN code for item that is assigned to item tag.
/NAXML-MaintenanceRequest/ ItemListMaintenance/ILTDetail/ItemListEntry/ ItemCode/POSCodeModifier	POS Code modifier number if any. For this report is always sent as zero (0).

To learn more about CStoreOffice® forms and entities mentioned in the Description column, use the Item Tags Settings in CStoreOffice® section or Petrosoft University Portal.

XML Example with Item Tags 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 Item Tags Data


<?xml version="1.0"?>
<NAXML-MaintenanceRequest xmlns:nax="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" version="3.5">
  <TransmissionHeader>
    <StoreLocationID/>
    <VendorName>Tony Noonan</VendorName>
    <VendorModelVersion>NAXML3.4.5</VendorModelVersion>
    <Extension>
      <AccountID>xxx</AccountID>
      <AccountName>xxx</AccountName>
    </Extension>
  </TransmissionHeader>
  <ItemListMaintenance>
    <TableAction type="update"/>
    <RecordAction type="addchange"/>
    <ILTDetail>
      <ItemListID>2137.4321ROCKYMOUNTTELEGRAM</ItemListID>
      <ItemListDescription>Items for tag</ItemListDescription>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="gtin" checkDigit="present"/>
          <POSCode>00700776000500</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="gtin" checkDigit="present"/>
          <POSCode>00700776001255</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
    </ILTDetail>
  </ItemListMaintenance>
  <MerchandiseCodeMaintenance>
    <TableAction type="update"/>
    <RecordAction type="addchange"/>
    <MCTDetail>
      <MerchandiseCode level="2">2137.4321</MerchandiseCode>
      <ActiveFlag value="yes"/>
      <MerchandiseCodeDescription>ROCKY MOUNT TELEGRAM</MerchandiseCodeDescription>
      <LinkCode type="itemList">2137.4321ROCKYMOUNTTELEGRAM</LinkCode>
      <Extension>
        <TableName>ItemTags</TableName>
        <Number>18</Number>
      </Extension>
    </MCTDetail>
    <MCTDetail>
      <MerchandiseCode level="1">2137</MerchandiseCode>
      <ActiveFlag value="yes"/>
      <MerchandiseCodeDescription>PUBLICATIONS</MerchandiseCodeDescription>
      <LinkCode type="itemList">2137PUBLICATIONS</LinkCode>
      <Extension>
        <TableName>ItemTags</TableName>
        <Number>23</Number>
      </Extension>
    </MCTDetail>
  </MerchandiseCodeMaintenance>
</NAXML-MaintenanceRequest>

To download the XML Example with Item Tags Data XML file, click here.

Item Tags Data Export via the Business Documents API

To export the XML files with the Item Tags data via the Business Documents API:

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

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