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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class ECommerceOrderLineItem {
    /** @param {{Sku?:string,Quantity?:number,ItemStatus?:string,ShipmentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Sku;
    /** @type {number} */
    Quantity;
    /** @type {string} */
    ItemStatus;
    /** @type {?number} */
    ShipmentId;
}
export class ECommerceOrderShippingInfo {
    /** @param {{ShipmentId?:number,ShipVia?:string,TrackingNumbers?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ShipmentId;
    /** @type {string} */
    ShipVia;
    /** @type {string[]} */
    TrackingNumbers;
}
export class ECommerceOrderStatusResponse extends BaseResponse {
    /** @param {{OrderStatus?:string,OrderStatusDescription?:string,LineItems?:ECommerceOrderLineItem[],ShippingInfo?:ECommerceOrderShippingInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    OrderStatus;
    /** @type {string} */
    OrderStatusDescription;
    /** @type {ECommerceOrderLineItem[]} */
    LineItems;
    /** @type {ECommerceOrderShippingInfo[]} */
    ShippingInfo;
}
export class ECommerceOrderStatusRequest extends BaseSecureRequest {
    /** @param {{OrderNumber?:string,OrderType?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    OrderNumber;
    /**
     * @type {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 */
    OrderType;
}

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