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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CustomerOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Misc">
    <d2p1:ThirdPartyOrder>
      <d2p1:AeOnApprovalOrderShipping>0</d2p1:AeOnApprovalOrderShipping>
      <d2p1:AeOnApprovalOrderSubtotal>0</d2p1:AeOnApprovalOrderSubtotal>
      <d2p1:AuthorizationCode>String</d2p1:AuthorizationCode>
      <d2p1:BillingAddr1>String</d2p1:BillingAddr1>
      <d2p1:BillingAddr2>String</d2p1:BillingAddr2>
      <d2p1:BillingAttn>String</d2p1:BillingAttn>
      <d2p1:BillingCity>String</d2p1:BillingCity>
      <d2p1:BillingCompany>String</d2p1:BillingCompany>
      <d2p1:BillingCountry>String</d2p1:BillingCountry>
      <d2p1:BillingFirstName>String</d2p1:BillingFirstName>
      <d2p1:BillingLastName>String</d2p1:BillingLastName>
      <d2p1:BillingName>String</d2p1:BillingName>
      <d2p1:BillingPhone>String</d2p1:BillingPhone>
      <d2p1:BillingSt>String</d2p1:BillingSt>
      <d2p1:BillingZip>String</d2p1:BillingZip>
      <d2p1:CardExpirationMonth>String</d2p1:CardExpirationMonth>
      <d2p1:CardExpirationYear>String</d2p1:CardExpirationYear>
      <d2p1:CardName>String</d2p1:CardName>
      <d2p1:CardSpan>String</d2p1:CardSpan>
      <d2p1:CardToken>String</d2p1:CardToken>
      <d2p1:CardType>String</d2p1:CardType>
      <d2p1:CustomerAcct>0</d2p1:CustomerAcct>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:EmployeeUsername>String</d2p1:EmployeeUsername>
      <d2p1:LineItems>
        <d2p1:ThirdPartyOrder.ThirdPartyOrderItem>
          <d2p1:ExtPk>0</d2p1:ExtPk>
          <d2p1:IsECard>false</d2p1:IsECard>
          <d2p1:Location>String</d2p1:Location>
          <d2p1:NiCat>0</d2p1:NiCat>
          <d2p1:NiSub>0</d2p1:NiSub>
          <d2p1:OnApproval>false</d2p1:OnApproval>
          <d2p1:Price>0</d2p1:Price>
          <d2p1:ProductName>String</d2p1:ProductName>
          <d2p1:Qty>0</d2p1:Qty>
          <d2p1:QtyPicked>0</d2p1:QtyPicked>
          <d2p1:SerialNumber>String</d2p1:SerialNumber>
          <d2p1:Sku>String</d2p1:Sku>
          <d2p1:UseQtyPicked>false</d2p1:UseQtyPicked>
          <d2p1:WebNumber>String</d2p1:WebNumber>
        </d2p1:ThirdPartyOrder.ThirdPartyOrderItem>
      </d2p1:LineItems>
      <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
      <d2p1:OrderNotes>String</d2p1:OrderNotes>
      <d2p1:OrderNumber>String</d2p1:OrderNumber>
      <d2p1:OrderSource>String</d2p1:OrderSource>
      <d2p1:PO>String</d2p1:PO>
      <d2p1:PaymentMethod>String</d2p1:PaymentMethod>
      <d2p1:PnRef>String</d2p1:PnRef>
      <d2p1:ShippingAddr1>String</d2p1:ShippingAddr1>
      <d2p1:ShippingAddr2>String</d2p1:ShippingAddr2>
      <d2p1:ShippingAttn>String</d2p1:ShippingAttn>
      <d2p1:ShippingCity>String</d2p1:ShippingCity>
      <d2p1:ShippingCompany>String</d2p1:ShippingCompany>
      <d2p1:ShippingCountry>String</d2p1:ShippingCountry>
      <d2p1:ShippingFirstName>String</d2p1:ShippingFirstName>
      <d2p1:ShippingLastName>String</d2p1:ShippingLastName>
      <d2p1:ShippingMethod>String</d2p1:ShippingMethod>
      <d2p1:ShippingName>String</d2p1:ShippingName>
      <d2p1:ShippingPhone>String</d2p1:ShippingPhone>
      <d2p1:ShippingSt>String</d2p1:ShippingSt>
      <d2p1:ShippingTotal>0</d2p1:ShippingTotal>
      <d2p1:ShippingZip>String</d2p1:ShippingZip>
      <d2p1:SubTotal>0</d2p1:SubTotal>
      <d2p1:TaxTotal>0</d2p1:TaxTotal>
      <d2p1:Total>0</d2p1:Total>
      <d2p1:TransactionState>String</d2p1:TransactionState>
    </d2p1:ThirdPartyOrder>
  </Orders>
</CustomerOrdersRequest>

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

<CustomerOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</CustomerOrdersResponse>