AIM Web Services

<back to all web services

CustomerOrderFulfillmentRequest

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

The following routes are available for this service:
GET/api/CustomerOrderFulfillment
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 CustomerOrderItem implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Item;

    // @DataMember
    String? Description;

    // @DataMember
    double? Price;

    // @DataMember
    double? Quantity;

    // @DataMember
    double? QuantityPicked;

    CustomerOrderItem({this.Id,this.Item,this.Description,this.Price,this.Quantity,this.QuantityPicked});
    CustomerOrderItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Item = json['Item'];
        Description = json['Description'];
        Price = JsonConverters.toDouble(json['Price']);
        Quantity = JsonConverters.toDouble(json['Quantity']);
        QuantityPicked = JsonConverters.toDouble(json['QuantityPicked']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Item': Item,
        'Description': Description,
        'Price': Price,
        'Quantity': Quantity,
        'QuantityPicked': QuantityPicked
    };

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

// @DataContract
class CustomerWebOrder implements IConvertible
{
    // @DataMember
    String? WebOrder;

    // @DataMember
    String? CustomerName;

    // @DataMember
    DateTime? DateTime;

    // @DataMember
    List<CustomerOrderItem>? Items;

    CustomerWebOrder({this.WebOrder,this.CustomerName,this.DateTime,this.Items});
    CustomerWebOrder.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WebOrder = json['WebOrder'];
        CustomerName = json['CustomerName'];
        DateTime = JsonConverters.fromJson(json['DateTime'],'DateTime',context!);
        Items = JsonConverters.fromJson(json['Items'],'List<CustomerOrderItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WebOrder': WebOrder,
        'CustomerName': CustomerName,
        'DateTime': JsonConverters.toJson(DateTime,'DateTime',context!),
        'Items': JsonConverters.toJson(Items,'List<CustomerOrderItem>',context!)
    };

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

// @DataContract
class CustomerOrderFulfillmentResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    String? WebOrder;

    // @DataMember
    String? CustomerName;

    // @DataMember
    DateTime? DateTime;

    // @DataMember
    List<CustomerOrderItem>? Items;

    // @DataMember
    List<CustomerWebOrder>? Orders;

    CustomerOrderFulfillmentResponse({this.WebOrder,this.CustomerName,this.DateTime,this.Items,this.Orders});
    CustomerOrderFulfillmentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        WebOrder = json['WebOrder'];
        CustomerName = json['CustomerName'];
        DateTime = JsonConverters.fromJson(json['DateTime'],'DateTime',context!);
        Items = JsonConverters.fromJson(json['Items'],'List<CustomerOrderItem>',context!);
        Orders = JsonConverters.fromJson(json['Orders'],'List<CustomerWebOrder>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'WebOrder': WebOrder,
        'CustomerName': CustomerName,
        'DateTime': JsonConverters.toJson(DateTime,'DateTime',context!),
        'Items': JsonConverters.toJson(Items,'List<CustomerOrderItem>',context!),
        'Orders': JsonConverters.toJson(Orders,'List<CustomerWebOrder>',context!)
    });

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

/**
* CustomerOrderFulfillmentRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
class CustomerOrderFulfillmentRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * Pass in if only looking for one weborder. Otherwise do not pass in.
    */
    // @DataMember
    // @ApiMember(Description="Pass in if only looking for one weborder. Otherwise do not pass in.", Name="WebOrder", ParameterType="query")
    String? WebOrder;

    /**
    * Starting offset for Pagination. Defaults to 0.
    */
    // @DataMember
    // @ApiMember(Description="Starting offset for Pagination. Defaults to 0.", Name="StartOffset", ParameterType="query")
    int? StartOffset;

    /**
    * Records to be returned. Default to 100.
    */
    // @DataMember
    // @ApiMember(Description="Records to be returned. Default to 100.", Name="RecordCount", ParameterType="query")
    int? RecordCount;

    /**
    * If sent, fully picked orders will not be returned.
    */
    // @DataMember
    // @ApiMember(Description="If sent, fully picked orders will not be returned.", Name="ExcludeFullyPickedOrders", ParameterType="query")
    bool? ExcludeFullyPickedOrders;

    CustomerOrderFulfillmentRequest({this.WebOrder,this.StartOffset,this.RecordCount,this.ExcludeFullyPickedOrders});
    CustomerOrderFulfillmentRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        WebOrder = json['WebOrder'];
        StartOffset = json['StartOffset'];
        RecordCount = json['RecordCount'];
        ExcludeFullyPickedOrders = json['ExcludeFullyPickedOrders'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'WebOrder': WebOrder,
        'StartOffset': StartOffset,
        'RecordCount': RecordCount,
        'ExcludeFullyPickedOrders': ExcludeFullyPickedOrders
    });

    getTypeName() => "CustomerOrderFulfillmentRequest";
    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()),
    'CustomerOrderItem': TypeInfo(TypeOf.Class, create:() => CustomerOrderItem()),
    'CustomerWebOrder': TypeInfo(TypeOf.Class, create:() => CustomerWebOrder()),
    'List<CustomerOrderItem>': TypeInfo(TypeOf.Class, create:() => <CustomerOrderItem>[]),
    'CustomerOrderFulfillmentResponse': TypeInfo(TypeOf.Class, create:() => CustomerOrderFulfillmentResponse()),
    'List<CustomerWebOrder>': TypeInfo(TypeOf.Class, create:() => <CustomerWebOrder>[]),
    'CustomerOrderFulfillmentRequest': TypeInfo(TypeOf.Class, create:() => CustomerOrderFulfillmentRequest()),
});

Dart CustomerOrderFulfillmentRequest 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/CustomerOrderFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<CustomerOrderFulfillmentResponse 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>
  <CustomerName>String</CustomerName>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <Items>
    <CustomerOrderItem>
      <Description>String</Description>
      <Id>0</Id>
      <Item>String</Item>
      <Price>0</Price>
      <Quantity>0</Quantity>
      <QuantityPicked>0</QuantityPicked>
    </CustomerOrderItem>
  </Items>
  <Orders>
    <CustomerWebOrder>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <Items>
        <CustomerOrderItem>
          <Description>String</Description>
          <Id>0</Id>
          <Item>String</Item>
          <Price>0</Price>
          <Quantity>0</Quantity>
          <QuantityPicked>0</QuantityPicked>
        </CustomerOrderItem>
      </Items>
      <WebOrder>String</WebOrder>
    </CustomerWebOrder>
  </Orders>
  <WebOrder>String</WebOrder>
</CustomerOrderFulfillmentResponse>