POST api/Address/Lookup

Request Information

URI Parameters

None.

Body Parameters

AddressLookupParm
NameDescriptionTypeAdditional information
auth

string

None.
CompanyName

string

None.
CityName

string

None.
StateProvID

string

None.
CountryID

string

None.
AirportID

string

None.
AccountNumber

string

None.
AddressGroupID

integer

None.
IsSourceCommon

boolean

None.
IsSourceOrder

boolean

None.
SinceDateTime

date

None.
PickupOrDelivery

string

None.
PostalCode

string

None.
AddressCode

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "auth": "sample string 1",
  "CompanyName": "sample string 2",
  "CityName": "sample string 3",
  "StateProvID": "sample string 4",
  "CountryID": "sample string 5",
  "AirportID": "sample string 6",
  "AccountNumber": "sample string 7",
  "AddressGroupID": 1,
  "IsSourceCommon": true,
  "IsSourceOrder": true,
  "SinceDateTime": "2025-04-03T13:33:21.2686923+00:00",
  "PickupOrDelivery": "sample string 10",
  "PostalCode": "sample string 11",
  "AddressCode": "sample string 12"
}

application/xml, text/xml

Sample: 
<AddressLookupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AccountNumber>sample string 7</AccountNumber>
  <AddressCode>sample string 12</AddressCode>
  <AddressGroupID>1</AddressGroupID>
  <AirportID>sample string 6</AirportID>
  <CityName>sample string 3</CityName>
  <CompanyName>sample string 2</CompanyName>
  <CountryID>sample string 5</CountryID>
  <IsSourceCommon>true</IsSourceCommon>
  <IsSourceOrder>true</IsSourceOrder>
  <PickupOrDelivery>sample string 10</PickupOrDelivery>
  <PostalCode>sample string 11</PostalCode>
  <SinceDateTime>2025-04-03T13:33:21.2686923+00:00</SinceDateTime>
  <StateProvID>sample string 4</StateProvID>
  <auth>sample string 1</auth>
</AddressLookupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddressLookupResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ErrorMessage

string

None.
Addresses

Collection of AddressLookupItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Addresses": [
    {
      "AddressID": 1,
      "CompanyID": 1,
      "AddressType": "sample string 2",
      "AddressCode": "sample string 3",
      "AddressGroupID": 4,
      "CompanyName": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "Address3": "sample string 8",
      "CityName": "sample string 9",
      "StateProvID": "sample string 10",
      "PostalCode": "sample string 11",
      "CountryID": "sample string 12",
      "CountryName": "sample string 13",
      "TimezoneID": "sample string 14",
      "ContactName": "sample string 15",
      "PhoneNumber": "sample string 16",
      "MobileNumber": "sample string 17",
      "AfterHoursNumber": "sample string 18",
      "FaxNumber": "sample string 19",
      "EmailAddress": "sample string 20",
      "Note": "sample string 21",
      "PickupInstructions": "sample string 22",
      "DeliveryInstructions": "sample string 23",
      "DefaultAirportID": "sample string 24",
      "DistanceToAirport": 1,
      "DistanceUOM": "sample string 25",
      "AlwaysInList": true,
      "InsertUserID": 27,
      "InsertUserName": "sample string 28",
      "InsertDateTime": "2025-04-03T13:33:21.2843178+00:00",
      "DeletedUserID": 1,
      "DeletedDateTime": "2025-04-03T13:33:21.2843178+00:00",
      "KsmsAddressID": 1,
      "KSMS_Status": "sample string 30",
      "KSMS_LastTransactionDate": "2025-04-03T13:33:21.2843178+00:00",
      "KSMS_E3NotificationFlag": true,
      "KSMS_TSAShipperID": "sample string 32",
      "KSMS_IACShipperID": "sample string 33",
      "KSMS_ReasonForStatus": "sample string 34",
      "KSMS_Icon": "sample string 35",
      "TSAKnownShipperStatus": "sample string 36",
      "ConsigneeCustomerID": 1,
      "ConsigneeAccountNumber": "sample string 37",
      "ConsigneeAccountName": "sample string 38",
      "ConsigneeOrderInstructions": "sample string 39",
      "CreatedByDisplay": "sample string 40",
      "OfficeID": 1,
      "CustomsBrokerGUID": "sample string 41",
      "CustomsBrokerName": "sample string 42",
      "ConsigneeBillTo": true,
      "DropOff": true,
      "HoldForPickup": true,
      "ShipperEIN": "sample string 46",
      "AirportID2": "sample string 47",
      "AirportID3": "sample string 48",
      "DistanceToAirport2": 1,
      "DistanceToAirport3": 1,
      "Bonded": true,
      "HasDoc": true,
      "MawbIdentifier": "sample string 51",
      "AeoNumber": "sample string 52"
    },
    {
      "AddressID": 1,
      "CompanyID": 1,
      "AddressType": "sample string 2",
      "AddressCode": "sample string 3",
      "AddressGroupID": 4,
      "CompanyName": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "Address3": "sample string 8",
      "CityName": "sample string 9",
      "StateProvID": "sample string 10",
      "PostalCode": "sample string 11",
      "CountryID": "sample string 12",
      "CountryName": "sample string 13",
      "TimezoneID": "sample string 14",
      "ContactName": "sample string 15",
      "PhoneNumber": "sample string 16",
      "MobileNumber": "sample string 17",
      "AfterHoursNumber": "sample string 18",
      "FaxNumber": "sample string 19",
      "EmailAddress": "sample string 20",
      "Note": "sample string 21",
      "PickupInstructions": "sample string 22",
      "DeliveryInstructions": "sample string 23",
      "DefaultAirportID": "sample string 24",
      "DistanceToAirport": 1,
      "DistanceUOM": "sample string 25",
      "AlwaysInList": true,
      "InsertUserID": 27,
      "InsertUserName": "sample string 28",
      "InsertDateTime": "2025-04-03T13:33:21.2843178+00:00",
      "DeletedUserID": 1,
      "DeletedDateTime": "2025-04-03T13:33:21.2843178+00:00",
      "KsmsAddressID": 1,
      "KSMS_Status": "sample string 30",
      "KSMS_LastTransactionDate": "2025-04-03T13:33:21.2843178+00:00",
      "KSMS_E3NotificationFlag": true,
      "KSMS_TSAShipperID": "sample string 32",
      "KSMS_IACShipperID": "sample string 33",
      "KSMS_ReasonForStatus": "sample string 34",
      "KSMS_Icon": "sample string 35",
      "TSAKnownShipperStatus": "sample string 36",
      "ConsigneeCustomerID": 1,
      "ConsigneeAccountNumber": "sample string 37",
      "ConsigneeAccountName": "sample string 38",
      "ConsigneeOrderInstructions": "sample string 39",
      "CreatedByDisplay": "sample string 40",
      "OfficeID": 1,
      "CustomsBrokerGUID": "sample string 41",
      "CustomsBrokerName": "sample string 42",
      "ConsigneeBillTo": true,
      "DropOff": true,
      "HoldForPickup": true,
      "ShipperEIN": "sample string 46",
      "AirportID2": "sample string 47",
      "AirportID3": "sample string 48",
      "DistanceToAirport2": 1,
      "DistanceToAirport3": 1,
      "Bonded": true,
      "HasDoc": true,
      "MawbIdentifier": "sample string 51",
      "AeoNumber": "sample string 52"
    }
  ]
}

