GET Product/GetProductByLocationID?ProductLocation={ProductLocation}&ProductName={ProductName}&manufacturerId={manufacturerId}

Returns a list of products.

Request Information

URI Parameters

Name	Description	Type	Additional Information
ProductLocation	Product location of the product to search for.	string	Required
ProductName	Product name of the product to search for. (optional)	string	Default value is string.Empty
manufacturerId	The manufacturer of the product to search for. (optional)	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of products.

AgvProduct

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many Product JSON dictionaries.	string
Products	JSON dictionary of Product.	Collection of ClsApiProduct

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "Products": [
    {
      "DeptID": "sample string 1",
      "ProdID": "sample string 2",
      "ProductName": "sample string 3",
      "BillingDivisor": "sample string 4",
      "InvUnits": "sample string 5",
      "BillUnits": "sample string 6",
      "CropCode": "sample string 7",
      "AmountOnHand": 8.1,
      "AlternateProdID": "sample string 9",
      "ProductGUID": "sample string 10",
      "DepartmentScale": 11,
      "IsAnalysis": true,
      "ManufacturerId": "sample string 13",
      "ContainerRequiredOnPOS": true,
      "PackageUnit": "sample string 15",
      "PackageSize": "sample string 16",
      "Gtin": "sample string 17"
    },
    {
      "DeptID": "sample string 1",
      "ProdID": "sample string 2",
      "ProductName": "sample string 3",
      "BillingDivisor": "sample string 4",
      "InvUnits": "sample string 5",
      "BillUnits": "sample string 6",
      "CropCode": "sample string 7",
      "AmountOnHand": 8.1,
      "AlternateProdID": "sample string 9",
      "ProductGUID": "sample string 10",
      "DepartmentScale": 11,
      "IsAnalysis": true,
      "ManufacturerId": "sample string 13",
      "ContainerRequiredOnPOS": true,
      "PackageUnit": "sample string 15",
      "PackageSize": "sample string 16",
      "Gtin": "sample string 17"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Product">
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.API">
    <d2p1:ClsApiProduct>
      <d2p1:AlternateProdID>sample string 9</d2p1:AlternateProdID>
      <d2p1:AmountOnHand>8.1</d2p1:AmountOnHand>
      <d2p1:BillUnits>sample string 6</d2p1:BillUnits>
      <d2p1:BillingDivisor>sample string 4</d2p1:BillingDivisor>
      <d2p1:ContainerRequiredOnPOS>true</d2p1:ContainerRequiredOnPOS>
      <d2p1:CropCode>sample string 7</d2p1:CropCode>
      <d2p1:DepartmentScale>11</d2p1:DepartmentScale>
      <d2p1:DeptID>sample string 1</d2p1:DeptID>
      <d2p1:Gtin>sample string 17</d2p1:Gtin>
      <d2p1:InvUnits>sample string 5</d2p1:InvUnits>
      <d2p1:IsAnalysis>true</d2p1:IsAnalysis>
      <d2p1:ManufacturerId>sample string 13</d2p1:ManufacturerId>
      <d2p1:PackageSize>sample string 16</d2p1:PackageSize>
      <d2p1:PackageUnit>sample string 15</d2p1:PackageUnit>
      <d2p1:ProdID>sample string 2</d2p1:ProdID>
      <d2p1:ProductGUID>sample string 10</d2p1:ProductGUID>
      <d2p1:ProductName>sample string 3</d2p1:ProductName>
    </d2p1:ClsApiProduct>
    <d2p1:ClsApiProduct>
      <d2p1:AlternateProdID>sample string 9</d2p1:AlternateProdID>
      <d2p1:AmountOnHand>8.1</d2p1:AmountOnHand>
      <d2p1:BillUnits>sample string 6</d2p1:BillUnits>
      <d2p1:BillingDivisor>sample string 4</d2p1:BillingDivisor>
      <d2p1:ContainerRequiredOnPOS>true</d2p1:ContainerRequiredOnPOS>
      <d2p1:CropCode>sample string 7</d2p1:CropCode>
      <d2p1:DepartmentScale>11</d2p1:DepartmentScale>
      <d2p1:DeptID>sample string 1</d2p1:DeptID>
      <d2p1:Gtin>sample string 17</d2p1:Gtin>
      <d2p1:InvUnits>sample string 5</d2p1:InvUnits>
      <d2p1:IsAnalysis>true</d2p1:IsAnalysis>
      <d2p1:ManufacturerId>sample string 13</d2p1:ManufacturerId>
      <d2p1:PackageSize>sample string 16</d2p1:PackageSize>
      <d2p1:PackageUnit>sample string 15</d2p1:PackageUnit>
      <d2p1:ProdID>sample string 2</d2p1:ProdID>
      <d2p1:ProductGUID>sample string 10</d2p1:ProductGUID>
      <d2p1:ProductName>sample string 3</d2p1:ProductName>
    </d2p1:ClsApiProduct>
  </Products>
  <Status>sample string 1</Status>
</AgvProduct>