AIM Web Services

<back to all web services

CustomerOrderFulfillmentRequest

CustomerOrderFulfillment
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/CustomerOrderFulfillment
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    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>
        '''CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
        '''</Summary>
        <DataContract>
        Public Partial Class CustomerOrderFulfillmentRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''Pass in if only looking for one weborder. Otherwise do not pass in.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Pass in if only looking for one weborder. Otherwise do not pass in.", Name:="WebOrder", ParameterType:="query")>
            Public Overridable Property WebOrder As String

            '''<Summary>
            '''Starting offset for Pagination. Defaults to 0.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Starting offset for Pagination. Defaults to 0.", Name:="StartOffset", ParameterType:="query")>
            Public Overridable Property StartOffset As Nullable(Of Long)

            '''<Summary>
            '''Records to be returned. Default to 100.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Records to be returned. Default to 100.", Name:="RecordCount", ParameterType:="query")>
            Public Overridable Property RecordCount As Nullable(Of Long)

            '''<Summary>
            '''If sent, fully picked orders will not be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="If sent, fully picked orders will not be returned.", Name:="ExcludeFullyPickedOrders", ParameterType:="query")>
            Public Overridable Property ExcludeFullyPickedOrders As Boolean
        End Class

        <DataContract>
        Public Partial Class CustomerOrderFulfillmentResponse
            Inherits BaseResponse
            Public Sub New()
                Items = New List(Of CustomerOrderItem)
                Orders = New List(Of CustomerWebOrder)
            End Sub

            <DataMember>
            Public Overridable Property WebOrder As String

            <DataMember>
            Public Overridable Property CustomerName As String

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property Items As List(Of CustomerOrderItem)

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

        <DataContract>
        Public Partial Class CustomerOrderItem
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property QuantityPicked As Decimal
        End Class

        <DataContract>
        Public Partial Class CustomerWebOrder
            Public Sub New()
                Items = New List(Of CustomerOrderItem)
            End Sub

            <DataMember>
            Public Overridable Property WebOrder As String

            <DataMember>
            Public Overridable Property CustomerName As String

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property Items As List(Of CustomerOrderItem)
        End Class
    End Namespace
End Namespace

VB.NET CustomerOrderFulfillmentRequest 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.

GET /api/CustomerOrderFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<CustomerOrderFulfillmentResponse 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>
  <CustomerName>String</CustomerName>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <Items>
    <CustomerOrderItem>
      <Description>String</Description>
      <Id>0</Id>
      <Item>String</Item>
      <Price>0</Price>
      <Quantity>0</Quantity>
      <QuantityPicked>0</QuantityPicked>
    </CustomerOrderItem>
  </Items>
  <Orders>
    <CustomerWebOrder>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <Items>
        <CustomerOrderItem>
          <Description>String</Description>
          <Id>0</Id>
          <Item>String</Item>
          <Price>0</Price>
          <Quantity>0</Quantity>
          <QuantityPicked>0</QuantityPicked>
        </CustomerOrderItem>
      </Items>
      <WebOrder>String</WebOrder>
    </CustomerWebOrder>
  </Orders>
  <WebOrder>String</WebOrder>
</CustomerOrderFulfillmentResponse>