AIM Web Services

<back to all web services

InventoryQtyRequest

InventoryQty
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, GET/api/InventoryQty
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 LocationInfo implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Desc;

    // @DataMember
    String? ShortDesc;

    // @DataMember
    String? Region;

    // @DataMember
    double? Latitude;

    // @DataMember
    double? Longitude;

    // @DataMember
    String? InStorePickup;

    // @DataMember
    bool? Active;

    // @DataMember
    int? CashSaleAcct;

    LocationInfo({this.Id,this.Desc,this.ShortDesc,this.Region,this.Latitude,this.Longitude,this.InStorePickup,this.Active,this.CashSaleAcct});
    LocationInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Desc = json['Desc'];
        ShortDesc = json['ShortDesc'];
        Region = json['Region'];
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        InStorePickup = json['InStorePickup'];
        Active = json['Active'];
        CashSaleAcct = json['CashSaleAcct'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Desc': Desc,
        'ShortDesc': ShortDesc,
        'Region': Region,
        'Latitude': Latitude,
        'Longitude': Longitude,
        'InStorePickup': InStorePickup,
        'Active': Active,
        'CashSaleAcct': CashSaleAcct
    };

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

// @DataContract
class InventoryQtyByLocation implements IConvertible
{
    // @DataMember
    LocationInfo? LocationInfo;

    // @DataMember
    double? QtyAvail;

    InventoryQtyByLocation({this.LocationInfo,this.QtyAvail});
    InventoryQtyByLocation.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

    // @DataMember
    String? AeVariantName;

    // @DataMember
    List<InventoryQtyByLocation>? Locations;

    InventoryQtyByVariant({this.Sku,this.AeVariantName,this.Locations});
    InventoryQtyByVariant.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Sku = json['Sku'];
        AeVariantName = json['AeVariantName'];
        Locations = JsonConverters.fromJson(json['Locations'],'List<InventoryQtyByLocation>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Sku': Sku,
        'AeVariantName': AeVariantName,
        'Locations': JsonConverters.toJson(Locations,'List<InventoryQtyByLocation>',context!)
    };

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

// @DataContract
class InventoryQtyResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<InventoryQtyByVariant>? Variants;

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

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

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

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

/**
* InventoryQtyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
// @DataContract
class InventoryQtyRequest extends BaseRequest implements IConvertible
{
    // @DataMember
    int? Pk;

    // @DataMember
    String? Model;

    // @DataMember
    String? AeId;

    // @DataMember
    int? SkuPk;

    // @DataMember
    String? Sku;

    // @DataMember
    bool? SendVendorQtyAsSeperateLocation;

    InventoryQtyRequest({this.Pk,this.Model,this.AeId,this.SkuPk,this.Sku,this.SendVendorQtyAsSeperateLocation});
    InventoryQtyRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Pk = json['Pk'];
        Model = json['Model'];
        AeId = json['AeId'];
        SkuPk = json['SkuPk'];
        Sku = json['Sku'];
        SendVendorQtyAsSeperateLocation = json['SendVendorQtyAsSeperateLocation'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Pk': Pk,
        'Model': Model,
        'AeId': AeId,
        'SkuPk': SkuPk,
        'Sku': Sku,
        'SendVendorQtyAsSeperateLocation': SendVendorQtyAsSeperateLocation
    });

    getTypeName() => "InventoryQtyRequest";
    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()),
    'LocationInfo': TypeInfo(TypeOf.Class, create:() => LocationInfo()),
    'InventoryQtyByLocation': TypeInfo(TypeOf.Class, create:() => InventoryQtyByLocation()),
    'InventoryQtyByVariant': TypeInfo(TypeOf.Class, create:() => InventoryQtyByVariant()),
    'List<InventoryQtyByLocation>': TypeInfo(TypeOf.Class, create:() => <InventoryQtyByLocation>[]),
    'InventoryQtyResponse': TypeInfo(TypeOf.Class, create:() => InventoryQtyResponse()),
    'List<InventoryQtyByVariant>': TypeInfo(TypeOf.Class, create:() => <InventoryQtyByVariant>[]),
    'InventoryQtyRequest': TypeInfo(TypeOf.Class, create:() => InventoryQtyRequest()),
});

Dart InventoryQtyRequest 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/InventoryQty HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Pk":0,"Model":"String","AeId":"String","SkuPk":0,"Sku":"String","SendVendorQtyAsSeperateLocation":false,"ApiKey":"String","OAuthToken":"String"}

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

{"Variants":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}