POST api/v3/customers/lookup

Retrieves a filtered list of basic information for customers.

Request Information

URI Parameters

None.

Body Parameters

The parameters defining the requested items.

Name	Description	Type	Additional information
FilterText	The text to match to either location name or code.	string	None.
MatchPartial	Allow partial match	boolean	Default value is false
StartingRowNumber	Starting row number	integer	Default value is 0
RowCount	Maximum number of rows to return.	integer	Default value is 50
BusinessUnitId	Business Unit id to filter results by.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FilterText": "sample string 1",
  "MatchPartial": true,
  "StartingRowNumber": 3,
  "RowCount": 4,
  "BusinessUnitId": 1
}

application/xml, text/xml

Sample:

<CustomerLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FilterText>sample string 1</FilterText>
  <MatchPartial>true</MatchPartial>
  <StartingRowNumber>3</StartingRowNumber>
  <RowCount>4</RowCount>
  <BusinessUnitId>1</BusinessUnitId>
</CustomerLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of basic customer information.

CustomerLookupResponse

Name	Description	Type	Additional information
Results	Information for the results of the current look up request	Collection of CustomerSummaryInformation	None.
RecordCount	Total count of records that match the criteria in the look up request.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Results": [
    {
      "BusinessUnitId": 1,
      "BusinessUnitName": "sample string 2",
      "CustomerCode": "sample string 3",
      "CustomerName": "sample string 4",
      "City": "sample string 5",
      "Region": "sample string 6",
      "PostalCode": "sample string 7",
      "CustomerId": 8
    },
    {
      "BusinessUnitId": 1,
      "BusinessUnitName": "sample string 2",
      "CustomerCode": "sample string 3",
      "CustomerName": "sample string 4",
      "City": "sample string 5",
      "Region": "sample string 6",
      "PostalCode": "sample string 7",
      "CustomerId": 8
    }
  ],
  "RecordCount": 1
}

application/xml, text/xml

Sample:

<CustomerLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Results>
    <CustomerSummaryInformation>
      <BusinessUnitId>1</BusinessUnitId>
      <BusinessUnitName>sample string 2</BusinessUnitName>
      <CustomerCode>sample string 3</CustomerCode>
      <CustomerName>sample string 4</CustomerName>
      <City>sample string 5</City>
      <Region>sample string 6</Region>
      <PostalCode>sample string 7</PostalCode>
      <CustomerId>8</CustomerId>
    </CustomerSummaryInformation>
    <CustomerSummaryInformation>
      <BusinessUnitId>1</BusinessUnitId>
      <BusinessUnitName>sample string 2</BusinessUnitName>
      <CustomerCode>sample string 3</CustomerCode>
      <CustomerName>sample string 4</CustomerName>
      <City>sample string 5</City>
      <Region>sample string 6</Region>
      <PostalCode>sample string 7</PostalCode>
      <CustomerId>8</CustomerId>
    </CustomerSummaryInformation>
  </Results>
  <RecordCount>1</RecordCount>
</CustomerLookupResponse>