AIM Web Services

<back to all web services

ShippingAddressLookupRequest

ShippingAddressLookup
Requires active-e Customer Service.

import java.math.*
import java.util.*
import java.io.InputStream
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")
    open 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")
    open var ShipId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

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

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

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

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

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

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

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

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

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

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

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

    @DataMember
    open var Name:String? = null

    @DataMember
    open var Attention:String? = null

    @DataMember
    open var Address1:String? = null

    @DataMember
    open var Address2:String? = null

    @DataMember
    open var City:String? = null

    @DataMember
    open var State:String? = null

    @DataMember
    open var Zip:String? = null

    @DataMember
    open var Country:String? = null

    @DataMember
    open var Email:String? = null

    @DataMember
    open var Phone:String? = null

    @DataMember
    open var Phone2:String? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Primary:Boolean? = null

    @DataMember
    open var TaxLoc:String? = null

    @DataMember
    open var Active:Boolean? = null
}

Kotlin ShippingAddressLookupRequest DTOs

GET /api/ShippingAddressLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}