AIM Web Services

<back to all web services

ShippingAddressLookupRequest

ShippingAddressLookup
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/ShippingAddressLookup
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* ShippingAddressLookupRequires active-e Customer Service.
*/
@DataContract
open class ShippingAddressLookupRequest : BaseSecureRequest()
{
    /**
    * 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.
    */
    @DataMember
    @ApiMember(Description="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.", Name="Acct", ParameterType="query")
    var Acct:Int? = null

    /**
    * Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.
    */
    @DataMember
    @ApiMember(Description="Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.", Name="ShipId", ParameterType="query")
    var ShipId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class ShippingAddressLookupResponse : BaseResponse()
{
    @DataMember
    var ShipTos:ArrayList<ShipToInfo> = ArrayList<ShipToInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ShipToInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Attention:String? = null

    @DataMember
    var Address1:String? = null

    @DataMember
    var Address2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Country:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var Phone:String? = null

    @DataMember
    var Phone2:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Primary:Boolean? = null

    @DataMember
    var TaxLoc:String? = null

    @DataMember
    var Active:Boolean? = null
}

Kotlin ShippingAddressLookupRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"ShipTos":[{"Id":0,"Name":"String","Attention":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","Email":"String","Phone":"String","Phone2":"String","Notes":"String","Primary":false,"TaxLoc":"String","Active":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}