| POST, GET | /api/SearchInventory |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* SearchInventoryRequires active-e Inventory Service
*/
@DataContract
open class SearchInventoryRequest : BaseSecureRequest()
{
/**
* If sent, only items from the passed location will be returned
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only items from the passed location will be returned", Format="int32", Name="LocFk")
open var LocFk:Int? = null
/**
* For Internal Use Only
*/
@DataMember
@ApiMember(DataType="integer", Description="For Internal Use Only", Format="int32", Name="MfgFk")
open var MfgFk:Int? = null
/**
* For Internal Use Only
*/
@DataMember
@ApiMember(DataType="integer", Description="For Internal Use Only", Format="int32", Name="CatFk")
open var CatFk:Int? = null
/**
* For Internal Use Only
*/
@DataMember
@ApiMember(DataType="integer", Description="For Internal Use Only", Format="int32", Name="SubFk")
open var SubFk:Int? = null
/**
* For Internal Use Only
*/
@DataMember
@ApiMember(DataType="integer", Description="For Internal Use Only", Format="int32", Name="SelFk")
open var SelFk:Int? = null
/**
* If sent, only items from the passed category# will be returned
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only items from the passed category# will be returned", Format="int32", Name="Cat")
open var Cat:Int? = null
/**
* If sent, only items from the passed subcategory# will be returned. Must be used in conjunction with the Cat parameter.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only items from the passed subcategory# will be returned. Must be used in conjunction with the Cat parameter.", Format="int32", Name="Sub")
open var Sub:Int? = null
/**
* If sent, only items with the passed selection code will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items with the passed selection code will be returned", Name="SelectionCode")
open var SelectionCode:String? = null
/**
* If sent, only items with the passed mfg code will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items with the passed mfg code will be returned", Name="Mfg")
open var Mfg:String? = null
/**
* Serialized Items will be included in the search results
*/
@DataMember
@ApiMember(DataType="boolean", Description="Serialized Items will be included in the search results", Name="IncludeSerials")
open var IncludeSerials:Boolean? = null
/**
* Media Items will be included in the search results
*/
@DataMember
@ApiMember(DataType="boolean", Description="Media Items will be included in the search results", Name="IncludeMedia")
open var IncludeMedia:Boolean? = null
/**
* Non-Serialized, Non-Media Items will be included in the search results
*/
@DataMember
@ApiMember(DataType="boolean", Description="Non-Serialized, Non-Media Items will be included in the search results", Name="IncludeAccessories")
open var IncludeAccessories:Boolean? = null
/**
* Package Deal Items will be included in the search results
*/
@DataMember
@ApiMember(DataType="boolean", Description="Package Deal Items will be included in the search results", Name="IncludePackages")
open var IncludePackages:Boolean? = null
/**
* The string to be searched for
*/
@DataMember
@ApiMember(Description="The string to be searched for", Name="SearchStr")
open var SearchStr:String? = null
/**
* If set, only items with the exact model contained in the search string will be returned
*/
@DataMember
@ApiMember(DataType="boolean", Description="If set, only items with the exact model contained in the search string will be returned", Name="ExactModel")
open var ExactModel:Boolean? = null
/**
* The Starting Offse
*/
@DataMember
@ApiMember(DataType="integer", Description="The Starting Offse", Format="int64", Name="StartOffset")
open var StartOffset:Long? = null
/**
* The # of records to be returned
*/
@DataMember
@ApiMember(DataType="integer", Description="The # of records to be returned", Format="int64", Name="RecordCount")
open var RecordCount:Long? = null
/**
* If set, Icon Image Urls will be included in the result, if available
*/
@DataMember
@ApiMember(DataType="boolean", Description="If set, Icon Image Urls will be included in the result, if available", Name="IncludeIconImage")
open var IncludeIconImage:Boolean? = null
/**
* If sent, only items from the passed category IDs will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items from the passed category IDs will be returned", Name="CatIdList")
open var CatIdList:ArrayList<Long>? = null
/**
* If sent, only items from the passed subcategory IDs will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items from the passed subcategory IDs will be returned", Name="SubIdList")
open var SubIdList:ArrayList<Long>? = null
/**
* If sent, only items from the passed mfg IDs will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items from the passed mfg IDs will be returned", Name="MfgIdList")
open var MfgIdList:ArrayList<Long>? = null
/**
* If sent, only items from the passed selection code IDs will be returned
*/
@DataMember
@ApiMember(Description="If sent, only items from the passed selection code IDs will be returned", Name="SelIdList")
open var SelIdList:ArrayList<Long>? = null
/**
* Deleted Items will be included in the search results
*/
@DataMember
@ApiMember(DataType="boolean", Description="Deleted Items will be included in the search results", Name="IncludeDeleted")
open var IncludeDeleted:Boolean? = null
/**
* If sent, only inventory changed on or after this date/time will be included
*/
@DataMember
@ApiMember(DataType="string", Description="If sent, only inventory changed on or after this date/time will be included", Format="date", Name="ChangedDate", ParameterType="query")
open var ChangedDate:Date? = null
/**
* Package Deal Line Items will be included
*/
@DataMember
@ApiMember(DataType="boolean", Description="Package Deal Line Items will be included", Name="IncludePackageLineItems")
open var IncludePackageLineItems:Boolean? = null
/**
* If set, the InventoryDetails object for each item will also be returned. This is much slower.
*/
@DataMember
@ApiMember(DataType="boolean", Description="If set, the InventoryDetails object for each item will also be returned. This is much slower.", Name="IncludeDetails")
open var IncludeDetails:Boolean? = null
/**
* If set, the InventoryDetails object for each item include images. This is much slower and only works with the IncludeDetails parameter.
*/
@DataMember
@ApiMember(DataType="boolean", Description="If set, the InventoryDetails object for each item include images. This is much slower and only works with the IncludeDetails parameter.", Name="IncludeDetails")
open var IncludeImages:Boolean? = null
/**
* If sent, only items with an Available Quantity greater then or equal to the sent value will be returned. Use of this parameter requires that the LocFk parameter also be sent.
*/
@DataMember
@ApiMember(DataType="integer", Description="If sent, only items with an Available Quantity greater then or equal to the sent value will be returned. Use of this parameter requires that the LocFk parameter also be sent.", Format="int32", Name="MinimumAvailableQuantity")
open var MinimumAvailableQuantity:Int? = 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 SearchInventoryResponse : BaseResponse()
{
@DataMember
open var StartOffset:Long? = null
@DataMember
open var RecordCount:Long? = null
@DataMember
open var RemainingRecords:Long? = null
@DataMember
open var TotalRecords:Long? = null
@DataMember
@ApiMember(Name="Records", ParameterType="body")
open var Records:ArrayList<SearchInventoryApiResult>? = 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 SearchInventoryApiResult : SearchInventoryResultSet()
{
@DataMember
open var Detail:InventoryDetailResponse? = null
@DataMember
open var IconImage:ImageInfo? = null
@DataMember
open var CustomerPrice:BigDecimal? = null
}
@DataContract
open class SearchInventoryResultSet : BindableObject(), IAIMInventoryRecord
{
@DataMember
open var Pk:Long? = null
@DataMember
open var Description:String? = null
@DataMember
open var InventoryType:String? = null
@DataMember
open var Manufacturer:String? = null
@DataMember
open var Model:String? = null
@DataMember
open var Category:BigDecimal? = null
@DataMember
open var CategoryDescription:String? = null
@DataMember
open var SubCategory:BigDecimal? = null
@DataMember
open var SubCategoryDescription:String? = null
@DataMember
open var SelectionCode:String? = null
@DataMember
open var SelectionCodeDescription:String? = null
@DataMember
open var Sku:String? = null
@DataMember
open var Mpn:String? = null
@DataMember
open var Discontinued:Boolean? = null
@DataMember
open var Attribute1:String? = null
@DataMember
open var Attribute2:String? = null
@DataMember
open var Attribute3:String? = null
@DataMember
open var Attribute4:String? = null
@DataMember
open var Attribute5:String? = null
@DataMember
open var Attribute6:String? = null
@DataMember
open var Attribute7:String? = null
@DataMember
open var Attribute8:String? = null
@DataMember
open var Attribute9:String? = null
@DataMember
open var Attribute10:String? = null
@DataMember
open var Attribute11:String? = null
@DataMember
open var Attribute12:String? = null
@DataMember
open var Attribute13:String? = null
@DataMember
open var Attribute14:String? = null
@DataMember
open var Attribute15:String? = null
@DataMember
open var Attribute16:String? = null
@DataMember
open var Attribute17:String? = null
@DataMember
open var Attribute18:String? = null
@DataMember
open var Attribute19:String? = null
@DataMember
open var Attribute20:String? = null
@DataMember
open var ComputerQuantity:BigDecimal? = null
@DataMember
open var OurPrice:BigDecimal? = null
@DataMember
open var RetailPrice:BigDecimal? = null
@DataMember
open var ActiveePrice:BigDecimal? = 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 AvailableQuantity:BigDecimal? = null
@DataMember
open var IsMedia:Boolean? = null
@DataMember
open var IsPackage:Boolean? = null
@DataMember
open var HasImage:Boolean? = null
@DataMember
open var SearchTerm:String? = null
@DataMember
open var Keywords:String? = null
@DataMember
open var KeywordsOrigin:String? = null
@DataMember
open var Deleted:Boolean? = null
@DataMember
open var TimeStamp:Date? = null
}
@DataContract
open class BindableObject
{
}
@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 SearchInventoryRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/SearchInventory HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"LocFk":0,"MfgFk":0,"CatFk":0,"SubFk":0,"SelFk":0,"Cat":0,"Sub":0,"SelectionCode":"String","Mfg":"String","IncludeSerials":false,"IncludeMedia":false,"IncludeAccessories":false,"IncludePackages":false,"SearchStr":"String","ExactModel":false,"StartOffset":0,"RecordCount":0,"IncludeIconImage":false,"CatIdList":[0],"SubIdList":[0],"MfgIdList":[0],"SelIdList":[0],"IncludeDeleted":false,"ChangedDate":"0001-01-01T00:00:00.0000000","IncludePackageLineItems":false,"IncludeDetails":false,"IncludeImages":false,"MinimumAvailableQuantity":0,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"StartOffset":0,"RecordCount":0,"RemainingRecords":0,"TotalRecords":0,"Records":[{"Detail":{"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"}},"IconImage":{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0},"CustomerPrice":0,"Pk":0,"Description":"String","InventoryType":"String","Manufacturer":"String","Model":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","SelectionCode":"String","SelectionCodeDescription":"String","Sku":"String","Mpn":"String","Discontinued":false,"Attribute1":"String","Attribute2":"String","Attribute3":"String","Attribute4":"String","Attribute5":"String","Attribute6":"String","Attribute7":"String","Attribute8":"String","Attribute9":"String","Attribute10":"String","Attribute11":"String","Attribute12":"String","Attribute13":"String","Attribute14":"String","Attribute15":"String","Attribute16":"String","Attribute17":"String","Attribute18":"String","Attribute19":"String","Attribute20":"String","ComputerQuantity":0,"OurPrice":0,"RetailPrice":0,"ActiveePrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"MinPrice":0,"AvailableQuantity":0,"IsMedia":false,"IsPackage":false,"HasImage":false,"SearchTerm":"String","Keywords":"String","KeywordsOrigin":"String","Deleted":false,"PackageLineItems":[{"Model":"String","Cat":0,"Sub":0,"Description":"String","Quantity":0,"Amount":0,"Discount":0,"ItemType":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}