AIM Web Services

ShippingAddressLookupRequest

ShippingAddressLookup
Requires active-e Customer Service.

The following routes are available for this service:
GET	/api/ShippingAddressLookup

**ShippingAddressLookupRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Acct	query	int?	No	Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter.
ShipId	query	long?	No	Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**ShippingAddressLookupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ShipTos	form	List<ShipToInfo>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**ShipToInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
Attention	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Country	form	string	No
Email	form	string	No
Phone	form	string	No
Phone2	form	string	No
Notes	form	string	No
Primary	form	bool	No
TaxLoc	form	string	No
Active	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ShippingAddressLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ShippingAddressLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ShipTos>
    <ShipToInfo>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <Attention>String</Attention>
      <City>String</City>
      <Country>String</Country>
      <Email>String</Email>
      <Id>0</Id>
      <Name>String</Name>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Phone2>String</Phone2>
      <Primary>false</Primary>
      <State>String</State>
      <TaxLoc>String</TaxLoc>
      <Zip>String</Zip>
    </ShipToInfo>
  </ShipTos>
</ShippingAddressLookupResponse>

AIM Web Services

ShippingAddressLookupRequest

ShippingAddressLookup Requires active-e Customer Service.

HTTP + XML

ShippingAddressLookup
Requires active-e Customer Service.