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

Namespace Global

    Namespace AIM.BL.Core.Misc

        <DataContract>
        Public Partial Class ThirdPartyOrder
            Public Sub New()
                LineItems = New List(Of ThirdPartyOrderItem)
            End Sub

            <DataMember>
            Public Overridable Property OrderNumber As String

            <DataMember>
            Public Overridable Property OrderDate As Date

            <DataMember>
            Public Overridable Property TransactionState As String

            <DataMember>
            Public Overridable Property PaymentMethod As String

            <DataMember>
            Public Overridable Property OrderNotes As String

            <DataMember>
            Public Overridable Property AuthorizationCode As String

            <DataMember>
            Public Overridable Property ShippingMethod As String

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property SubTotal As Decimal

            <DataMember>
            Public Overridable Property TaxTotal As Decimal

            <DataMember>
            Public Overridable Property ShippingTotal As Decimal

            <DataMember>
            Public Overridable Property CardType As String

            <DataMember>
            Public Overridable Property CardToken As String

            <DataMember>
            Public Overridable Property CardSpan As String

            <DataMember>
            Public Overridable Property CardExpirationMonth As String

            <DataMember>
            Public Overridable Property CardExpirationYear As String

            <DataMember>
            Public Overridable Property CustomerAcct As Integer

            <DataMember>
            Public Overridable Property Email As String

            <DataMember>
            Public Overridable Property PO As String

            <DataMember>
            Public Overridable Property EmployeeUsername As String

            <DataMember>
            Public Overridable Property AeOnApprovalOrderSubtotal As Decimal

            <DataMember>
            Public Overridable Property AeOnApprovalOrderShipping As Decimal

            <DataMember>
            Public Overridable Property ShippingAttn As String

            <DataMember>
            Public Overridable Property ShippingName As String

            <DataMember>
            Public Overridable Property ShippingFirstName As String

            <DataMember>
            Public Overridable Property ShippingLastName As String

            <DataMember>
            Public Overridable Property ShippingCompany As String

            <DataMember>
            Public Overridable Property ShippingAddr1 As String

            <DataMember>
            Public Overridable Property ShippingAddr2 As String

            <DataMember>
            Public Overridable Property ShippingCity As String

            <DataMember>
            Public Overridable Property ShippingSt As String

            <DataMember>
            Public Overridable Property ShippingZip As String

            <DataMember>
            Public Overridable Property ShippingCountry As String

            <DataMember>
            Public Overridable Property ShippingPhone As String

            <DataMember>
            Public Overridable Property BillingAttn As String

            <DataMember>
            Public Overridable Property BillingName As String

            <DataMember>
            Public Overridable Property BillingFirstName As String

            <DataMember>
            Public Overridable Property BillingLastName As String

            <DataMember>
            Public Overridable Property BillingCompany As String

            <DataMember>
            Public Overridable Property BillingAddr1 As String

            <DataMember>
            Public Overridable Property BillingAddr2 As String

            <DataMember>
            Public Overridable Property BillingCity As String

            <DataMember>
            Public Overridable Property BillingSt As String

            <DataMember>
            Public Overridable Property BillingZip As String

            <DataMember>
            Public Overridable Property BillingCountry As String

            <DataMember>
            Public Overridable Property BillingPhone As String

            <DataMember>
            Public Overridable Property OrderSource As String

            <DataMember>
            Public Overridable Property CardName As String

            <DataMember>
            Public Overridable Property PnRef As String

            <DataMember>
            Public Overridable Property LineItems As List(Of ThirdPartyOrderItem)

            <DataContract>
            Public Partial Class ThirdPartyOrderItem
                <DataMember>
                Public Overridable Property ProductName As String

                <DataMember>
                Public Overridable Property Sku As String

                <DataMember>
                Public Overridable Property SerialNumber As String

                <DataMember>
                Public Overridable Property WebNumber As String

                <DataMember>
                Public Overridable Property Location As String

                <DataMember>
                Public Overridable Property Qty As Decimal

                <DataMember>
                Public Overridable Property QtyPicked As Decimal

                <DataMember>
                Public Overridable Property UseQtyPicked As Boolean

                <DataMember>
                Public Overridable Property Price As Decimal

                <DataMember>
                Public Overridable Property OnApproval As Boolean

                <DataMember>
                Public Overridable Property IsECard As Boolean

                <DataMember>
                Public Overridable Property NiCat As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property NiSub As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property ExtPk As Nullable(Of Long)
            End Class
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''CustomerOrdersRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
        '''</Summary>
        <DataContract>
        Public Partial Class CustomerOrdersRequest
            Inherits BaseSecureRequest
            Public Sub New()
                Orders = New List(Of ThirdPartyOrder)
            End Sub

            <DataMember>
            Public Overridable Property Orders As List(Of ThirdPartyOrder)
        End Class

        <DataContract>
        Public Partial Class CustomerOrdersResponse
            Inherits BaseResponse
        End Class
    End Namespace
End Namespace

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