AIM Web Services

<back to all web services

ECommerceOrderStatusRequest

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

The following routes are available for this service:
GET/api/ECommerceOrderStatus
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* ECommerceOrderStatusRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
@DataContract
open class ECommerceOrderStatusRequest : BaseSecureRequest()
{
    @DataMember
    var OrderNumber:String? = 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")
    var OrderType:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class ECommerceOrderStatusResponse : BaseResponse()
{
    @DataMember
    var OrderStatus:String? = null

    @DataMember
    var OrderStatusDescription:String? = null

    @DataMember
    var LineItems:ArrayList<ECommerceOrderLineItem> = ArrayList<ECommerceOrderLineItem>()

    @DataMember
    var ShippingInfo:ArrayList<ECommerceOrderShippingInfo> = ArrayList<ECommerceOrderShippingInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ECommerceOrderLineItem
{
    @DataMember
    var Sku:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ItemStatus:String? = null

    @DataMember
    var ShipmentId:Int? = null
}

@DataContract
open class ECommerceOrderShippingInfo
{
    @DataMember
    var ShipmentId:Int? = null

    @DataMember
    var ShipVia:String? = null

    @DataMember
    var TrackingNumbers:ArrayList<String> = ArrayList<String>()
}

Kotlin ECommerceOrderStatusRequest 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/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>