POST api/Customer/Lookup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
AccountFieldValue	string	None.
FindSingleMatch	boolean	None.
CityName	string	None.
CountryID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "AccountFieldValue": "sample string 2",
  "FindSingleMatch": true,
  "CityName": "sample string 4",
  "CountryID": "sample string 5"
}

application/xml, text/xml

Sample:

<CustomerLookupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AccountFieldValue>sample string 2</AccountFieldValue>
  <CityName>sample string 4</CityName>
  <CountryID>sample string 5</CountryID>
  <FindSingleMatch>true</FindSingleMatch>
  <auth>sample string 1</auth>
</CustomerLookupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerLookupResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Customers	Collection of CustomerLookupItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Customers": [
    {
      "CompanyID": 1,
      "CustomerID": 2,
      "AccountNumber": "sample string 3",
      "CustomerName": "sample string 4",
      "OfficeCode": "sample string 5",
      "AccountStatus": "sample string 6",
      "HoldNote": "sample string 7",
      "AccountStatusIcon": "sample string 8",
      "AddressDisplay": "sample string 9"
    },
    {
      "CompanyID": 1,
      "CustomerID": 2,
      "AccountNumber": "sample string 3",
      "CustomerName": "sample string 4",
      "OfficeCode": "sample string 5",
      "AccountStatus": "sample string 6",
      "HoldNote": "sample string 7",
      "AccountStatusIcon": "sample string 8",
      "AddressDisplay": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<CustomerLookupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Customers>
    <CustomerLookupItem>
      <AccountNumber>sample string 3</AccountNumber>
      <AccountStatus>sample string 6</AccountStatus>
      <AccountStatusIcon>sample string 8</AccountStatusIcon>
      <AddressDisplay>sample string 9</AddressDisplay>
      <CompanyID>1</CompanyID>
      <CustomerID>2</CustomerID>
      <CustomerName>sample string 4</CustomerName>
      <HoldNote>sample string 7</HoldNote>
      <OfficeCode>sample string 5</OfficeCode>
    </CustomerLookupItem>
    <CustomerLookupItem>
      <AccountNumber>sample string 3</AccountNumber>
      <AccountStatus>sample string 6</AccountStatus>
      <AccountStatusIcon>sample string 8</AccountStatusIcon>
      <AddressDisplay>sample string 9</AddressDisplay>
      <CompanyID>1</CompanyID>
      <CustomerID>2</CustomerID>
      <CustomerName>sample string 4</CustomerName>
      <HoldNote>sample string 7</HoldNote>
      <OfficeCode>sample string 5</OfficeCode>
    </CustomerLookupItem>
  </Customers>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CustomerLookupResp>