Difference between revisions of "API/Products/GetProductDetails"

Latest revision as of 14:51, 9 June 2016

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:ProductStatus>Active</prod:ProductStatus>
         <!--Optional:-->
         <prod:ProductID></prod:ProductID>
      </prod:GetProductDetailsRequest>
   </soapenv:Body>

Output

<SOAP-ENV:Body>
	<ns1:GetProductDetailsResponse>
		<ns1:Product>
			<ns1:ID>1957963</ns1:ID>
			<ns1:Name>Apple iPhone 6 16GB - Grey</ns1:Name>
			<ns1:Description>Apple iPhone 6 16GB - Grey</ns1:Description>
			<ns1:CategoryID>16</ns1:CategoryID>
			<ns1:Category>Mobile Phone</ns1:Category>
			<ns1:Type>Physical Product</ns1:Type>
			<ns1:Manufacturer>Apple</ns1:Manufacturer>
			<ns1:Colour>Gray</ns1:Colour>
			<ns1:Supplier>Apple</ns1:Supplier>
			<ns1:SKU>MG472X/A</ns1:SKU>
			<ns1:Barcode>
				<ns1:Type>UPC-E</ns1:Type>
				<ns1:Shortname>UPC-E</ns1:Shortname>
				<ns1:Value>888462062350</ns1:Value>
			</ns1:Barcode>
			<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</ns1:StartDate>
						<ns1:EndDate>2015-09-18</ns1:EndDate>
						<ns1:SellPrice>853.69</ns1:SellPrice>
						<ns1:SellTaxID>2</ns1:SellTaxID>
						<ns1:SellTaxName>Australian GST</ns1:SellTaxName>
						<ns1:CostPrice>853.69</ns1:CostPrice>
						<ns1:CostTaxID>2</ns1:CostTaxID>
						<ns1:CostTaxName>Australian GST</ns1:CostTaxName>
					</ns1:Price>
					<ns1:Price>
						<ns1:QuantityBreakStart>1</ns1:QuantityBreakStart>
						<ns1:StartDate>2015-07-03</ns1:StartDate>
						<ns1:EndDate>2015-09-18</ns1:EndDate>
						<ns1:SellPrice>853.69</ns1:SellPrice>
						<ns1:SellTaxID>2</ns1:SellTaxID>
						<ns1:SellTaxName>Australian GST</ns1:SellTaxName>
						<ns1:CostPrice>853.69</ns1:CostPrice>
						<ns1:CostTaxID>2</ns1:CostTaxID>
						<ns1:CostTaxName>Australian GST</ns1:CostTaxName>
					</ns1:Price>
					<ns1:Price>
						<ns1:QuantityBreakStart>1</ns1:QuantityBreakStart>
						<ns1:StartDate>2015-09-18</ns1:StartDate>
						<ns1:EndDate xsi:nil="true"/>
						<ns1:SellPrice>981.8181818</ns1:SellPrice>
						<ns1:SellTaxID>2</ns1:SellTaxID>
						<ns1:SellTaxName>Australian GST</ns1:SellTaxName>
						<ns1:CostPrice>0</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.