Cash Register Promotions Conexxus 3.5 PULL API

API endpoint returns Promotions datasets settings on a particular cash register. Data returned in Conexxus 3.5 standard for the following reports:

MixMatchMaintenance
ComboMaintenance

Detailed API description is provided by Petrosoft Swagger according to OpenAPI Specification.

Examples of XML Documents returned by API

The examples below are 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 CBT Data


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NAXML-MaintenanceRequest xmlns="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" version="3.4">
  <TransmissionHeader>
    <StoreLocationID>14872</StoreLocationID>
    <VendorName>VeriFone</VendorName>
    <VendorModelVersion>Commander Site Controller</VendorModelVersion>
  </TransmissionHeader>
  <ComboMaintenance>
    <TableAction type="initialize"/>
    <RecordAction type="addchange"/>
    <CBTDetail>
      <Promotion>
        <PromotionID>219153</PromotionID>
      </Promotion>
      <ComboDescription>TestProm13</ComboDescription>
      <ComboList>
        <ComboItemList>
          <ItemListID>21751659387</ItemListID>
          <ComboItemQuantity>2</ComboItemQuantity>
          <ComboItemDiscountAllocation type="amount">7.990</ComboItemDiscountAllocation>
        </ComboItemList>
        <ComboItemList>
          <ItemListID>21751659390</ItemListID>
          <ComboItemQuantity>2</ComboItemQuantity>
          <ComboItemDiscountAllocation type="percent">10.990</ComboItemDiscountAllocation>
        </ComboItemList>
      </ComboList>
      <StartDate>2021-06-29</StartDate>
      <StartTime>00:00:01</StartTime>
      <StopDate>2025-01-01</StopDate>
      <StopTime>23:59:59</StopTime>
      <WeekdayAvailability weekday="Sunday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Monday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Tuesday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Wednesday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Thursday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Friday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <WeekdayAvailability weekday="Saturday" available="yes" startTime="00:00:00" stopTime="23:59:00"/>
      <Priority>medium</Priority>
      <Extension>
        <ns2:TaxableRebate xmlns:ns2="urn:vfi-sapphire:np.naxmlext.2005-06-24">
          <ns2:Amount>0.00</ns2:Amount>
        </ns2:TaxableRebate>
      </Extension>
    </CBTDetail>
  </ComboMaintenance>
</NAXML-MaintenanceRequest>

To download the XML example with CBT data, click here.

XML Example with ILT Data


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NAXML-MaintenanceRequest xmlns="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" version="3.4">
  <TransmissionHeader>
    <StoreLocationID>1179</StoreLocationID>
    <VendorName>VeriFone</VendorName>
    <VendorModelVersion>Commander Site Controller</VendorModelVersion>
  </TransmissionHeader>
  <ItemListMaintenance>
    <TableAction type="initialize"/>
    <RecordAction type="addchange"/>
    <ILTDetail>
      <ItemListID>1259951</ItemListID>
      <ItemListDescription>2 pk GPC</ItemListDescription>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00075926050361</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
    </ILTDetail>
    <ILTDetail>
      <ItemListID>1286218</ItemListID>
      <ItemListDescription>seeds 2/$1</ItemListDescription>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00028400041775</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00000000048644</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00051943414577</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00072600006720</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00072600016750</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00072600016767</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
    </ILTDetail>
    <ILTDetail>
      <ItemListID>1407356</ItemListID>
      <ItemListDescription>Marlboro RED .50 off Margin 1.00 RED</ItemListDescription>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00028200178237</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
      <ItemListEntry>
        <ItemCode>
          <POSCodeFormat format="none"/>
          <POSCode>00028200178244</POSCode>
          <POSCodeModifier>0</POSCodeModifier>
        </ItemCode>
      </ItemListEntry>
    </ILTDetail>
  </ItemListMaintenance>
</NAXML-MaintenanceRequest>

To download the XML example with ILT data, click here.

