AIM Web Services

<back to all web services

CustomerOrderFulfillmentRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

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>
    ///CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    ///</summary>
    [DataContract]
    public partial class CustomerOrderFulfillmentRequest
        : 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 virtual string WebOrder { get; set; }

        ///<summary>
        ///Starting offset for Pagination. Defaults to 0.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Starting offset for Pagination. Defaults to 0.", Name="StartOffset", ParameterType="query")]
        public virtual long? StartOffset { get; set; }

        ///<summary>
        ///Records to be returned. Default to 100.
        ///</summary>
        [DataMember]
        [ApiMember(Description="Records to be returned. Default to 100.", Name="RecordCount", ParameterType="query")]
        public virtual long? RecordCount { get; set; }

        ///<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 virtual bool ExcludeFullyPickedOrders { get; set; }
    }

    [DataContract]
    public partial class CustomerOrderFulfillmentResponse
        : BaseResponse
    {
        public CustomerOrderFulfillmentResponse()
        {
            Items = new List<CustomerOrderItem>{};
            Orders = new List<CustomerWebOrder>{};
        }

        [DataMember]
        public virtual string WebOrder { get; set; }

        [DataMember]
        public virtual string CustomerName { get; set; }

        [DataMember]
        public virtual DateTime DateTime { get; set; }

        [DataMember]
        public virtual List<CustomerOrderItem> Items { get; set; }

        [DataMember]
        public virtual List<CustomerWebOrder> Orders { get; set; }
    }

    [DataContract]
    public partial class CustomerOrderItem
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string Item { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual decimal Price { get; set; }

        [DataMember]
        public virtual decimal Quantity { get; set; }

        [DataMember]
        public virtual decimal QuantityPicked { get; set; }
    }

    [DataContract]
    public partial class CustomerWebOrder
    {
        public CustomerWebOrder()
        {
            Items = new List<CustomerOrderItem>{};
        }

        [DataMember]
        public virtual string WebOrder { get; set; }

        [DataMember]
        public virtual string CustomerName { get; set; }

        [DataMember]
        public virtual DateTime DateTime { get; set; }

        [DataMember]
        public virtual List<CustomerOrderItem> Items { get; set; }
    }

}

C# CustomerOrderFulfillmentRequest DTOs

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>