POST api/items/v2/lookup

Looks up items by description or code.

Request Information

URI Parameters

None.

Body Parameters

The parameters defining the requested items.

Name	Description	Type	Additional information
CompanyId	Represents the Id of the company to retrieve pricing for. Depending upon privileges this is either required or prohibited.	integer	Minimum value: 1
ItemCodeFilter	The item code to look for. Null returns all items.	string	Min length: 1 String length: inclusive between 0 and 30
ItemDescriptionFilter	The description of the item to look for. Null returns all items.	string	Min length: 1 String length: inclusive between 0 and 100
MatchPartial	Determines if partial code and description matches are returned.	boolean	Default value is false
StartingRowNumber	Determines which row number to start on.	integer	Default value is 0 Minimum value: 0
RowCount	How many rows to return in the response.	integer	Default value is 50 Minimum value: 1

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "ItemCodeFilter": "sample string 1",
  "ItemDescriptionFilter": "sample string 2",
  "MatchPartial": true,
  "StartingRowNumber": 4,
  "RowCount": 5
}

application/xml, text/xml

Sample:

<ItemLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyId>1</CompanyId>
  <ItemCodeFilter>sample string 1</ItemCodeFilter>
  <ItemDescriptionFilter>sample string 2</ItemDescriptionFilter>
  <MatchPartial>true</MatchPartial>
  <StartingRowNumber>4</StartingRowNumber>
  <RowCount>5</RowCount>
</ItemLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the look up.

ItemLookupResponse

Name	Description	Type	Additional information
CompanyName	The company for which the items were returned.	string	None.
Items	The details of the items.	Collection of Item	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "Items": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SqFtPriced": true
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SqFtPriced": true
    }
  ]
}

application/xml, text/xml

Sample:

<ItemLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CompanyName>sample string 1</CompanyName>
  <Items>
    <Item>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <SqFtPriced>true</SqFtPriced>
    </Item>
    <Item>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <SqFtPriced>true</SqFtPriced>
    </Item>
  </Items>
</ItemLookupResponse>