POST api/pricelist/getPriceList
Request Information
URI Parameters
None.
Body Parameters
PriceListCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| username | string |
None. |
|
| LOCNCODE | string |
None. |
|
| CUSTNMBR | string |
None. |
|
| SearchString | string |
None. |
|
| Vendors | Collection of string |
None. |
|
| ItemClasses | Collection of string |
None. |
|
| ItemTypes | Collection of string |
None. |
|
| Stock | boolean |
None. |
|
| NonStock | boolean |
None. |
|
| LastUpdateString | string |
None. |
|
| LastUpdate | date |
None. |
|
| PagingStart | integer |
None. |
|
| NumRecs | integer |
None. |
|
| Pests | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{
"username": "sample string 1",
"LOCNCODE": "sample string 2",
"CUSTNMBR": "sample string 3",
"SearchString": "sample string 4",
"Vendors": [
"sample string 1",
"sample string 2"
],
"ItemClasses": [
"sample string 1",
"sample string 2"
],
"ItemTypes": [
"sample string 1",
"sample string 2"
],
"Stock": true,
"NonStock": true,
"LastUpdateString": "sample string 7",
"LastUpdate": "2026-11-21T14:52:55.9207371+00:00",
"PagingStart": 1,
"NumRecs": 1,
"Pests": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<PriceListCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<CUSTNMBR>sample string 3</CUSTNMBR>
<ItemClasses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ItemClasses>
<ItemTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ItemTypes>
<LOCNCODE>sample string 2</LOCNCODE>
<LastUpdate>2026-11-21T14:52:55.9207371+00:00</LastUpdate>
<LastUpdateString>sample string 7</LastUpdateString>
<NonStock>true</NonStock>
<NumRecs>1</NumRecs>
<PagingStart>1</PagingStart>
<Pests xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Pests>
<SearchString>sample string 4</SearchString>
<Stock>true</Stock>
<Vendors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Vendors>
<username>sample string 1</username>
</PriceListCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of PriceList| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemNmbr | string |
None. |
|
| ItemDesc | string |
None. |
|
| SELNGUOM | string |
None. |
|
| MetalsURL | string |
None. |
|
| SDSURL | string |
None. |
|
| LabelURL | string |
None. |
|
| DeliveryTimeDesc | string |
None. |
|
| RegionCost | decimal number |
None. |
|
| RegionPrice | decimal number |
None. |
|
| MarginPerc | decimal number |
None. |
|
| ListPrice | decimal number |
None. |
|
| LOCNCODE | string |
None. |
|
| LastPrice | decimal number |
None. |
|
| PackageInfo | string |
None. |
|
| Class | string |
None. |
|
| Category | string |
None. |
|
| VendorId | string |
None. |
|
| Agency | boolean |
None. |
|
| PriceGroupName | string |
None. |
|
| Stock | boolean |
None. |
|
| NonStock | boolean |
None. |
|
| RegStates | string |
None. |
|
| LastUpdate | date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ItemNmbr": "sample string 1",
"ItemDesc": "sample string 2",
"SELNGUOM": "sample string 3",
"MetalsURL": "sample string 4",
"SDSURL": "sample string 5",
"LabelURL": "sample string 6",
"DeliveryTimeDesc": "sample string 7",
"RegionCost": 8.1,
"RegionPrice": 9.1,
"MarginPerc": 10.99,
"ListPrice": 11.1,
"LOCNCODE": "sample string 12",
"LastPrice": 13.1,
"PackageInfo": "sample string 14",
"Class": "sample string 15",
"Category": "sample string 16",
"VendorId": "sample string 17",
"Agency": true,
"PriceGroupName": "sample string 19",
"Stock": true,
"NonStock": true,
"RegStates": "sample string 22",
"LastUpdate": "2026-11-21T14:52:55.9207371+00:00"
},
{
"ItemNmbr": "sample string 1",
"ItemDesc": "sample string 2",
"SELNGUOM": "sample string 3",
"MetalsURL": "sample string 4",
"SDSURL": "sample string 5",
"LabelURL": "sample string 6",
"DeliveryTimeDesc": "sample string 7",
"RegionCost": 8.1,
"RegionPrice": 9.1,
"MarginPerc": 10.99,
"ListPrice": 11.1,
"LOCNCODE": "sample string 12",
"LastPrice": 13.1,
"PackageInfo": "sample string 14",
"Class": "sample string 15",
"Category": "sample string 16",
"VendorId": "sample string 17",
"Agency": true,
"PriceGroupName": "sample string 19",
"Stock": true,
"NonStock": true,
"RegStates": "sample string 22",
"LastUpdate": "2026-11-21T14:52:55.9207371+00:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfPriceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<PriceList>
<Agency>true</Agency>
<Category>sample string 16</Category>
<Class>sample string 15</Class>
<DeliveryTimeDesc>sample string 7</DeliveryTimeDesc>
<ItemDesc>sample string 2</ItemDesc>
<ItemNmbr>sample string 1</ItemNmbr>
<LOCNCODE>sample string 12</LOCNCODE>
<LabelURL>sample string 6</LabelURL>
<LastPrice>13.1</LastPrice>
<LastUpdate>2026-11-21T14:52:55.9207371+00:00</LastUpdate>
<ListPrice>11.1</ListPrice>
<MarginPerc>10.99</MarginPerc>
<MetalsURL>sample string 4</MetalsURL>
<NonStock>true</NonStock>
<PackageInfo>sample string 14</PackageInfo>
<PriceGroupName>sample string 19</PriceGroupName>
<RegStates>sample string 22</RegStates>
<RegionCost>8.1</RegionCost>
<RegionPrice>9.1</RegionPrice>
<SDSURL>sample string 5</SDSURL>
<SELNGUOM>sample string 3</SELNGUOM>
<Stock>true</Stock>
<VendorId>sample string 17</VendorId>
</PriceList>
<PriceList>
<Agency>true</Agency>
<Category>sample string 16</Category>
<Class>sample string 15</Class>
<DeliveryTimeDesc>sample string 7</DeliveryTimeDesc>
<ItemDesc>sample string 2</ItemDesc>
<ItemNmbr>sample string 1</ItemNmbr>
<LOCNCODE>sample string 12</LOCNCODE>
<LabelURL>sample string 6</LabelURL>
<LastPrice>13.1</LastPrice>
<LastUpdate>2026-11-21T14:52:55.9207371+00:00</LastUpdate>
<ListPrice>11.1</ListPrice>
<MarginPerc>10.99</MarginPerc>
<MetalsURL>sample string 4</MetalsURL>
<NonStock>true</NonStock>
<PackageInfo>sample string 14</PackageInfo>
<PriceGroupName>sample string 19</PriceGroupName>
<RegStates>sample string 22</RegStates>
<RegionCost>8.1</RegionCost>
<RegionPrice>9.1</RegionPrice>
<SDSURL>sample string 5</SDSURL>
<SELNGUOM>sample string 3</SELNGUOM>
<Stock>true</Stock>
<VendorId>sample string 17</VendorId>
</PriceList>
</ArrayOfPriceList>