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 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * 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")
    String? ApiKey;

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

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

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

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

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

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

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

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

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

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

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

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

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class ECommerceOrderLineItem implements IConvertible
{
    // @DataMember
    String? Sku;

    // @DataMember
    double? Quantity;

    // @DataMember
    String? ItemStatus;

    // @DataMember
    int? ShipmentId;

    ECommerceOrderLineItem({this.Sku,this.Quantity,this.ItemStatus,this.ShipmentId});
    ECommerceOrderLineItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Sku = json['Sku'];
        Quantity = JsonConverters.toDouble(json['Quantity']);
        ItemStatus = json['ItemStatus'];
        ShipmentId = json['ShipmentId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Sku': Sku,
        'Quantity': Quantity,
        'ItemStatus': ItemStatus,
        'ShipmentId': ShipmentId
    };

    getTypeName() => "ECommerceOrderLineItem";
    TypeContext? context = _ctx;
}

// @DataContract
class ECommerceOrderShippingInfo implements IConvertible
{
    // @DataMember
    int? ShipmentId;

    // @DataMember
    String? ShipVia;

    // @DataMember
    List<String>? TrackingNumbers;

    ECommerceOrderShippingInfo({this.ShipmentId,this.ShipVia,this.TrackingNumbers});
    ECommerceOrderShippingInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ShipmentId = json['ShipmentId'];
        ShipVia = json['ShipVia'];
        TrackingNumbers = JsonConverters.fromJson(json['TrackingNumbers'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ShipmentId': ShipmentId,
        'ShipVia': ShipVia,
        'TrackingNumbers': JsonConverters.toJson(TrackingNumbers,'List<String>',context!)
    };

    getTypeName() => "ECommerceOrderShippingInfo";
    TypeContext? context = _ctx;
}

// @DataContract
class ECommerceOrderStatusResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    String? OrderStatus;

    // @DataMember
    String? OrderStatusDescription;

    // @DataMember
    List<ECommerceOrderLineItem>? LineItems;

    // @DataMember
    List<ECommerceOrderShippingInfo>? ShippingInfo;

    ECommerceOrderStatusResponse({this.OrderStatus,this.OrderStatusDescription,this.LineItems,this.ShippingInfo});
    ECommerceOrderStatusResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        OrderStatus = json['OrderStatus'];
        OrderStatusDescription = json['OrderStatusDescription'];
        LineItems = JsonConverters.fromJson(json['LineItems'],'List<ECommerceOrderLineItem>',context!);
        ShippingInfo = JsonConverters.fromJson(json['ShippingInfo'],'List<ECommerceOrderShippingInfo>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OrderStatus': OrderStatus,
        'OrderStatusDescription': OrderStatusDescription,
        'LineItems': JsonConverters.toJson(LineItems,'List<ECommerceOrderLineItem>',context!),
        'ShippingInfo': JsonConverters.toJson(ShippingInfo,'List<ECommerceOrderShippingInfo>',context!)
    });

    getTypeName() => "ECommerceOrderStatusResponse";
    TypeContext? context = _ctx;
}

/**
* ECommerceOrderStatusRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
class ECommerceOrderStatusRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? OrderNumber;

    /**
    * 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")
    String? OrderType;

    ECommerceOrderStatusRequest({this.OrderNumber,this.OrderType});
    ECommerceOrderStatusRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        OrderNumber = json['OrderNumber'];
        OrderType = json['OrderType'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OrderNumber': OrderNumber,
        'OrderType': OrderType
    });

    getTypeName() => "ECommerceOrderStatusRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'ECommerceOrderLineItem': TypeInfo(TypeOf.Class, create:() => ECommerceOrderLineItem()),
    'ECommerceOrderShippingInfo': TypeInfo(TypeOf.Class, create:() => ECommerceOrderShippingInfo()),
    'ECommerceOrderStatusResponse': TypeInfo(TypeOf.Class, create:() => ECommerceOrderStatusResponse()),
    'List<ECommerceOrderLineItem>': TypeInfo(TypeOf.Class, create:() => <ECommerceOrderLineItem>[]),
    'List<ECommerceOrderShippingInfo>': TypeInfo(TypeOf.Class, create:() => <ECommerceOrderShippingInfo>[]),
    'ECommerceOrderStatusRequest': TypeInfo(TypeOf.Class, create:() => ECommerceOrderStatusRequest()),
});

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