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
namespace AIM.BL.Core.Misc

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerOrdersResponse() = 
        inherit BaseResponse()

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ThirdPartyOrderItem() = 
        [<DataMember>]
        member val ProductName:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val SerialNumber:String = null with get,set

        [<DataMember>]
        member val WebNumber:String = null with get,set

        [<DataMember>]
        member val Location:String = null with get,set

        [<DataMember>]
        member val Qty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val QtyPicked:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val UseQtyPicked:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OnApproval:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsECard:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val NiCat:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val NiSub:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val ExtPk:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ThirdPartyOrder() = 
        [<DataMember>]
        member val OrderNumber:String = null with get,set

        [<DataMember>]
        member val OrderDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val TransactionState:String = null with get,set

        [<DataMember>]
        member val PaymentMethod:String = null with get,set

        [<DataMember>]
        member val OrderNotes:String = null with get,set

        [<DataMember>]
        member val AuthorizationCode:String = null with get,set

        [<DataMember>]
        member val ShippingMethod:String = null with get,set

        [<DataMember>]
        member val Total:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SubTotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val TaxTotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ShippingTotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CardType:String = null with get,set

        [<DataMember>]
        member val CardToken:String = null with get,set

        [<DataMember>]
        member val CardSpan:String = null with get,set

        [<DataMember>]
        member val CardExpirationMonth:String = null with get,set

        [<DataMember>]
        member val CardExpirationYear:String = null with get,set

        [<DataMember>]
        member val CustomerAcct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val PO:String = null with get,set

        [<DataMember>]
        member val EmployeeUsername:String = null with get,set

        [<DataMember>]
        member val AeOnApprovalOrderSubtotal:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AeOnApprovalOrderShipping:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ShippingAttn:String = null with get,set

        [<DataMember>]
        member val ShippingName:String = null with get,set

        [<DataMember>]
        member val ShippingFirstName:String = null with get,set

        [<DataMember>]
        member val ShippingLastName:String = null with get,set

        [<DataMember>]
        member val ShippingCompany:String = null with get,set

        [<DataMember>]
        member val ShippingAddr1:String = null with get,set

        [<DataMember>]
        member val ShippingAddr2:String = null with get,set

        [<DataMember>]
        member val ShippingCity:String = null with get,set

        [<DataMember>]
        member val ShippingSt:String = null with get,set

        [<DataMember>]
        member val ShippingZip:String = null with get,set

        [<DataMember>]
        member val ShippingCountry:String = null with get,set

        [<DataMember>]
        member val ShippingPhone:String = null with get,set

        [<DataMember>]
        member val BillingAttn:String = null with get,set

        [<DataMember>]
        member val BillingName:String = null with get,set

        [<DataMember>]
        member val BillingFirstName:String = null with get,set

        [<DataMember>]
        member val BillingLastName:String = null with get,set

        [<DataMember>]
        member val BillingCompany:String = null with get,set

        [<DataMember>]
        member val BillingAddr1:String = null with get,set

        [<DataMember>]
        member val BillingAddr2:String = null with get,set

        [<DataMember>]
        member val BillingCity:String = null with get,set

        [<DataMember>]
        member val BillingSt:String = null with get,set

        [<DataMember>]
        member val BillingZip:String = null with get,set

        [<DataMember>]
        member val BillingCountry:String = null with get,set

        [<DataMember>]
        member val BillingPhone:String = null with get,set

        [<DataMember>]
        member val OrderSource:String = null with get,set

        [<DataMember>]
        member val CardName:String = null with get,set

        [<DataMember>]
        member val PnRef:String = null with get,set

        [<DataMember>]
        member val LineItems:ResizeArray<ThirdPartyOrderItem> = new ResizeArray<ThirdPartyOrderItem>() with get,set

    ///<summary>
    ///CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerOrdersRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Orders:ResizeArray<ThirdPartyOrder> = new ResizeArray<ThirdPartyOrder>() with get,set

F# 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>