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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM.BL.Core.Misc;

namespace AIM.BL.Core.Misc
{
    [DataContract]
    public partial class ThirdPartyOrder
    {
        public ThirdPartyOrder()
        {
            LineItems = new List<ThirdPartyOrderItem>{};
        }

        [DataMember]
        public virtual string OrderNumber { get; set; }

        [DataMember]
        public virtual DateTime OrderDate { get; set; }

        [DataMember]
        public virtual string TransactionState { get; set; }

        [DataMember]
        public virtual string PaymentMethod { get; set; }

        [DataMember]
        public virtual string OrderNotes { get; set; }

        [DataMember]
        public virtual string AuthorizationCode { get; set; }

        [DataMember]
        public virtual string ShippingMethod { get; set; }

        [DataMember]
        public virtual decimal Total { get; set; }

        [DataMember]
        public virtual decimal SubTotal { get; set; }

        [DataMember]
        public virtual decimal TaxTotal { get; set; }

        [DataMember]
        public virtual decimal ShippingTotal { get; set; }

        [DataMember]
        public virtual string CardType { get; set; }

        [DataMember]
        public virtual string CardToken { get; set; }

        [DataMember]
        public virtual string CardSpan { get; set; }

        [DataMember]
        public virtual string CardExpirationMonth { get; set; }

        [DataMember]
        public virtual string CardExpirationYear { get; set; }

        [DataMember]
        public virtual int CustomerAcct { get; set; }

        [DataMember]
        public virtual string Email { get; set; }

        [DataMember]
        public virtual string PO { get; set; }

        [DataMember]
        public virtual string EmployeeUsername { get; set; }

        [DataMember]
        public virtual decimal AeOnApprovalOrderSubtotal { get; set; }

        [DataMember]
        public virtual decimal AeOnApprovalOrderShipping { get; set; }

        [DataMember]
        public virtual string ShippingAttn { get; set; }

        [DataMember]
        public virtual string ShippingName { get; set; }

        [DataMember]
        public virtual string ShippingFirstName { get; set; }

        [DataMember]
        public virtual string ShippingLastName { get; set; }

        [DataMember]
        public virtual string ShippingCompany { get; set; }

        [DataMember]
        public virtual string ShippingAddr1 { get; set; }

        [DataMember]
        public virtual string ShippingAddr2 { get; set; }

        [DataMember]
        public virtual string ShippingCity { get; set; }

        [DataMember]
        public virtual string ShippingSt { get; set; }

        [DataMember]
        public virtual string ShippingZip { get; set; }

        [DataMember]
        public virtual string ShippingCountry { get; set; }

        [DataMember]
        public virtual string ShippingPhone { get; set; }

        [DataMember]
        public virtual string BillingAttn { get; set; }

        [DataMember]
        public virtual string BillingName { get; set; }

        [DataMember]
        public virtual string BillingFirstName { get; set; }

        [DataMember]
        public virtual string BillingLastName { get; set; }

        [DataMember]
        public virtual string BillingCompany { get; set; }

        [DataMember]
        public virtual string BillingAddr1 { get; set; }

        [DataMember]
        public virtual string BillingAddr2 { get; set; }

        [DataMember]
        public virtual string BillingCity { get; set; }

        [DataMember]
        public virtual string BillingSt { get; set; }

        [DataMember]
        public virtual string BillingZip { get; set; }

        [DataMember]
        public virtual string BillingCountry { get; set; }

        [DataMember]
        public virtual string BillingPhone { get; set; }

        [DataMember]
        public virtual string OrderSource { get; set; }

        [DataMember]
        public virtual string CardName { get; set; }

        [DataMember]
        public virtual string PnRef { get; set; }

        [DataMember]
        public virtual List<ThirdPartyOrderItem> LineItems { get; set; }
        [DataContract]
        public partial class ThirdPartyOrderItem
        {
            [DataMember]
            public virtual string ProductName { get; set; }

            [DataMember]
            public virtual string Sku { get; set; }

            [DataMember]
            public virtual string SerialNumber { get; set; }

            [DataMember]
            public virtual string WebNumber { get; set; }

            [DataMember]
            public virtual string Location { get; set; }

            [DataMember]
            public virtual decimal Qty { get; set; }

            [DataMember]
            public virtual decimal QtyPicked { get; set; }

            [DataMember]
            public virtual bool UseQtyPicked { get; set; }

            [DataMember]
            public virtual decimal Price { get; set; }

            [DataMember]
            public virtual bool OnApproval { get; set; }

            [DataMember]
            public virtual bool IsECard { get; set; }

            [DataMember]
            public virtual int? NiCat { get; set; }

            [DataMember]
            public virtual int? NiSub { get; set; }

            [DataMember]
            public virtual long? ExtPk { get; set; }
        }

    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    ///</summary>
    [DataContract]
    public partial class CustomerOrdersRequest
        : BaseSecureRequest
    {
        public CustomerOrdersRequest()
        {
            Orders = new List<ThirdPartyOrder>{};
        }

        [DataMember]
        public virtual List<ThirdPartyOrder> Orders { get; set; }
    }

    [DataContract]
    public partial class CustomerOrdersResponse
        : BaseResponse
    {
    }

}

C# CustomerOrdersRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length

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