PriceList

Version: 1.33

The Pricelist entity represents a Gotransverse pricelist.

Parameters

Extends: TractObject

Elements
Element Type Required? Description

products

products
Attributes
Attribute Datatype Required? Description

name

string

Y

 

description

 string

 

 

Querying PriceList

For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.

Query Keys
Key Type

eid

Long

name

String

marketPlaceEid

Long
REST Endpoints

getOrganization

GET

https://my.tractbilling.com/t/s/r/1.33/priceLists

createPriceList

POST

https://my.tractbilling.com/t/s/r/1.33/priceLists

removePriceListFromPriceList

POST

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}/removeProduct

updateProductCategory

PUT

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}

getPriceList

GET

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}

deletePriceList

DELETE

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}

endProductSupportInPriceList

POST

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}/endProductSupport

addProductToPriceList

POST

https://my.tractbilling.com/t/s/r/1.33/priceLists/{eid: \d+}/addProduct

Sample Requests and Responses

SOAP

Query for Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:query>
         <!--Optional:-->
         <ser:queryRequest >
            <dom:simpleDataQuery>
               <dom:type>PriceList</dom:type>
	    <dom:parameter parameter=“nam”e parameterValue="test-5”/>
               <dom:parameter parameter="description" parameterValue="test1"/>
	    <dom:parameter parameter="marketPlaceEid" parameterValue="4"/>
            </dom:simpleDataQuery>
         </ser:queryRequest>
      </ser:query>
   </soapenv:Body>
</soapenv:Envelope

Add Product to Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:addProductToPriceList>
 <dom:priceList eid="14"/>
	<dom:product eid="319"/>                 
</dom:addProductToPriceList>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

Remove Product from Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:removeProductFromPriceList>
 <dom:priceList eid="14"/>
	<dom:product eid="319"/>                 
</dom:removeProductFromPriceList>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

Add PriceList to MarketPlace 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:addPriceListToMarketPlace>
 <dom:marketPlace eid="11"/>
	<dom:priceList eid="9"/>                 
</dom:addPriceListToMarketPlace>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

Remove Pricelist from Marketplace

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:removePriceListFromMarketPlace>
 <dom:marketPlace eid="11"/>
	<dom:priceList eid="7"/>                 
</dom:removePriceListFromMarketPlace>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

Add Product Price to Product within a Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:addProductPriceToProduct>
 <dom:priceList eid="15"/>
 <dom:product eid="318"/>

			<dom:recurringProductPrice recurringPaymentRequired="false" recurrenceAmount="10" recurrencePeriod="BILLCYCLE" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2015-01-25T00:00:00.000-05:00" priceOverride="true" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD">
<dom:priceCategory eid="6"/>                 
 <dom:priceRanges>
                     <dom:priceRange quantityBeginRange="0.00"  price="12" level="1" currencyType="USD" />
                  </dom:priceRanges>
                 </dom:recurringProductPrice>

</dom:addProductPriceToProduct>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

End Product Support in Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:endPriceListProductSupport endDate="2016-03-29">
 <dom:priceList eid="15"/>
	<dom:product eid="318"/>                 
</dom:endPriceListProductSupport>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope>

Create Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:create>
         <!--Optional:-->
         <ser:createRequest>
            <dom:priceList name="test-3" description="test1" >
            </dom:priceList>
         </ser:createRequest>
      </ser:create>
   </soapenv:Body>
</soapenv:Envelope>

Update Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:update>
         <!--Optional:-->
         <ser:updateRequest>
            <dom:priceList  eid="11" description="test-update">
            </dom:priceList>     
         </ser:updateRequest>
      </ser:update>
   </soapenv:Body>
</soapenv:Envelope>

Delete Pricelist

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
<soapenv:Header/>
<soapenv:Body>
   <ser:command>
      <ser:commandRequest>
<dom:deletePriceList>
 <dom:priceList eid="11"/>
</dom:deletePriceList>
        </ser:commandRequest>
      </ser:command>
   </soapenv:Body>
</soapenv:Envelope

REST

Query Examples

  • Add Pricelist to Marketplace

  • Create Pricelist

  • Update Pricelist

  • Delete Pricelist

  • Remove Product from Pricelist

  • End Support for Product in Pricelist

Query examples

  • GET http://localhost:8080/tract/s/r/1.32/priceLists?marketPlaceEid=4

  • GET http://localhost:8080/tract/s/r/1.32/priceLists?name=test-5

  • GET http://localhost:8080/tract/s/r/1.32/priceLists?description=test1

Add PriceList to MarketPlace

  • POST http://my.tractbilling.com/t/s/r/1.32/marketPlaces/11/addPriceList

<dom:addPriceListToMarketPlace xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
 <dom:marketPlace eid="11"/>
	<dom:priceList eid="7"/>                 
</dom:addPriceListToMarketPlace>

Create PriceList

  • POST http://my.tractbilling.com/t/s/r/1.32/priceLists

<dom:priceList name="test-4" description="test1" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
</dom:priceList>

Update Pricelist

  • PUT http://my.tractbilling.com/t/s/r/1.32/priceLists/11

<dom:priceList eid="11" description="test2-update" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
</dom:priceList>

Delete Pricelist

  • DELETE http://my.tractbilling.com/t/s/r/1.32/priceLists/13

<dom:deletePriceList xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
 <dom:priceList eid="13"/>
</dom:deletePriceList>

Add Product to Pricelist

  • POST http://my.tractbilling.com/t/s/r/1.32/priceLists/14/addProduct

<dom:addProductToPriceList xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
 <dom:priceList eid="14"/>
	<dom:product eid="319"/>                 
</dom:addProductToPriceList>

Remove Product from Pricelist

  • http://my.tractbilling.com/t/s/r/1.32/priceLists/14/removeProduct

<dom:removeProductFromPriceList xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
 <dom:priceList eid="14"/>
	<dom:product eid="319"/>                 
</dom:removeProductFromPriceList>

End Support for Product in Pricelist

  • POST http://my.tractbilling.com/t/s/r/1.32/priceLists/14/endProductSupport

<dom:endProductSupportInPriceList endDate="2016-02-29" xmlns:dom="http://www.tractbilling.com/billing/1_31/domain">
 <dom:priceList eid="14"/>
	<dom:product eid="318"/>                 
</dom:endProductSupportInPriceList>