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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    */
    @DataContract
    public static class CustomerOrderFulfillmentRequest extends BaseSecureRequest
    {
        /**
        * Pass in if only looking for one weborder. Otherwise do not pass in.
        */
        @DataMember
        @ApiMember(Description="Pass in if only looking for one weborder. Otherwise do not pass in.", Name="WebOrder", ParameterType="query")
        public String WebOrder = null;

        /**
        * Starting offset for Pagination. Defaults to 0.
        */
        @DataMember
        @ApiMember(Description="Starting offset for Pagination. Defaults to 0.", Name="StartOffset", ParameterType="query")
        public Long StartOffset = null;

        /**
        * Records to be returned. Default to 100.
        */
        @DataMember
        @ApiMember(Description="Records to be returned. Default to 100.", Name="RecordCount", ParameterType="query")
        public Long RecordCount = null;

        /**
        * If sent, fully picked orders will not be returned.
        */
        @DataMember
        @ApiMember(Description="If sent, fully picked orders will not be returned.", Name="ExcludeFullyPickedOrders", ParameterType="query")
        public Boolean ExcludeFullyPickedOrders = null;
        
        public String getWebOrder() { return WebOrder; }
        public CustomerOrderFulfillmentRequest setWebOrder(String value) { this.WebOrder = value; return this; }
        public Long getStartOffset() { return StartOffset; }
        public CustomerOrderFulfillmentRequest setStartOffset(Long value) { this.StartOffset = value; return this; }
        public Long getRecordCount() { return RecordCount; }
        public CustomerOrderFulfillmentRequest setRecordCount(Long value) { this.RecordCount = value; return this; }
        public Boolean isExcludeFullyPickedOrders() { return ExcludeFullyPickedOrders; }
        public CustomerOrderFulfillmentRequest setExcludeFullyPickedOrders(Boolean value) { this.ExcludeFullyPickedOrders = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class CustomerOrderFulfillmentResponse extends BaseResponse
    {
        @DataMember
        public String WebOrder = null;

        @DataMember
        public String CustomerName = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public ArrayList<CustomerOrderItem> Items = null;

        @DataMember
        public ArrayList<CustomerWebOrder> Orders = null;
        
        public String getWebOrder() { return WebOrder; }
        public CustomerOrderFulfillmentResponse setWebOrder(String value) { this.WebOrder = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public CustomerOrderFulfillmentResponse setCustomerName(String value) { this.CustomerName = value; return this; }
        public Date getDateTime() { return DateTime; }
        public CustomerOrderFulfillmentResponse setDateTime(Date value) { this.DateTime = value; return this; }
        public ArrayList<CustomerOrderItem> getItems() { return Items; }
        public CustomerOrderFulfillmentResponse setItems(ArrayList<CustomerOrderItem> value) { this.Items = value; return this; }
        public ArrayList<CustomerWebOrder> getOrders() { return Orders; }
        public CustomerOrderFulfillmentResponse setOrders(ArrayList<CustomerWebOrder> value) { this.Orders = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class CustomerOrderItem
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Item = null;

        @DataMember
        public String Description = null;

        @DataMember
        public BigDecimal Price = null;

        @DataMember
        public BigDecimal Quantity = null;

        @DataMember
        public BigDecimal QuantityPicked = null;
        
        public Long getId() { return Id; }
        public CustomerOrderItem setId(Long value) { this.Id = value; return this; }
        public String getItem() { return Item; }
        public CustomerOrderItem setItem(String value) { this.Item = value; return this; }
        public String getDescription() { return Description; }
        public CustomerOrderItem setDescription(String value) { this.Description = value; return this; }
        public BigDecimal getPrice() { return Price; }
        public CustomerOrderItem setPrice(BigDecimal value) { this.Price = value; return this; }
        public BigDecimal getQuantity() { return Quantity; }
        public CustomerOrderItem setQuantity(BigDecimal value) { this.Quantity = value; return this; }
        public BigDecimal getQuantityPicked() { return QuantityPicked; }
        public CustomerOrderItem setQuantityPicked(BigDecimal value) { this.QuantityPicked = value; return this; }
    }

    @DataContract
    public static class CustomerWebOrder
    {
        @DataMember
        public String WebOrder = null;

        @DataMember
        public String CustomerName = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public ArrayList<CustomerOrderItem> Items = null;
        
        public String getWebOrder() { return WebOrder; }
        public CustomerWebOrder setWebOrder(String value) { this.WebOrder = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public CustomerWebOrder setCustomerName(String value) { this.CustomerName = value; return this; }
        public Date getDateTime() { return DateTime; }
        public CustomerWebOrder setDateTime(Date value) { this.DateTime = value; return this; }
        public ArrayList<CustomerOrderItem> getItems() { return Items; }
        public CustomerWebOrder setItems(ArrayList<CustomerOrderItem> value) { this.Items = value; return this; }
    }

}

Java 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>