AIM Web Services

<back to all web services

ECommerceOrderStatusRequest

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * ECommerceOrderStatusRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
    */
    @DataContract
    public static class ECommerceOrderStatusRequest extends BaseSecureRequest
    {
        @DataMember
        public String OrderNumber = null;

        /**
        * 3 is 3rd Party, C is AIMStoreFront, E is Ebay, A is Amazon, B is Excel Import, R is Reverb, G is Gunbroker, M is Ammoready. Defaults to 3
        */
        @DataMember
        @ApiMember(DataType="string", Description="3 is 3rd Party, C is AIMStoreFront, E is Ebay, A is Amazon, B is Excel Import, R is Reverb, G is Gunbroker, M is Ammoready. Defaults to 3", Name="OrderType", ParameterType="query")
        public String OrderType = null;
        
        public String getOrderNumber() { return OrderNumber; }
        public ECommerceOrderStatusRequest setOrderNumber(String value) { this.OrderNumber = value; return this; }
        public String getOrderType() { return OrderType; }
        public ECommerceOrderStatusRequest setOrderType(String value) { this.OrderType = 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 ECommerceOrderStatusResponse extends BaseResponse
    {
        @DataMember
        public String OrderStatus = null;

        @DataMember
        public String OrderStatusDescription = null;

        @DataMember
        public ArrayList<ECommerceOrderLineItem> LineItems = null;

        @DataMember
        public ArrayList<ECommerceOrderShippingInfo> ShippingInfo = null;
        
        public String getOrderStatus() { return OrderStatus; }
        public ECommerceOrderStatusResponse setOrderStatus(String value) { this.OrderStatus = value; return this; }
        public String getOrderStatusDescription() { return OrderStatusDescription; }
        public ECommerceOrderStatusResponse setOrderStatusDescription(String value) { this.OrderStatusDescription = value; return this; }
        public ArrayList<ECommerceOrderLineItem> getLineItems() { return LineItems; }
        public ECommerceOrderStatusResponse setLineItems(ArrayList<ECommerceOrderLineItem> value) { this.LineItems = value; return this; }
        public ArrayList<ECommerceOrderShippingInfo> getShippingInfo() { return ShippingInfo; }
        public ECommerceOrderStatusResponse setShippingInfo(ArrayList<ECommerceOrderShippingInfo> value) { this.ShippingInfo = 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 ECommerceOrderLineItem
    {
        @DataMember
        public String Sku = null;

        @DataMember
        public BigDecimal Quantity = null;

        @DataMember
        public String ItemStatus = null;

        @DataMember
        public Integer ShipmentId = null;
        
        public String getSku() { return Sku; }
        public ECommerceOrderLineItem setSku(String value) { this.Sku = value; return this; }
        public BigDecimal getQuantity() { return Quantity; }
        public ECommerceOrderLineItem setQuantity(BigDecimal value) { this.Quantity = value; return this; }
        public String getItemStatus() { return ItemStatus; }
        public ECommerceOrderLineItem setItemStatus(String value) { this.ItemStatus = value; return this; }
        public Integer getShipmentId() { return ShipmentId; }
        public ECommerceOrderLineItem setShipmentId(Integer value) { this.ShipmentId = value; return this; }
    }

    @DataContract
    public static class ECommerceOrderShippingInfo
    {
        @DataMember
        public Integer ShipmentId = null;

        @DataMember
        public String ShipVia = null;

        @DataMember
        public ArrayList<String> TrackingNumbers = null;
        
        public Integer getShipmentId() { return ShipmentId; }
        public ECommerceOrderShippingInfo setShipmentId(Integer value) { this.ShipmentId = value; return this; }
        public String getShipVia() { return ShipVia; }
        public ECommerceOrderShippingInfo setShipVia(String value) { this.ShipVia = value; return this; }
        public ArrayList<String> getTrackingNumbers() { return TrackingNumbers; }
        public ECommerceOrderShippingInfo setTrackingNumbers(ArrayList<String> value) { this.TrackingNumbers = value; return this; }
    }

}

Java ECommerceOrderStatusRequest DTOs

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

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

<ECommerceOrderStatusResponse 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>
  <LineItems>
    <ECommerceOrderLineItem>
      <ItemStatus>String</ItemStatus>
      <Quantity>0</Quantity>
      <ShipmentId>0</ShipmentId>
      <Sku>String</Sku>
    </ECommerceOrderLineItem>
  </LineItems>
  <OrderStatus>String</OrderStatus>
  <OrderStatusDescription>String</OrderStatusDescription>
  <ShippingInfo>
    <ECommerceOrderShippingInfo>
      <ShipVia>String</ShipVia>
      <ShipmentId>0</ShipmentId>
      <TrackingNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TrackingNumbers>
    </ECommerceOrderShippingInfo>
  </ShippingInfo>
</ECommerceOrderStatusResponse>