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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

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

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

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

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

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

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

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ECommerceOrderLineItem
{
    // @DataMember
    public Sku: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ItemStatus: string;

    // @DataMember
    public ShipmentId?: number;

    public constructor(init?: Partial<ECommerceOrderLineItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ECommerceOrderShippingInfo
{
    // @DataMember
    public ShipmentId: number;

    // @DataMember
    public ShipVia: string;

    // @DataMember
    public TrackingNumbers: string[];

    public constructor(init?: Partial<ECommerceOrderShippingInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ECommerceOrderStatusResponse extends BaseResponse
{
    // @DataMember
    public OrderStatus: string;

    // @DataMember
    public OrderStatusDescription: string;

    // @DataMember
    public LineItems: ECommerceOrderLineItem[];

    // @DataMember
    public ShippingInfo: ECommerceOrderShippingInfo[];

    public constructor(init?: Partial<ECommerceOrderStatusResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description ECommerceOrderStatusRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce. */
// @DataContract
export class ECommerceOrderStatusRequest extends BaseSecureRequest
{
    // @DataMember
    public OrderNumber: 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 */
    // @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 OrderType: string;

    public constructor(init?: Partial<ECommerceOrderStatusRequest>) { super(init); (Object as any).assign(this, init); }
}

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