AIM Web Services

<back to all web services

CustomerOrdersRequest

CustomerOrders
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

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


/**
* CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
@DataContract
open class CustomerOrdersRequest : BaseSecureRequest()
{
    @DataMember
    var Orders:ArrayList<ThirdPartyOrder> = ArrayList<ThirdPartyOrder>()
}

@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 ThirdPartyOrder
{
    @DataMember
    var OrderNumber:String? = null

    @DataMember
    var OrderDate:Date? = null

    @DataMember
    var TransactionState:String? = null

    @DataMember
    var PaymentMethod:String? = null

    @DataMember
    var OrderNotes:String? = null

    @DataMember
    var AuthorizationCode:String? = null

    @DataMember
    var ShippingMethod:String? = null

    @DataMember
    var Total:BigDecimal? = null

    @DataMember
    var SubTotal:BigDecimal? = null

    @DataMember
    var TaxTotal:BigDecimal? = null

    @DataMember
    var ShippingTotal:BigDecimal? = null

    @DataMember
    var CardType:String? = null

    @DataMember
    var CardToken:String? = null

    @DataMember
    var CardSpan:String? = null

    @DataMember
    var CardExpirationMonth:String? = null

    @DataMember
    var CardExpirationYear:String? = null

    @DataMember
    var CustomerAcct:Int? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var PO:String? = null

    @DataMember
    var EmployeeUsername:String? = null

    @DataMember
    var AeOnApprovalOrderSubtotal:BigDecimal? = null

    @DataMember
    var AeOnApprovalOrderShipping:BigDecimal? = null

    @DataMember
    var ShippingAttn:String? = null

    @DataMember
    var ShippingName:String? = null

    @DataMember
    var ShippingFirstName:String? = null

    @DataMember
    var ShippingLastName:String? = null

    @DataMember
    var ShippingCompany:String? = null

    @DataMember
    var ShippingAddr1:String? = null

    @DataMember
    var ShippingAddr2:String? = null

    @DataMember
    var ShippingCity:String? = null

    @DataMember
    var ShippingSt:String? = null

    @DataMember
    var ShippingZip:String? = null

    @DataMember
    var ShippingCountry:String? = null

    @DataMember
    var ShippingPhone:String? = null

    @DataMember
    var BillingAttn:String? = null

    @DataMember
    var BillingName:String? = null

    @DataMember
    var BillingFirstName:String? = null

    @DataMember
    var BillingLastName:String? = null

    @DataMember
    var BillingCompany:String? = null

    @DataMember
    var BillingAddr1:String? = null

    @DataMember
    var BillingAddr2:String? = null

    @DataMember
    var BillingCity:String? = null

    @DataMember
    var BillingSt:String? = null

    @DataMember
    var BillingZip:String? = null

    @DataMember
    var BillingCountry:String? = null

    @DataMember
    var BillingPhone:String? = null

    @DataMember
    var OrderSource:String? = null

    @DataMember
    var CardName:String? = null

    @DataMember
    var PnRef:String? = null

    @DataMember
    var LineItems:ArrayList<ThirdPartyOrderItem> = ArrayList<ThirdPartyOrderItem>()
}

@DataContract
open class ThirdPartyOrderItem
{
    @DataMember
    var ProductName:String? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var SerialNumber:String? = null

    @DataMember
    var WebNumber:String? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var Qty:BigDecimal? = null

    @DataMember
    var QtyPicked:BigDecimal? = null

    @DataMember
    var UseQtyPicked:Boolean? = null

    @DataMember
    var Price:BigDecimal? = null

    @DataMember
    var OnApproval:Boolean? = null

    @DataMember
    var IsECard:Boolean? = null

    @DataMember
    var NiCat:Int? = null

    @DataMember
    var NiSub:Int? = null

    @DataMember
    var ExtPk:Long? = null
}

@DataContract
open class CustomerOrdersResponse : BaseResponse()
{
}

@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
}

Kotlin CustomerOrdersRequest 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.

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

{"Orders":[{"OrderNumber":"String","TransactionState":"String","PaymentMethod":"String","OrderNotes":"String","AuthorizationCode":"String","ShippingMethod":"String","Total":0,"SubTotal":0,"TaxTotal":0,"ShippingTotal":0,"CardType":"String","CardToken":"String","CardSpan":"String","CardExpirationMonth":"String","CardExpirationYear":"String","CustomerAcct":0,"Email":"String","PO":"String","EmployeeUsername":"String","AeOnApprovalOrderSubtotal":0,"AeOnApprovalOrderShipping":0,"ShippingAttn":"String","ShippingName":"String","ShippingFirstName":"String","ShippingLastName":"String","ShippingCompany":"String","ShippingAddr1":"String","ShippingAddr2":"String","ShippingCity":"String","ShippingSt":"String","ShippingZip":"String","ShippingCountry":"String","ShippingPhone":"String","BillingAttn":"String","BillingName":"String","BillingFirstName":"String","BillingLastName":"String","BillingCompany":"String","BillingAddr1":"String","BillingAddr2":"String","BillingCity":"String","BillingSt":"String","BillingZip":"String","BillingCountry":"String","BillingPhone":"String","OrderSource":"String","CardName":"String","PnRef":"String","LineItems":[{"ProductName":"String","Sku":"String","SerialNumber":"String","WebNumber":"String","Location":"String","Qty":0,"QtyPicked":0,"UseQtyPicked":false,"Price":0,"OnApproval":false,"IsECard":false,"NiCat":0,"NiSub":0,"ExtPk":0}]}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}