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