AIM Web Services

<back to all web services

InventoryHistoryRequest

InventoryHistory
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryHistory
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryHistoryObj() = 
        [<DataMember>]
        member val DateVal:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val SDateVal:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Acct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Sub:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CusName:String = null with get,set

        [<DataMember>]
        member val Qty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Amt:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val Employee:String = null with get,set

        [<DataMember>]
        member val EmployeeName:String = null with get,set

        [<DataMember>]
        member val Stloc:String = null with get,set

        [<DataMember>]
        member val Dunn:String = null with get,set

        [<DataMember>]
        member val SoldDesc:String = null with get,set

        [<DataMember>]
        member val Tcp_rtncode:String = null with get,set

        [<DataMember>]
        member val TableName:String = null with get,set

        [<DataMember>]
        member val TraPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val CusPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SasPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SaqPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SkuPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SadPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val TablePk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ImageInfo() = 
        [<DataMember>]
        member val Url:String = null with get,set

        [<DataMember>]
        member val ImageStream:String = null with get,set

        [<DataMember>]
        member val ImageSize:String = null with get,set

        [<DataMember>]
        member val ErrorMessage:String = null with get,set

        [<DataMember>]
        member val UriPk:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailAttribute() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Value:String = null with get,set

        [<DataMember>]
        member val Priority:Int32 = new Int32() with get,set

        ///<summary>
        ///1 is 'Don't Send to Web', 2 is 'Guided Navigation'
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Guided Navigation'", Name="WebType", ParameterType="query")>]
        member val WebType:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type LocationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ShortDesc:String = null with get,set

        [<DataMember>]
        member val Region:String = null with get,set

        [<DataMember>]
        member val Latitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Longitude:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val InStorePickup:String = null with get,set

        [<DataMember>]
        member val Active:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CashSaleAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailBySerial() = 
        [<DataMember>]
        member val SasPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val Retail:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OurPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SalePrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val SaleInfo:String = null with get,set

        [<DataMember>]
        member val PriceA:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceB:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceC:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MinPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ActiveEPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AllowPriceChange:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Cost:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val WeightedCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Attributes:ResizeArray<InventoryDetailAttribute> = new ResizeArray<InventoryDetailAttribute>() with get,set

        [<DataMember>]
        member val Images:ResizeArray<ImageInfo> = new ResizeArray<ImageInfo>() with get,set

        [<DataMember>]
        member val HasImages:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsActiveeHoldback:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val AvailableForSTR:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailSubstitute() = 
        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Mfg:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AvailableQty:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailByLocation() = 
        [<DataMember>]
        member val SaqPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val LocationInfo:LocationInfo = null with get,set

        [<DataMember>]
        member val Serials:ResizeArray<InventoryDetailBySerial> = new ResizeArray<InventoryDetailBySerial>() with get,set

        [<DataMember>]
        member val Substitutes:ResizeArray<InventoryDetailSubstitute> = new ResizeArray<InventoryDetailSubstitute>() with get,set

        [<DataMember>]
        member val Retail:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OurPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SalePrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val SaleInfo:String = null with get,set

        [<DataMember>]
        member val PriceA:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceB:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val PriceC:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val MinPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ActiveEPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CustomerPrice:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AllowPriceChange:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Qty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val QtyAvail:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ActiveeHoldbackQty:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ReorderMin:Int32 = new Int32() with get,set

        [<DataMember>]
        member val ReorderMax:Int32 = new Int32() with get,set

        [<DataMember>]
        member val AverageCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val WeightedCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Locator:String = null with get,set

        [<DataMember>]
        member val SelectionCode:String = null with get,set

        [<DataMember>]
        member val SelectionCodeDescription:String = null with get,set

        [<DataMember>]
        member val Spiff:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val CurrentSpotCheckQty:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val QtyOut:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val QtyOnOrder:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val AvailableForSTR:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailByVariant() = 
        [<DataMember>]
        member val SkuPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val VendorCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val VendorName:String = null with get,set

        [<DataMember>]
        member val Attributes:ResizeArray<InventoryDetailAttribute> = new ResizeArray<InventoryDetailAttribute>() with get,set

        [<DataMember>]
        member val LocationDetails:ResizeArray<InventoryDetailByLocation> = new ResizeArray<InventoryDetailByLocation>() with get,set

        [<DataMember>]
        member val Images:ResizeArray<ImageInfo> = new ResizeArray<ImageInfo>() with get,set

        [<DataMember>]
        member val HasImages:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Barcodes:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddOnDetail() = 
        [<DataMember>]
        member val SadPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val SkuPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val CatPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val SubPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ActiveEInfo() = 
        [<DataMember>]
        member val Dimension:String = null with get,set

        [<DataMember>]
        member val WebDescription:String = null with get,set

        [<DataMember>]
        member val Summary:String = null with get,set

        [<DataMember>]
        member val SETitle:String = null with get,set

        [<DataMember>]
        member val SEDescription:String = null with get,set

        [<DataMember>]
        member val SEKeywords:String = null with get,set

        [<DataMember>]
        member val SEAltText:String = null with get,set

        [<DataMember>]
        member val SEHtmlFreeText:String = null with get,set

        [<DataMember>]
        member val Unpublished:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val FreeShipping:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsFeatured:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val WebCategoryIds:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryDetailResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val SadPk:Int64 = new Int64() with get,set

        [<DataMember>]
        member val InvType:String = null with get,set

        [<DataMember>]
        member val Model:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Mfg:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryDescription:String = null with get,set

        [<DataMember>]
        member val SubCategory:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SubCategoryDescription:String = null with get,set

        [<DataMember>]
        member val SelectionCode:String = null with get,set

        [<DataMember>]
        member val SelectionCodeDescription:String = null with get,set

        [<DataMember>]
        member val SellSerialsOnline:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val Images:ResizeArray<ImageInfo> = new ResizeArray<ImageInfo>() with get,set

        [<DataMember>]
        member val HasImages:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val VariantDetails:ResizeArray<InventoryDetailByVariant> = new ResizeArray<InventoryDetailByVariant>() with get,set

        [<DataMember>]
        member val AddOns:ResizeArray<AddOnDetail> = new ResizeArray<AddOnDetail>() with get,set

        [<DataMember>]
        member val ActiveEInfo:ActiveEInfo = null with get,set

        [<DataMember>]
        member val Weight:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Unit:String = null with get,set

        [<DataMember>]
        member val ShipCharge:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryHistoryResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        [<ApiMember(Name="HistoryRecords", ParameterType="body")>]
        member val HistoryRecords:ResizeArray<InventoryHistoryObj> = new ResizeArray<InventoryHistoryObj>() with get,set

        [<DataMember>]
        [<ApiMember(Name="InventoryDetail", ParameterType="body")>]
        member val InventoryDetail:InventoryDetailResponse = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///InventoryHistoryRequires active-e Inventory Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryHistoryRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val LocId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Item:String = null with get,set

F# InventoryHistoryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/InventoryHistory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HistoryRecords":[{"Acct":0,"Sub":0,"CusName":"String","Qty":0,"Amt":0,"Ref":"String","Type":"String","Serial":"String","Employee":"String","EmployeeName":"String","Stloc":"String","Dunn":"String","SoldDesc":"String","Tcp_rtncode":"String","TableName":"String","TraPk":0,"CusPk":0,"SasPk":0,"SaqPk":0,"SkuPk":0,"SadPk":0,"TablePk":0,"Description":"String"}],"InventoryDetail":{"SadPk":0,"InvType":"String","Model":"String","Description":"String","Mfg":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","SelectionCode":"String","SelectionCodeDescription":"String","SellSerialsOnline":false,"Notes":"String","Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"HasImages":true,"VariantDetails":[{}],"AddOns":[{}],"ActiveEInfo":{"Dimension":"String","WebDescription":"String","Summary":"String","SETitle":"String","SEDescription":"String","SEKeywords":"String","SEAltText":"String","SEHtmlFreeText":"String","Unpublished":false,"FreeShipping":false,"IsFeatured":false,"WebCategoryIds":[0]},"Weight":0,"Unit":"String","ShipCharge":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}