API ReferenceGuides
Guides
Home

Read Product PriceBook

Retrieves the Pricebook details of Product object that has been previously created.

Suggest Edits

Parameters

Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/ProductsPriceBook will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ProductsPriceBook
Query Params
filter:string
In this parameter ProductCode or Pricebook name needs to be provided with condition and value
to fetch related details,if no filter passed all available data will be returned.for eg. ProductCode,eq,TNP

1) To fetch ProductsPriceBook with product code equal to TNP , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsPriceBook?filter=ProductCode,eq,TNP&key=xyzkey
page:int
Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch ProductsPriceBook with product code equal to TNP and page equal to 10 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsPriceBook?filter=ProductCode,eq,TNP&page=10&key=xyzkey
pageSize:int
In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch ProductsPriceBook with product code equal to TNP and page size equal to 10 , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsPriceBook?filter=ProductCode,eq,TNP&pageSize=10&key=xyzkey
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code 

{
	"ProductPricebooks": {
		"ProductPricebook": [{
				"ProductCode": "ProductCode1",
				"PriceBook": "Retail PriceBook",
				"Price": "20.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			},
			{
				"ProductCode": "ProductCode1",
				"PriceBook": "Specials PriceBook",
				"Price": "30.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			},
			{
				"ProductCode": "ProductCode1",
				"PriceBook": "Volume PriceBook",
				"Price": "1:20.00;11:30.00;15:60.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			}
		]
	},
	"TotalRecords": "4",
	"CurrentPage": "1",
	"TotalPages": "1",
	"PageSize": "50"
}

<ProductPricebooks>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Retail PriceBook</PriceBook>
      <Price>20.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
   </ProductPricebook>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Specials PriceBook</PriceBook>
      <Price>30.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
   </ProductPricebook>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Volume PriceBook</PriceBook>
      <Price>1:20.00;11:30.00;15:60.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
   </ProductPricebook>
   <TotalRecords>3</TotalRecords>
   <CurrentPage>1</CurrentPage>
   <TotalPages>1</TotalPages>
   <PageSize>50</PageSize>
</ProductPricebooks>

{
	"ProductPricebooks": {
		"ProductPricebook": [{
				"ProductCode": "ProductCode1",
				"PriceBook": "Retail PriceBook",
				"Price": "20.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56",
				"PricebookMatrixItems": {
					"PricebookMatrixItem": [{
							"PricebookMatrixSKUCode": "563245",
							"PricebookMatrixPrice": "20.00"
						},
						{
							"PricebookMatrixSKUCode": "563246",
							"PricebookMatrixPrice": "20.00"
						}
					]
				}
			},
			{
				"ProductCode": "ProductCode1",
				"PriceBook": "Specials PriceBook",
				"Price": "30.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56",
				"PricebookMatrixItems": {
					"PricebookMatrixItem": [{
							"PricebookMatrixSKUCode": "563245",
							"PricebookMatrixPrice": "30.00"
						},
						{
							"PricebookMatrixSKUCode": "563246",
							"PricebookMatrixPrice": "30.00"
						}
					]
				}
			},
			{
				"ProductCode": "ProductCode1",
				"PriceBook": "Volume PriceBook",
				"Price": "1:20.00;11:30.00;15:60.00",
				"CreatedTime": "01-24-2020 05:19:56",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:19:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56",
				"PricebookMatrixItems": {
					"PricebookMatrixItem": [{
							"PricebookMatrixSKUCode": "563245",
							"PricebookMatrixPrice": "1:20.00;11:30.00;15:60.00"
						},
						{
							"PricebookMatrixSKUCode": "563246",
							"PricebookMatrixPrice": "1:20.00;11:30.00;15:60.00"
						}
					]
				}
			}
		]
	},
	"TotalRecords": "3",
	"CurrentPage": "1",
	"TotalPages": "1",
	"PageSize": "50"
}

<ProductPricebooks>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Retail PriceBook</PriceBook>
      <Price>20.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
      <PricebookMatrixItems>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>20.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>20.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
      </PricebookMatrixItems>
   </ProductPricebook>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Specials PriceBook</PriceBook>
      <Price>30.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
      <PricebookMatrixItems>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>30.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>30.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
      </PricebookMatrixItems>
   </ProductPricebook>
   <ProductPricebook>
      <ProductCode>ProductCode1</ProductCode>
      <PriceBook>Volume PriceBook</PriceBook>
      <Price>1:20.00;11:30.00;15:60.00</Price>
      <CreatedTime>01-24-2020 05:19:56</CreatedTime>
     	<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
     	<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
      <PricebookMatrixItems>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563245</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>1:20.00;11:30.00;15:60.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
         <PricebookMatrixItem>
            <PricebookMatrixSKUCode>563246</PricebookMatrixSKUCode>
            <PricebookMatrixPrice>1:20.00;11:30.00;15:60.00</PricebookMatrixPrice>
         </PricebookMatrixItem>
      </PricebookMatrixItems>
   </ProductPricebook>
   <TotalRecords>3</TotalRecords>
   <CurrentPage>1</CurrentPage>
   <TotalPages>1</TotalPages>
   <PageSize>50</PageSize>
</ProductPricebooks>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="ProductsPriceBook">
       <method name="GET">
	   <resource path="{ProductCode}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Updated over 1 year ago

© Copyright 2022 Agiliron - All Rights Reserved.