API/Products/GetProductDetails

From Emersion
Revision as of 14:15, 8 June 2016 by JLee (talk) (new page created for GetProductDetails API function)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Purpose

Retrieve all available products all the object properties that need to be entered (along with whether they are mandatory or not). Hardware / products are stored within Emersion; data will be cached via CTA and retrieved daily.


Inputs

  <soapenv:Body>
     <prod:GetProductDetailsRequest>
        <prod:Active>true</prod:Active>
        <prod:ProductID></prod:ProductID>
     </prod:GetProductDetailsRequest>
  </soapenv:Body>


Output

  <SOAP-ENV:Body>
     <ns1:GetProductDetailsResponse>
           <ns1:Product>
           <ns1:ID>1957964</ns1:ID>
           <ns1:Name>iPhone 5s Any Shock Case - Bendigo Bank Connect branded</ns1:Name>
           <ns1:Description>iPhone 5s Any Shock Case - Bendigo Bank Connect branded</ns1:Description>
           <ns1:CategoryID>16</ns1:CategoryID>
           <ns1:Category>Mobile Phone</ns1:Category>
           <ns1:Type>Physical Product</ns1:Type>
           <ns1:SKU>iphone5sshock</ns1:SKU>
           <ns1:Pricing>
              <ns1:BookID>100066</ns1:BookID>
              <ns1:BookName>Default Pricing Book</ns1:BookName>
              <ns1:BookStartDate xsi:nil="true"/>
              <ns1:BookEndDate xsi:nil="true"/>
              <ns1:Prices>
                 <ns1:Price>
                    <ns1:QuantityBreakStart>1</ns1:QuantityBreakStart>
                    <ns1:StartDate>2015-07-03 00:00:00</ns1:StartDate>
                    <ns1:EndDate xsi:nil="true"/>
                    <ns1:SellPrice>17.5</ns1:SellPrice>
                    <ns1:SellTaxID>2</ns1:SellTaxID>
                    <ns1:SellTaxName>Australian GST</ns1:SellTaxName>
                    <ns1:CostPrice>17.5</ns1:CostPrice>
                    <ns1:CostTaxID>2</ns1:CostTaxID>
                    <ns1:CostTaxName>Australian GST</ns1:CostTaxName>
                 </ns1:Price>
              </ns1:Prices>
           </ns1:Pricing>
        </ns1:Product>
     </ns1:GetProductDetailsResponse>
  </SOAP-ENV:Body>


Error String

  • "Invalid Product ID" - Product ID length less than 6 digits
  • "Undefined Product" - Product is not owned by Emersion, nor by service provider, or service type category does not exist and not own by parent account.