AIM Web Services

<back to all web services

StockCheckRequest

StockCheck
Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce

The following routes are available for this service:
POST/api/StockCheck
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 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 StockCheckErrorItem implements IConvertible
{
    // @DataMember
    String? SKU;

    // @DataMember
    int? LocationId;

    // @DataMember
    String? SerialNumber;

    // @DataMember
    double? QtyRequested;

    // @DataMember
    String? Message;

    StockCheckErrorItem({this.SKU,this.LocationId,this.SerialNumber,this.QtyRequested,this.Message});
    StockCheckErrorItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SKU = json['SKU'];
        LocationId = json['LocationId'];
        SerialNumber = json['SerialNumber'];
        QtyRequested = JsonConverters.toDouble(json['QtyRequested']);
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SKU': SKU,
        'LocationId': LocationId,
        'SerialNumber': SerialNumber,
        'QtyRequested': QtyRequested,
        'Message': Message
    };

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

// @DataContract
class StockCheckResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    bool? EverythingAvailable;

    // @DataMember
    List<StockCheckErrorItem>? OutOfStockItems;

    StockCheckResponse({this.EverythingAvailable,this.OutOfStockItems});
    StockCheckResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        EverythingAvailable = json['EverythingAvailable'];
        OutOfStockItems = JsonConverters.fromJson(json['OutOfStockItems'],'List<StockCheckErrorItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'EverythingAvailable': EverythingAvailable,
        'OutOfStockItems': JsonConverters.toJson(OutOfStockItems,'List<StockCheckErrorItem>',context!)
    });

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

// @DataContract
class StockCheckItem implements IConvertible
{
    // @DataMember
    String? SKU;

    // @DataMember
    int? LocationId;

    // @DataMember
    String? SerialNumber;

    // @DataMember
    double? QtyRequested;

    StockCheckItem({this.SKU,this.LocationId,this.SerialNumber,this.QtyRequested});
    StockCheckItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SKU = json['SKU'];
        LocationId = json['LocationId'];
        SerialNumber = json['SerialNumber'];
        QtyRequested = JsonConverters.toDouble(json['QtyRequested']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SKU': SKU,
        'LocationId': LocationId,
        'SerialNumber': SerialNumber,
        'QtyRequested': QtyRequested
    };

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

/**
* StockCheckRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
// @DataContract
class StockCheckRequest extends BaseRequest implements IConvertible
{
    // @DataMember
    List<StockCheckItem>? Items;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Items': JsonConverters.toJson(Items,'List<StockCheckItem>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'StockCheckErrorItem': TypeInfo(TypeOf.Class, create:() => StockCheckErrorItem()),
    'StockCheckResponse': TypeInfo(TypeOf.Class, create:() => StockCheckResponse()),
    'List<StockCheckErrorItem>': TypeInfo(TypeOf.Class, create:() => <StockCheckErrorItem>[]),
    'StockCheckItem': TypeInfo(TypeOf.Class, create:() => StockCheckItem()),
    'StockCheckRequest': TypeInfo(TypeOf.Class, create:() => StockCheckRequest()),
    'List<StockCheckItem>': TypeInfo(TypeOf.Class, create:() => <StockCheckItem>[]),
});

Dart StockCheckRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/StockCheck HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Items":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0}],"ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"EverythingAvailable":false,"OutOfStockItems":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0,"Message":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}