Price 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 Price Groups data is presented:
- Price Groups Settings in CStoreOffice®
- Price Groups Data Mapping Table
- XML Example with Price Group Data
- Price Groups Data Export via the Business Documents API
Price Groups Settings in CStoreOffice®
Price Groups data used by the system is taken from the account price book. In CStoreOffice®, you can find price group data in the Price Group form:
This form can be opened from the Price Book > Price Groups list. For more information, see Price Groups.
Price Groups Data Mapping Table
Price Groups data from the above form is converted to XML data according to the Price Groups Data Mapping Table which is presented below.
![Closed](../../Skins/Default/Stylesheets/Images/transparent.gif)
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:
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
In most cases only two actions are used for Price Groups:
|
XML Path |
Description |
/NAXML-MaintenanceRequest/ MerchandiseCodeMaintenance/MCTDetail/ Extension/TableName |
Type of passed entities:
The PriceGroups entity is used for Price 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:
|
/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:
|
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 Price Group Settings in CStoreOffice® section or Petrosoft University Portal.
XML Example with Price 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.
![Closed](../../Skins/Default/Stylesheets/Images/transparent.gif)
<?xml version="1.0"?>
<MCTDetail>
<MerchandiseCode>1</MerchandiseCode>
<ActiveFlag value="yes"/>
<MerchandiseCodeDescription>RJR</MerchandiseCodeDescription>
</MCTDetail>
To download the XML Example with Price Groups Data XML file, click here.
Price Groups Data Export via the Business Documents API
To export the XML files with the Price Groups data via the Business Documents API:
- Start calling the API from the
/account-level-resources
endpoint. - Use price-groups as the Document type identifier value.
For more information, see Calling the Business Documents API at the Account Level.