Read Product Vendor Pricebook

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/ProductsVendorPricebook will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/ProductsVendorPricebook

Query Params
filter:	string In this parameter ProductCode or VendorName 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 To fetch ProductsVendorPricebook with product code equal to TNP , the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/ProductsVendorPricebook?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 ProductsVendorPricebook with product code equal to TNP and page equal to 10, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/ProductsVendorPricebook?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 ProductsVendorPricebook 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/ProductsVendorPricebook?filter=ProductCode,eq,TNP&pageSize=10&key=xyzkey

Query Params

filter:

string
In this parameter ProductCode or VendorName
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

To fetch ProductsVendorPricebook with product code equal to TNP , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsVendorPricebook?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 ProductsVendorPricebook with product code equal to TNP and page equal to 10, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/ProductsVendorPricebook?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 ProductsVendorPricebook 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/ProductsVendorPricebook?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

{
	"ProductVendorPricebooks": {
		"ProductVendorPricebook": [{
				"ProductCode": "TP28feb",
				"VendorId": "152627",
				"Vendor": "Test New vendor 27aug1",
				"VendorNumber": "TESTNO9",
				"VendorPrice": "45.00",
				"PreferredOrderQty": "46",
				"OrderUnits": "each",
				"InventoryQty": "32",
				"Preferred": "No",
				"CreatedTime": "01-24-2020 05:01:35",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:05:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			},
			{
				"ProductCode": "TP28feb",
				"VendorId": "152628",
				"Vendor": "Test New vendor 27aug4",
				"VendorNumber": "TESTNO19",
				"VendorPrice": "46.00",
				"PreferredOrderQty": "47",
				"OrderUnits": "each",
				"InventoryQty": "33",
				"Preferred": "Yes",
				"CreatedTime": "01-24-2020 05:01:35",
				"CreatedTimeUTC": "01-24-2020 15:01:35",
				"ModifiedTime": "01-24-2020 05:05:56",
				"ModifiedTimeUTC": "01-24-2020 15:05:56"
			}
		]
	},
	"TotalRecords": "2",
	"CurrentPage": "1",
	"TotalPages": "1",
	"PageSize": "50"
}

<ProductVendorPricebooks>
  <ProductVendorPricebook>
    <ProductCode>TP28feb</ProductCode>
    <VendorId>152627</VendorId>
    <Vendor>Test New vendor 27aug1</Vendor>
    <VendorNumber>55</VendorNumber>
    <VendorPrice>10</VendorPrice>
    <PreferredOrderQty>9</PreferredOrderQty>
    <OrderUnits>each</OrderUnits>
    <InventoryQty>2</InventoryQty>
    <Preferred>Yes</Preferred>
    <CreatedTime>01-24-2020 05:01:35</CreatedTime>
    <CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
    <ModifiedTime>01-24-2020 05:05:56</ModifiedTime>
    <ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
  </ProductVendorPricebook>
  <ProductVendorPricebook>
    <ProductCode>TP28feb</ProductCode>
    <VendorId>152628</VendorId>
    <Vendor>Test New vendor 27aug5</Vendor>
    <VendorNumber>56</VendorNumber>
    <VendorPrice>10</VendorPrice>
    <PreferredOrderQty>10</PreferredOrderQty>
    <OrderUnits>each</OrderUnits>
    <InventoryQty>3</InventoryQty>
    <Preferred>No</Preferred>
    <CreatedTime>01-24-2020 05:01:35</CreatedTime>
    <CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
    <ModifiedTime>01-24-2020 05:05:56</ModifiedTime>
    <ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
  </ProductVendorPricebook>
  <TotalRecords>2</TotalRecords>
  <CurrentPage>1</CurrentPage>
  <TotalPages>1</TotalPages>
  <PageSize>50</PageSize>
</ProductVendorPricebooks>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="ProductsVendorPricebook">
       <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>