AIM Web Services

<back to all web services

AddShippingAddressRequest

AddShippingAddress
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/AddShippingAddress
AddShippingAddressRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerAccountbodyint?No
CopyAddressFromAccountbodyint?No
AddressNamebodystringNo
AddressInfobodyAddressInfoNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
AddressInfo Parameters:
NameParameterData TypeRequiredDescription
AttentionformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CountryformstringNo
EmailformstringNo
HomePhoneformstringNo
WorkPhoneformstringNo
NotesformstringNo
AddShippingAddressResponse Parameters:
NameParameterData TypeRequiredDescription
AddressIdformlongNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

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.

POST /api/AddShippingAddress HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddShippingAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <AddressInfo>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Attention>String</Attention>
    <City>String</City>
    <Country>String</Country>
    <Email>String</Email>
    <HomePhone>String</HomePhone>
    <Notes>String</Notes>
    <State>String</State>
    <WorkPhone>String</WorkPhone>
    <Zip>String</Zip>
  </AddressInfo>
  <AddressName>String</AddressName>
  <CopyAddressFromAccount>0</CopyAddressFromAccount>
  <CustomerAccount>0</CustomerAccount>
</AddShippingAddressRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddShippingAddressResponse 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>
  <AddressId>0</AddressId>
</AddShippingAddressResponse>