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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* InventoryHistoryRequires active-e Inventory Service
*/
@DataContract
open class InventoryHistoryRequest : BaseSecureRequest()
{
    @DataMember
    open var LocId:Long? = null

    @DataMember
    open var Item:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class InventoryHistoryResponse : BaseResponse()
{
    @DataMember
    @ApiMember(Name="HistoryRecords", ParameterType="body")
    open var HistoryRecords:ArrayList<InventoryHistoryObj>? = null

    @DataMember
    @ApiMember(Name="InventoryDetail", ParameterType="body")
    open var InventoryDetail:InventoryDetailResponse? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class InventoryHistoryObj
{
    @DataMember
    open var DateVal:Date? = null

    @DataMember
    open var SDateVal:Date? = null

    @DataMember
    open var Acct:Int? = null

    @DataMember
    open var Sub:Int? = null

    @DataMember
    open var CusName:String? = null

    @DataMember
    open var Qty:BigDecimal? = null

    @DataMember
    open var Amt:BigDecimal? = null

    @DataMember
    open var Ref:String? = null

    @DataMember
    open var Type:String? = null

    @DataMember
    open var Serial:String? = null

    @DataMember
    open var Employee:String? = null

    @DataMember
    open var EmployeeName:String? = null

    @DataMember
    open var Stloc:String? = null

    @DataMember
    open var Dunn:String? = null

    @DataMember
    open var SoldDesc:String? = null

    @DataMember
    open var Tcp_rtncode:String? = null

    @DataMember
    open var TableName:String? = null

    @DataMember
    open var TraPk:Long? = null

    @DataMember
    open var CusPk:Long? = null

    @DataMember
    open var SasPk:Long? = null

    @DataMember
    open var SaqPk:Long? = null

    @DataMember
    open var SkuPk:Long? = null

    @DataMember
    open var SadPk:Long? = null

    @DataMember
    open var TablePk:Long? = null

    @DataMember
    open var Description:String? = null
}

@DataContract
open class InventoryDetailResponse : BaseResponse()
{
    @DataMember
    open var SadPk:Long? = null

    @DataMember
    open var InvType:String? = null

    @DataMember
    open var Model:String? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Mfg:String? = null

    @DataMember
    open var Category:Int? = null

    @DataMember
    open var CategoryDescription:String? = null

    @DataMember
    open var SubCategory:Int? = null

    @DataMember
    open var SubCategoryDescription:String? = null

    @DataMember
    open var SelectionCode:String? = null

    @DataMember
    open var SelectionCodeDescription:String? = null

    @DataMember
    open var SellSerialsOnline:Boolean? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Images:ArrayList<ImageInfo>? = null

    @DataMember
    open var HasImages:Boolean? = null

    @DataMember
    open var VariantDetails:ArrayList<InventoryDetailByVariant>? = null

    @DataMember
    open var AddOns:ArrayList<AddOnDetail>? = null

    @DataMember
    open var ActiveEInfo:ActiveEInfo? = null

    @DataMember
    open var Weight:BigDecimal? = null

    @DataMember
    open var Unit:String? = null

    @DataMember
    open var ShipCharge:BigDecimal? = null
}

@DataContract
open class ImageInfo
{
    @DataMember
    open var Url:String? = null

    @DataMember
    open var ImageStream:String? = null

    @DataMember
    open var ImageSize:String? = null

    @DataMember
    open var ErrorMessage:String? = null

    @DataMember
    open var UriPk:Long? = null
}

@DataContract
open class InventoryDetailByVariant
{
    @DataMember
    open var SkuPk:Long? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var VendorCost:BigDecimal? = null

    @DataMember
    open var VendorName:String? = null

    @DataMember
    open var Attributes:ArrayList<InventoryDetailAttribute>? = null

    @DataMember
    open var LocationDetails:ArrayList<InventoryDetailByLocation>? = null

    @DataMember
    open var Images:ArrayList<ImageInfo>? = null

    @DataMember
    open var HasImages:Boolean? = null

    @DataMember
    open var Barcodes:ArrayList<String>? = null
}

@DataContract
open class InventoryDetailAttribute
{
    @DataMember
    open var Name:String? = null

    @DataMember
    open var Value:String? = null

    @DataMember
    open var Priority:Int? = null

    /**
    * 1 is 'Don't Send to Web', 2 is 'Send To Web'
    */
    @DataMember
    @ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Send To Web'", Name="WebType", ParameterType="query")
    open var WebType:Int? = null
}

@DataContract
open class InventoryDetailByLocation
{
    @DataMember
    open var SaqPk:Long? = null

    @DataMember
    open var LocationInfo:LocationInfo? = null

    @DataMember
    open var Serials:ArrayList<InventoryDetailBySerial>? = null

    @DataMember
    open var Substitutes:ArrayList<InventoryDetailSubstitute>? = null

    @DataMember
    open var Retail:BigDecimal? = null

    @DataMember
    open var OurPrice:BigDecimal? = null

    @DataMember
    open var SalePrice:BigDecimal? = null

    @DataMember
    open var SaleInfo:String? = null

    @DataMember
    open var PriceA:BigDecimal? = null

    @DataMember
    open var PriceB:BigDecimal? = null

    @DataMember
    open var PriceC:BigDecimal? = null

    @DataMember
    open var MinPrice:BigDecimal? = null

    @DataMember
    open var ActiveEPrice:BigDecimal? = null

    @DataMember
    open var CustomerPrice:BigDecimal? = null

    @DataMember
    open var AllowPriceChange:Boolean? = null

    @DataMember
    open var Qty:BigDecimal? = null

    @DataMember
    open var QtyAvail:BigDecimal? = null

    @DataMember
    open var ActiveeHoldbackQty:BigDecimal? = null

    @DataMember
    open var ReorderMin:Int? = null

    @DataMember
    open var ReorderMax:Int? = null

    @DataMember
    open var AverageCost:BigDecimal? = null

    @DataMember
    open var WeightedCost:BigDecimal? = null

    @DataMember
    open var Locator:String? = null

    @DataMember
    open var SelectionCode:String? = null

    @DataMember
    open var SelectionCodeDescription:String? = null

    @DataMember
    open var Spiff:BigDecimal? = null

    @DataMember
    open var CurrentSpotCheckQty:BigDecimal? = null

    @DataMember
    open var QtyOut:BigDecimal? = null

    @DataMember
    open var QtyOnOrder:BigDecimal? = null

    @DataMember
    open var AvailableForSTR:BigDecimal? = null

    @DataMember
    open var AEPricingLocation:Boolean? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    open var Id:Long? = null

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null

    @DataMember
    open var Region:String? = null

    @DataMember
    open var Latitude:BigDecimal? = null

    @DataMember
    open var Longitude:BigDecimal? = null

    @DataMember
    open var InStorePickup:String? = null

    @DataMember
    open var Active:Boolean? = null

    @DataMember
    open var CashSaleAcct:Int? = null
}

@DataContract
open class InventoryDetailBySerial
{
    @DataMember
    open var SasPk:Long? = null

    @DataMember
    open var Serial:String? = null

    @DataMember
    open var Retail:BigDecimal? = null

    @DataMember
    open var OurPrice:BigDecimal? = null

    @DataMember
    open var SalePrice:BigDecimal? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var SaleInfo:String? = null

    @DataMember
    open var PriceA:BigDecimal? = null

    @DataMember
    open var PriceB:BigDecimal? = null

    @DataMember
    open var PriceC:BigDecimal? = null

    @DataMember
    open var MinPrice:BigDecimal? = null

    @DataMember
    open var ActiveEPrice:BigDecimal? = null

    @DataMember
    open var AllowPriceChange:Boolean? = null

    @DataMember
    open var Cost:BigDecimal? = null

    @DataMember
    open var WeightedCost:BigDecimal? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Attributes:ArrayList<InventoryDetailAttribute>? = null

    @DataMember
    open var Images:ArrayList<ImageInfo>? = null

    @DataMember
    open var HasImages:Boolean? = null

    @DataMember
    open var IsActiveeHoldback:Boolean? = null

    @DataMember
    open var CustomerAcct:Int? = null

    @DataMember
    open var AvailableForSTR:Boolean? = null
}

@DataContract
open class InventoryDetailSubstitute
{
    @DataMember
    open var Model:String? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var Mfg:String? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var AvailableQty:BigDecimal? = null
}

@DataContract
open class AddOnDetail
{
    @DataMember
    open var SadPk:Long? = null

    @DataMember
    open var SkuPk:Long? = null

    @DataMember
    open var CatPk:Long? = null

    @DataMember
    open var SubPk:Long? = null

    @DataMember
    open var Item:String? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Price:BigDecimal? = null
}

@DataContract
open class ActiveEInfo
{
    @DataMember
    open var ExtPk:Long? = null

    @DataMember
    open var Dimension:String? = null

    @DataMember
    open var WebDescription:String? = null

    @DataMember
    open var Summary:String? = null

    @DataMember
    open var SETitle:String? = null

    @DataMember
    open var SEDescription:String? = null

    @DataMember
    open var SEKeywords:String? = null

    @DataMember
    open var SEAltText:String? = null

    @DataMember
    open var SEHtmlFreeText:String? = null

    @DataMember
    open var Unpublished:Boolean? = null

    @DataMember
    open var FreeShipping:Boolean? = null

    @DataMember
    open var IsFeatured:Boolean? = null

    @DataMember
    open var WebCategoryIds:ArrayList<Long>? = null

    @DataMember
    open var HidePrice:Boolean? = null
}

Kotlin 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":{"ExtPk":0,"Dimension":"String","WebDescription":"String","Summary":"String","SETitle":"String","SEDescription":"String","SEKeywords":"String","SEAltText":"String","SEHtmlFreeText":"String","Unpublished":false,"FreeShipping":false,"IsFeatured":false,"WebCategoryIds":[0],"HidePrice":false},"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"}}