application/xml, text/xml

Sample: 
<AddressLookupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Addresses>
    <AddressLookupItem>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <Address3>sample string 8</Address3>
      <AddressCode>sample string 3</AddressCode>
      <AddressGroupID>4</AddressGroupID>
      <AddressID>1</AddressID>
      <AddressType>sample string 2</AddressType>
      <AeoNumber>sample string 52</AeoNumber>
      <AfterHoursNumber>sample string 18</AfterHoursNumber>
      <AirportID2>sample string 47</AirportID2>
      <AirportID3>sample string 48</AirportID3>
      <AlwaysInList>true</AlwaysInList>
      <Bonded>true</Bonded>
      <CityName>sample string 9</CityName>
      <CompanyID>1</CompanyID>
      <CompanyName>sample string 5</CompanyName>
      <ConsigneeAccountName>sample string 38</ConsigneeAccountName>
      <ConsigneeAccountNumber>sample string 37</ConsigneeAccountNumber>
      <ConsigneeBillTo>true</ConsigneeBillTo>
      <ConsigneeCustomerID>1</ConsigneeCustomerID>
      <ConsigneeOrderInstructions>sample string 39</ConsigneeOrderInstructions>
      <ContactName>sample string 15</ContactName>
      <CountryID>sample string 12</CountryID>
      <CountryName>sample string 13</CountryName>
      <CreatedByDisplay>sample string 40</CreatedByDisplay>
      <CustomsBrokerGUID>sample string 41</CustomsBrokerGUID>
      <CustomsBrokerName>sample string 42</CustomsBrokerName>
      <DefaultAirportID>sample string 24</DefaultAirportID>
      <DeletedDateTime>2025-04-03T13:33:21.2843178+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <DeliveryInstructions>sample string 23</DeliveryInstructions>
      <DistanceToAirport>1</DistanceToAirport>
      <DistanceToAirport2>1</DistanceToAirport2>
      <DistanceToAirport3>1</DistanceToAirport3>
      <DistanceUOM>sample string 25</DistanceUOM>
      <DropOff>true</DropOff>
      <EmailAddress>sample string 20</EmailAddress>
      <FaxNumber>sample string 19</FaxNumber>
      <HasDoc>true</HasDoc>
      <HoldForPickup>true</HoldForPickup>
      <InsertDateTime>2025-04-03T13:33:21.2843178+00:00</InsertDateTime>
      <InsertUserID>27</InsertUserID>
      <InsertUserName>sample string 28</InsertUserName>
      <KSMS_E3NotificationFlag>true</KSMS_E3NotificationFlag>
      <KSMS_IACShipperID>sample string 33</KSMS_IACShipperID>
      <KSMS_Icon>sample string 35</KSMS_Icon>
      <KSMS_LastTransactionDate>2025-04-03T13:33:21.2843178+00:00</KSMS_LastTransactionDate>
      <KSMS_ReasonForStatus>sample string 34</KSMS_ReasonForStatus>
      <KSMS_Status>sample string 30</KSMS_Status>
      <KSMS_TSAShipperID>sample string 32</KSMS_TSAShipperID>
      <KsmsAddressID>1</KsmsAddressID>
      <MawbIdentifier>sample string 51</MawbIdentifier>
      <MobileNumber>sample string 17</MobileNumber>
      <Note>sample string 21</Note>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 16</PhoneNumber>
      <PickupInstructions>sample string 22</PickupInstructions>
      <PostalCode>sample string 11</PostalCode>
      <ShipperEIN>sample string 46</ShipperEIN>
      <StateProvID>sample string 10</StateProvID>
      <TSAKnownShipperStatus>sample string 36</TSAKnownShipperStatus>
      <TimezoneID>sample string 14</TimezoneID>
    </AddressLookupItem>
    <AddressLookupItem>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <Address3>sample string 8</Address3>
      <AddressCode>sample string 3</AddressCode>
      <AddressGroupID>4</AddressGroupID>
      <AddressID>1</AddressID>
      <AddressType>sample string 2</AddressType>
      <AeoNumber>sample string 52</AeoNumber>
      <AfterHoursNumber>sample string 18</AfterHoursNumber>
      <AirportID2>sample string 47</AirportID2>
      <AirportID3>sample string 48</AirportID3>
      <AlwaysInList>true</AlwaysInList>
      <Bonded>true</Bonded>
      <CityName>sample string 9</CityName>
      <CompanyID>1</CompanyID>
      <CompanyName>sample string 5</CompanyName>
      <ConsigneeAccountName>sample string 38</ConsigneeAccountName>
      <ConsigneeAccountNumber>sample string 37</ConsigneeAccountNumber>
      <ConsigneeBillTo>true</ConsigneeBillTo>
      <ConsigneeCustomerID>1</ConsigneeCustomerID>
      <ConsigneeOrderInstructions>sample string 39</ConsigneeOrderInstructions>
      <ContactName>sample string 15</ContactName>
      <CountryID>sample string 12</CountryID>
      <CountryName>sample string 13</CountryName>
      <CreatedByDisplay>sample string 40</CreatedByDisplay>
      <CustomsBrokerGUID>sample string 41</CustomsBrokerGUID>
      <CustomsBrokerName>sample string 42</CustomsBrokerName>
      <DefaultAirportID>sample string 24</DefaultAirportID>
      <DeletedDateTime>2025-04-03T13:33:21.2843178+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <DeliveryInstructions>sample string 23</DeliveryInstructions>
      <DistanceToAirport>1</DistanceToAirport>
      <DistanceToAirport2>1</DistanceToAirport2>
      <DistanceToAirport3>1</DistanceToAirport3>
      <DistanceUOM>sample string 25</DistanceUOM>
      <DropOff>true</DropOff>
      <EmailAddress>sample string 20</EmailAddress>
      <FaxNumber>sample string 19</FaxNumber>
      <HasDoc>true</HasDoc>
      <HoldForPickup>true</HoldForPickup>
      <InsertDateTime>2025-04-03T13:33:21.2843178+00:00</InsertDateTime>
      <InsertUserID>27</InsertUserID>
      <InsertUserName>sample string 28</InsertUserName>
      <KSMS_E3NotificationFlag>true</KSMS_E3NotificationFlag>
      <KSMS_IACShipperID>sample string 33</KSMS_IACShipperID>
      <KSMS_Icon>sample string 35</KSMS_Icon>
      <KSMS_LastTransactionDate>2025-04-03T13:33:21.2843178+00:00</KSMS_LastTransactionDate>
      <KSMS_ReasonForStatus>sample string 34</KSMS_ReasonForStatus>
      <KSMS_Status>sample string 30</KSMS_Status>
      <KSMS_TSAShipperID>sample string 32</KSMS_TSAShipperID>
      <KsmsAddressID>1</KsmsAddressID>
      <MawbIdentifier>sample string 51</MawbIdentifier>
      <MobileNumber>sample string 17</MobileNumber>
      <Note>sample string 21</Note>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 16</PhoneNumber>
      <PickupInstructions>sample string 22</PickupInstructions>
      <PostalCode>sample string 11</PostalCode>
      <ShipperEIN>sample string 46</ShipperEIN>
      <StateProvID>sample string 10</StateProvID>
      <TSAKnownShipperStatus>sample string 36</TSAKnownShipperStatus>
      <TimezoneID>sample string 14</TimezoneID>
    </AddressLookupItem>
  </Addresses>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</AddressLookupResp>