Go to full article

Overview

This API allows a provider to add a price point against a product in a pricing book.

Creating a Price Point

 To create a price point:

1. Create a "CreatePricePoint" request
2. Provide the following mandatory inputs
   1. Product ID
   2. Sell Price Exclusive of Tax
3. The below inputs are optional and can be provided as per defined business rules
   1. Sell Price Tax Type (otherwise, the tax type of the product will be used)
   2. Pricing Book ID (otherwise, the price point will be added to your default price book)
   3. Minimum Quantity (otherwise, zero will be stamped as default minimum quantity)
   4. Saleable From (otherwise, current date will be stored as Saleable From)
   5. Cost Price Ex Tax
   6. Cost Price Tax Type
   7. Maximum Quantity
   8. Saleable To
   9. Notify Upon Paid Purchase

Business Rules

• Mandatory fields (Product ID, Sell Price Ex Tax) must be present
• Data types must be verified for inputs whose data type is supposed to be other than String (e.g. integer, float, boolean, date, etc.)
• Product ID must be valid (should exist in Emersion database)
• Product must be owned by the caller account
• Pricing book ID (if provided) must be valid  (should exist in Emersion database)
• Pricing book ID (if provided) must be owned by the caller account
• If cost price ex tax is not provided do not allow to pass cost price tax type
• "Saleable To" date cannot be prior to "Saleable From" date if both are provided
• "Saleable From" should not go prior to an existing "Saleable From" against the same product in the same pricing book
• If both minimum and maximum quantities are provided, then minimum quantity should not exceed maximum quantity.
• If product does not support fractional quantities, minimum and maximum quantities should not accept decimal values,

Return Value: In case of success, new ID of the newly created price point will be returned to the caller

SOAP Example

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:CreatePricePointRequest>
         <urn:ProductID>1704263</urn:ProductID>
         <urn:SellPriceExTax>15</urn:SellPriceExTax>
         <!--Optional:-->
         <urn:SellPriceTaxType>Australian GST</urn:SellPriceTaxType>
         <!--Optional:-->
         <urn:PricingBookID>100219</urn:PricingBookID>
         <!--Optional:-->
         <urn:CostPriceExTax>10</urn:CostPriceExTax>
         <!--Optional:-->
         <urn:CostPriceTaxType>Australian GST</urn:CostPriceTaxType>
         <!--Optional:-->
         <urn:MinimumQuantity>1</urn:MinimumQuantity>
         <!--Optional:-->
         <urn:MaximumQuantity>50</urn:MaximumQuantity>
         <!--Optional:-->
         <urn:SaleableFrom>2019-03-01</urn:SaleableFrom>
         <!--Optional:-->
         <urn:SaleableTo>2019-03-31</urn:SaleableTo>
         <!--Optional:-->
         <urn:NotifyUponPurchase>true</urn:NotifyUponPurchase>
      </urn:CreatePricePointRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:CreatePricePointResponse>
         <ns1:PricePointID>17972712</ns1:PricePointID>
      </ns1:CreatePricePointResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>