POST api/AccountLookup

Use this function to search for accounts based on criteria supplied in your request. Any combination of non-blank fields within the AccountLookupRequest structure will query for matching records. A maximum of 20 records will be returned as results from this lookup, and if the request produces more than 20 records, no records will be returned and you will be prompted to refine your search parameters to bring that count down to 20 or fewer.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AccountLookupResults

Name	Description	Type	Additional information
_RequestSubmitted	The HttpRequestMessage submitted with your API call will also be returned in this field. It must be submitted in either XML or JSON format in accordance with the [PickupRequest] schema (drill-down for details):	AccountLookupRequest	None.
ErrorInfo	This field will be empty (blank) if the Lookup API was processed successfully; a non-blank entry will document the nature of the error(s) encountered during processing.	string	None.
AccountList	This structure will contain a list of up to 20 Accounts records. Drill-down for more details.	Collection of AccountRecord	None.

Response Formats

application/json, text/json

Sample:

{
  "_RequestSubmitted": {
    "Logon": "sample string 1",
    "Pass": "sample string 2",
    "Name": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Phone": "sample string 9"
  },
  "ErrorInfo": "sample string 1",
  "AccountList": [
    {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zip": "sample string 7",
      "Phone": "sample string 8",
      "ContactList": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        }
      ]
    },
    {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "Zip": "sample string 7",
      "Phone": "sample string 8",
      "ContactList": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AccountLookupResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <AccountList>
    <AccountRecord>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <City>sample string 5</City>
      <Code>sample string 1</Code>
      <ContactList>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
      </ContactList>
      <Name>sample string 2</Name>
      <Phone>sample string 8</Phone>
      <State>sample string 6</State>
      <Zip>sample string 7</Zip>
    </AccountRecord>
    <AccountRecord>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <City>sample string 5</City>
      <Code>sample string 1</Code>
      <ContactList>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
      </ContactList>
      <Name>sample string 2</Name>
      <Phone>sample string 8</Phone>
      <State>sample string 6</State>
      <Zip>sample string 7</Zip>
    </AccountRecord>
  </AccountList>
  <ErrorInfo>sample string 1</ErrorInfo>
  <_RequestSubmitted>
    <Address1>sample string 4</Address1>
    <Address2>sample string 5</Address2>
    <City>sample string 6</City>
    <Logon>sample string 1</Logon>
    <Name>sample string 3</Name>
    <Pass>sample string 2</Pass>
    <Phone>sample string 9</Phone>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
  </_RequestSubmitted>
</AccountLookupResults>