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.*;

public class dtos
{

    /**
    * CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    */
    @DataContract
    public static class CustomerOrdersRequest extends BaseSecureRequest
    {
        @DataMember
        public ArrayList<ThirdPartyOrder> Orders = null;
        
        public ArrayList<ThirdPartyOrder> getOrders() { return Orders; }
        public CustomerOrdersRequest setOrders(ArrayList<ThirdPartyOrder> value) { this.Orders = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class ThirdPartyOrder
    {
        @DataMember
        public String OrderNumber = null;

        @DataMember
        public Date OrderDate = null;

        @DataMember
        public String TransactionState = null;

        @DataMember
        public String PaymentMethod = null;

        @DataMember
        public String OrderNotes = null;

        @DataMember
        public String AuthorizationCode = null;

        @DataMember
        public String ShippingMethod = null;

        @DataMember
        public BigDecimal Total = null;

        @DataMember
        public BigDecimal SubTotal = null;

        @DataMember
        public BigDecimal TaxTotal = null;

        @DataMember
        public BigDecimal ShippingTotal = null;

        @DataMember
        public String CardType = null;

        @DataMember
        public String CardToken = null;

        @DataMember
        public String CardSpan = null;

        @DataMember
        public String CardExpirationMonth = null;

        @DataMember
        public String CardExpirationYear = null;

        @DataMember
        public Integer CustomerAcct = null;

        @DataMember
        public String Email = null;

        @DataMember
        public String PO = null;

        @DataMember
        public String EmployeeUsername = null;

        @DataMember
        public BigDecimal AeOnApprovalOrderSubtotal = null;

        @DataMember
        public BigDecimal AeOnApprovalOrderShipping = null;

        @DataMember
        public String ShippingAttn = null;

        @DataMember
        public String ShippingName = null;

        @DataMember
        public String ShippingFirstName = null;

        @DataMember
        public String ShippingLastName = null;

        @DataMember
        public String ShippingCompany = null;

        @DataMember
        public String ShippingAddr1 = null;

        @DataMember
        public String ShippingAddr2 = null;

        @DataMember
        public String ShippingCity = null;

        @DataMember
        public String ShippingSt = null;

        @DataMember
        public String ShippingZip = null;

        @DataMember
        public String ShippingCountry = null;

        @DataMember
        public String ShippingPhone = null;

        @DataMember
        public String BillingAttn = null;

        @DataMember
        public String BillingName = null;

        @DataMember
        public String BillingFirstName = null;

        @DataMember
        public String BillingLastName = null;

        @DataMember
        public String BillingCompany = null;

        @DataMember
        public String BillingAddr1 = null;

        @DataMember
        public String BillingAddr2 = null;

        @DataMember
        public String BillingCity = null;

        @DataMember
        public String BillingSt = null;

        @DataMember
        public String BillingZip = null;

        @DataMember
        public String BillingCountry = null;

        @DataMember
        public String BillingPhone = null;

        @DataMember
        public String OrderSource = null;

        @DataMember
        public String CardName = null;

        @DataMember
        public String PnRef = null;

        @DataMember
        public ArrayList<ThirdPartyOrderItem> LineItems = null;
        
        public String getOrderNumber() { return OrderNumber; }
        public ThirdPartyOrder setOrderNumber(String value) { this.OrderNumber = value; return this; }
        public Date getOrderDate() { return OrderDate; }
        public ThirdPartyOrder setOrderDate(Date value) { this.OrderDate = value; return this; }
        public String getTransactionState() { return TransactionState; }
        public ThirdPartyOrder setTransactionState(String value) { this.TransactionState = value; return this; }
        public String getPaymentMethod() { return PaymentMethod; }
        public ThirdPartyOrder setPaymentMethod(String value) { this.PaymentMethod = value; return this; }
        public String getOrderNotes() { return OrderNotes; }
        public ThirdPartyOrder setOrderNotes(String value) { this.OrderNotes = value; return this; }
        public String getAuthorizationCode() { return AuthorizationCode; }
        public ThirdPartyOrder setAuthorizationCode(String value) { this.AuthorizationCode = value; return this; }
        public String getShippingMethod() { return ShippingMethod; }
        public ThirdPartyOrder setShippingMethod(String value) { this.ShippingMethod = value; return this; }
        public BigDecimal getTotal() { return Total; }
        public ThirdPartyOrder setTotal(BigDecimal value) { this.Total = value; return this; }
        public BigDecimal getSubTotal() { return SubTotal; }
        public ThirdPartyOrder setSubTotal(BigDecimal value) { this.SubTotal = value; return this; }
        public BigDecimal getTaxTotal() { return TaxTotal; }
        public ThirdPartyOrder setTaxTotal(BigDecimal value) { this.TaxTotal = value; return this; }
        public BigDecimal getShippingTotal() { return ShippingTotal; }
        public ThirdPartyOrder setShippingTotal(BigDecimal value) { this.ShippingTotal = value; return this; }
        public String getCardType() { return CardType; }
        public ThirdPartyOrder setCardType(String value) { this.CardType = value; return this; }
        public String getCardToken() { return CardToken; }
        public ThirdPartyOrder setCardToken(String value) { this.CardToken = value; return this; }
        public String getCardSpan() { return CardSpan; }
        public ThirdPartyOrder setCardSpan(String value) { this.CardSpan = value; return this; }
        public String getCardExpirationMonth() { return CardExpirationMonth; }
        public ThirdPartyOrder setCardExpirationMonth(String value) { this.CardExpirationMonth = value; return this; }
        public String getCardExpirationYear() { return CardExpirationYear; }
        public ThirdPartyOrder setCardExpirationYear(String value) { this.CardExpirationYear = value; return this; }
        public Integer getCustomerAcct() { return CustomerAcct; }
        public ThirdPartyOrder setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public String getEmail() { return Email; }
        public ThirdPartyOrder setEmail(String value) { this.Email = value; return this; }
        public String getPo() { return PO; }
        public ThirdPartyOrder setPo(String value) { this.PO = value; return this; }
        public String getEmployeeUsername() { return EmployeeUsername; }
        public ThirdPartyOrder setEmployeeUsername(String value) { this.EmployeeUsername = value; return this; }
        public BigDecimal getAeOnApprovalOrderSubtotal() { return AeOnApprovalOrderSubtotal; }
        public ThirdPartyOrder setAeOnApprovalOrderSubtotal(BigDecimal value) { this.AeOnApprovalOrderSubtotal = value; return this; }
        public BigDecimal getAeOnApprovalOrderShipping() { return AeOnApprovalOrderShipping; }
        public ThirdPartyOrder setAeOnApprovalOrderShipping(BigDecimal value) { this.AeOnApprovalOrderShipping = value; return this; }
        public String getShippingAttn() { return ShippingAttn; }
        public ThirdPartyOrder setShippingAttn(String value) { this.ShippingAttn = value; return this; }
        public String getShippingName() { return ShippingName; }
        public ThirdPartyOrder setShippingName(String value) { this.ShippingName = value; return this; }
        public String getShippingFirstName() { return ShippingFirstName; }
        public ThirdPartyOrder setShippingFirstName(String value) { this.ShippingFirstName = value; return this; }
        public String getShippingLastName() { return ShippingLastName; }
        public ThirdPartyOrder setShippingLastName(String value) { this.ShippingLastName = value; return this; }
        public String getShippingCompany() { return ShippingCompany; }
        public ThirdPartyOrder setShippingCompany(String value) { this.ShippingCompany = value; return this; }
        public String getShippingAddr1() { return ShippingAddr1; }
        public ThirdPartyOrder setShippingAddr1(String value) { this.ShippingAddr1 = value; return this; }
        public String getShippingAddr2() { return ShippingAddr2; }
        public ThirdPartyOrder setShippingAddr2(String value) { this.ShippingAddr2 = value; return this; }
        public String getShippingCity() { return ShippingCity; }
        public ThirdPartyOrder setShippingCity(String value) { this.ShippingCity = value; return this; }
        public String getShippingSt() { return ShippingSt; }
        public ThirdPartyOrder setShippingSt(String value) { this.ShippingSt = value; return this; }
        public String getShippingZip() { return ShippingZip; }
        public ThirdPartyOrder setShippingZip(String value) { this.ShippingZip = value; return this; }
        public String getShippingCountry() { return ShippingCountry; }
        public ThirdPartyOrder setShippingCountry(String value) { this.ShippingCountry = value; return this; }
        public String getShippingPhone() { return ShippingPhone; }
        public ThirdPartyOrder setShippingPhone(String value) { this.ShippingPhone = value; return this; }
        public String getBillingAttn() { return BillingAttn; }
        public ThirdPartyOrder setBillingAttn(String value) { this.BillingAttn = value; return this; }
        public String getBillingName() { return BillingName; }
        public ThirdPartyOrder setBillingName(String value) { this.BillingName = value; return this; }
        public String getBillingFirstName() { return BillingFirstName; }
        public ThirdPartyOrder setBillingFirstName(String value) { this.BillingFirstName = value; return this; }
        public String getBillingLastName() { return BillingLastName; }
        public ThirdPartyOrder setBillingLastName(String value) { this.BillingLastName = value; return this; }
        public String getBillingCompany() { return BillingCompany; }
        public ThirdPartyOrder setBillingCompany(String value) { this.BillingCompany = value; return this; }
        public String getBillingAddr1() { return BillingAddr1; }
        public ThirdPartyOrder setBillingAddr1(String value) { this.BillingAddr1 = value; return this; }
        public String getBillingAddr2() { return BillingAddr2; }
        public ThirdPartyOrder setBillingAddr2(String value) { this.BillingAddr2 = value; return this; }
        public String getBillingCity() { return BillingCity; }
        public ThirdPartyOrder setBillingCity(String value) { this.BillingCity = value; return this; }
        public String getBillingSt() { return BillingSt; }
        public ThirdPartyOrder setBillingSt(String value) { this.BillingSt = value; return this; }
        public String getBillingZip() { return BillingZip; }
        public ThirdPartyOrder setBillingZip(String value) { this.BillingZip = value; return this; }
        public String getBillingCountry() { return BillingCountry; }
        public ThirdPartyOrder setBillingCountry(String value) { this.BillingCountry = value; return this; }
        public String getBillingPhone() { return BillingPhone; }
        public ThirdPartyOrder setBillingPhone(String value) { this.BillingPhone = value; return this; }
        public String getOrderSource() { return OrderSource; }
        public ThirdPartyOrder setOrderSource(String value) { this.OrderSource = value; return this; }
        public String getCardName() { return CardName; }
        public ThirdPartyOrder setCardName(String value) { this.CardName = value; return this; }
        public String getPnRef() { return PnRef; }
        public ThirdPartyOrder setPnRef(String value) { this.PnRef = value; return this; }
        public ArrayList<ThirdPartyOrderItem> getLineItems() { return LineItems; }
        public ThirdPartyOrder setLineItems(ArrayList<ThirdPartyOrderItem> value) { this.LineItems = value; return this; }
    }

    @DataContract
    public static class ThirdPartyOrderItem
    {
        @DataMember
        public String ProductName = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String SerialNumber = null;

        @DataMember
        public String WebNumber = null;

        @DataMember
        public String Location = null;

        @DataMember
        public BigDecimal Qty = null;

        @DataMember
        public BigDecimal QtyPicked = null;

        @DataMember
        public Boolean UseQtyPicked = null;

        @DataMember
        public BigDecimal Price = null;

        @DataMember
        public Boolean OnApproval = null;

        @DataMember
        public Boolean IsECard = null;

        @DataMember
        public Integer NiCat = null;

        @DataMember
        public Integer NiSub = null;

        @DataMember
        public Long ExtPk = null;
        
        public String getProductName() { return ProductName; }
        public ThirdPartyOrderItem setProductName(String value) { this.ProductName = value; return this; }
        public String getSku() { return Sku; }
        public ThirdPartyOrderItem setSku(String value) { this.Sku = value; return this; }
        public String getSerialNumber() { return SerialNumber; }
        public ThirdPartyOrderItem setSerialNumber(String value) { this.SerialNumber = value; return this; }
        public String getWebNumber() { return WebNumber; }
        public ThirdPartyOrderItem setWebNumber(String value) { this.WebNumber = value; return this; }
        public String getLocation() { return Location; }
        public ThirdPartyOrderItem setLocation(String value) { this.Location = value; return this; }
        public BigDecimal getQty() { return Qty; }
        public ThirdPartyOrderItem setQty(BigDecimal value) { this.Qty = value; return this; }
        public BigDecimal getQtyPicked() { return QtyPicked; }
        public ThirdPartyOrderItem setQtyPicked(BigDecimal value) { this.QtyPicked = value; return this; }
        public Boolean isUseQtyPicked() { return UseQtyPicked; }
        public ThirdPartyOrderItem setUseQtyPicked(Boolean value) { this.UseQtyPicked = value; return this; }
        public BigDecimal getPrice() { return Price; }
        public ThirdPartyOrderItem setPrice(BigDecimal value) { this.Price = value; return this; }
        public Boolean isOnApproval() { return OnApproval; }
        public ThirdPartyOrderItem setOnApproval(Boolean value) { this.OnApproval = value; return this; }
        public Boolean getIsECard() { return IsECard; }
        public ThirdPartyOrderItem setIsECard(Boolean value) { this.IsECard = value; return this; }
        public Integer getNiCat() { return NiCat; }
        public ThirdPartyOrderItem setNiCat(Integer value) { this.NiCat = value; return this; }
        public Integer getNiSub() { return NiSub; }
        public ThirdPartyOrderItem setNiSub(Integer value) { this.NiSub = value; return this; }
        public Long getExtPk() { return ExtPk; }
        public ThirdPartyOrderItem setExtPk(Long value) { this.ExtPk = value; return this; }
    }

    @DataContract
    public static class CustomerOrdersResponse extends BaseResponse
    {
        
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java 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"}}