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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class AddShippingAddressResponse extends BaseResponse {
    /** @param {{AddressId?:number,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    AddressId;
}
export class AddressInfo {
    /** @param {{Attention?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,Email?:string,HomePhone?:string,WorkPhone?:string,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Attention;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Country;
    /** @type {string} */
    Email;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    Notes;
}
export class AddShippingAddressRequest extends BaseSecureRequest {
    /** @param {{CustomerAccount?:number,CopyAddressFromAccount?:number,AddressName?:string,AddressInfo?:AddressInfo,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    CustomerAccount;
    /** @type {?number} */
    CopyAddressFromAccount;
    /** @type {string} */
    AddressName;
    /** @type {AddressInfo} */
    AddressInfo;
}

JavaScript AddShippingAddressRequest DTOs

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>