XML Example with MMT Data


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NAXML-MaintenanceRequest xmlns="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" version="3.4">
  <TransmissionHeader>
    <StoreLocationID>1179</StoreLocationID>
    <VendorName>VeriFone</VendorName>
    <VendorModelVersion>Commander Site Controller</VendorModelVersion>
  </TransmissionHeader>
  <MixMatchMaintenance>
    <TableAction type="initialize"/>
    <RecordAction type="addchange"/>
    <MMTDetail>
      <Promotion>
        <PromotionID>1259951</PromotionID>
      </Promotion>
      <MixMatchDescription>2 pk GPC</MixMatchDescription>
      <MixMatchStrictHighFlag value="yes"/>
      <MixMatchStrictLowFlag value="yes"/>
      <ItemListID>1259951</ItemListID>
      <StartDate>2018-10-01</StartDate>
      <StartTime>00:00:01</StartTime>
      <StopDate>2025-01-01</StopDate>
      <StopTime>23:59:59</StopTime>
      <WeekdayAvailability weekday="Sunday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Monday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Tuesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Wednesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Thursday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Friday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Saturday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <MixMatchEntry>
        <MixMatchUnits>2</MixMatchUnits>
        <MixMatchPrice>17.460</MixMatchPrice>
      </MixMatchEntry>
      <Priority/>
      <Extension>
        <ns2:TaxableRebate xmlns:ns2="urn:vfi-sapphire:np.naxmlext.2005-06-24">
          <ns2:Amount>0.00</ns2:Amount>
        </ns2:TaxableRebate>
      </Extension>
    </MMTDetail>
    <MMTDetail>
      <Promotion>
        <PromotionID>1286218</PromotionID>
      </Promotion>
      <MixMatchDescription>seeds 2/$1</MixMatchDescription>
      <MixMatchStrictHighFlag value="yes"/>
      <MixMatchStrictLowFlag value="yes"/>
      <ItemListID>1286218</ItemListID>
      <StartDate>2018-10-16</StartDate>
      <StartTime>00:00:01</StartTime>
      <StopDate>2025-01-01</StopDate>
      <StopTime>23:59:59</StopTime>
      <WeekdayAvailability weekday="Sunday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Monday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Tuesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Wednesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Thursday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Friday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Saturday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <MixMatchEntry>
        <MixMatchUnits>2</MixMatchUnits>
        <MixMatchPrice>1.000</MixMatchPrice>
      </MixMatchEntry>
      <Priority/>
      <Extension>
        <ns2:TaxableRebate xmlns:ns2="urn:vfi-sapphire:np.naxmlext.2005-06-24">
          <ns2:Amount>0.00</ns2:Amount>
        </ns2:TaxableRebate>
      </Extension>
    </MMTDetail>
    <MMTDetail>
      <Promotion>
        <PromotionID>1618002</PromotionID>
      </Promotion>
      <MixMatchDescription>Newport Plat Blue .50c off 2PK</MixMatchDescription>
      <MixMatchStrictHighFlag value="yes"/>
      <MixMatchStrictLowFlag value="yes"/>
      <ItemListID>1618002</ItemListID>
      <StartDate>2019-03-13</StartDate>
      <StartTime>00:00:01</StartTime>
      <StopDate>2025-01-01</StopDate>
      <StopTime>23:59:59</StopTime>
      <WeekdayAvailability weekday="Sunday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Monday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Tuesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Wednesday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Thursday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Friday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <WeekdayAvailability weekday="Saturday" available="yes" startTime="00:00:00" stopTime="00:00:00"/>
      <MixMatchEntry>
      </MixMatchEntry>
      <Priority/>
      <Extension>
        <ns2:TaxableRebate xmlns:ns2="urn:vfi-sapphire:np.naxmlext.2005-06-24">
          <ns2:Amount>0.00</ns2:Amount>
        </ns2:TaxableRebate>
      </Extension>
    </MMTDetail>
  </MixMatchMaintenance>
</NAXML-MaintenanceRequest>

To download the XML example with MMT data, click here.