| POST, GET | /api/SearchInventory |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocFk | body | integer | No | If sent, only items from the passed location will be returned |
| MfgFk | body | integer | No | For Internal Use Only |
| CatFk | body | integer | No | For Internal Use Only |
| SubFk | body | integer | No | For Internal Use Only |
| SelFk | body | integer | No | For Internal Use Only |
| Cat | body | integer | No | If sent, only items from the passed category# will be returned |
| Sub | body | integer | No | If sent, only items from the passed subcategory# will be returned. Must be used in conjunction with the Cat parameter. |
| SelectionCode | body | string | No | If sent, only items with the passed selection code will be returned |
| Mfg | body | string | No | If sent, only items with the passed mfg code will be returned |
| IncludeSerials | body | boolean | No | Serialized Items will be included in the search results |
| IncludeMedia | body | boolean | No | Media Items will be included in the search results |
| IncludeAccessories | body | boolean | No | Non-Serialized, Non-Media Items will be included in the search results |
| IncludePackages | body | boolean | No | Package Deal Items will be included in the search results |
| SearchStr | body | string | No | The string to be searched for |
| ExactModel | body | boolean | No | If set, only items with the exact model contained in the search string will be returned |
| StartOffset | body | integer | No | The Starting Offse |
| RecordCount | body | integer | No | The # of records to be returned |
| IncludeIconImage | body | boolean | No | If set, Icon Image Urls will be included in the result, if available |
| CatIdList | body | List<long> | No | If sent, only items from the passed category IDs will be returned |
| SubIdList | body | List<long> | No | If sent, only items from the passed subcategory IDs will be returned |
| MfgIdList | body | List<long> | No | If sent, only items from the passed mfg IDs will be returned |
| SelIdList | body | List<long> | No | If sent, only items from the passed selection code IDs will be returned |
| IncludeDeleted | body | boolean | No | Deleted Items will be included in the search results |
| ChangedDate | query | string | No | If sent, only inventory changed on or after this date/time will be included |
| IncludePackageLineItems | body | boolean | No | Package Deal Line Items will be included |
| IncludeDetails | body | boolean | No | If set, the InventoryDetails object for each item will also be returned. This is much slower. |
| MinimumAvailableQuantity | body | integer | No | 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartOffset | form | long | No | |
| RecordCount | form | long | No | |
| RemainingRecords | form | long | No | |
| TotalRecords | form | long | No | |
| Records | body | List<SearchInventoryApiResult> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Detail | form | InventoryDetail | No | |
| IconImage | form | ImageInfo | No | |
| CustomerPrice | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Pk | form | long | No | |
| Description | form | string | No | |
| InventoryType | form | string | No | |
| Manufacturer | form | string | No | |
| Model | form | string | No | |
| Category | form | decimal? | No | |
| CategoryDescription | form | string | No | |
| SubCategory | form | decimal? | No | |
| SubCategoryDescription | form | string | No | |
| SelectionCode | form | string | No | |
| SelectionCodeDescription | form | string | No | |
| Sku | form | string | No | |
| Discontinued | form | bool? | No | |
| Attribute1 | form | string | No | |
| Attribute2 | form | string | No | |
| Attribute3 | form | string | No | |
| Attribute4 | form | string | No | |
| Attribute5 | form | string | No | |
| Attribute6 | form | string | No | |
| Attribute7 | form | string | No | |
| Attribute8 | form | string | No | |
| Attribute9 | form | string | No | |
| Attribute10 | form | string | No | |
| Attribute11 | form | string | No | |
| Attribute12 | form | string | No | |
| Attribute13 | form | string | No | |
| Attribute14 | form | string | No | |
| Attribute15 | form | string | No | |
| Attribute16 | form | string | No | |
| Attribute17 | form | string | No | |
| Attribute18 | form | string | No | |
| Attribute19 | form | string | No | |
| Attribute20 | form | string | No | |
| ComputerQuantity | form | decimal | No | |
| OurPrice | form | decimal | No | |
| RetailPrice | form | decimal | No | |
| ActiveePrice | form | decimal | No | |
| PriceA | form | decimal | No | |
| PriceB | form | decimal | No | |
| PriceC | form | decimal | No | |
| MinPrice | form | decimal | No | |
| AvailableQuantity | form | decimal | No | |
| IsMedia | form | bool | No | |
| IsPackage | form | bool | No | |
| HasImage | form | bool | No | |
| SearchTerm | form | string | No | |
| Keywords | form | string | No | |
| KeywordsOrigin | form | string | No | |
| Deleted | form | bool | No | |
| TimeStamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SadPk | form | long | No | |
| InvType | form | string | No | |
| Model | form | string | No | |
| Description | form | string | No | |
| Mfg | form | string | No | |
| Category | form | int | No | |
| CategoryDescription | form | string | No | |
| SubCategory | form | int | No | |
| SubCategoryDescription | form | string | No | |
| SelectionCode | form | string | No | |
| SelectionCodeDescription | form | string | No | |
| SellSerialsOnline | form | bool | No | |
| Notes | form | string | No | |
| Images | form | List<ImageInfo> | No | |
| HasImages | form | bool | No | |
| VariantDetails | form | List<InventoryDetailByVariant> | No | |
| AddOns | form | List<AddOnDetail> | No | |
| ActiveEInfo | form | ActiveEInfo | No | |
| Weight | form | decimal | No | |
| Unit | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| ImageStream | form | string | No | |
| ImageSize | form | string | No | |
| ErrorMessage | form | string | No | |
| UriPk | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SkuPk | form | long | No | |
| Sku | form | string | No | |
| VendorCost | form | decimal? | No | |
| VendorName | form | string | No | |
| Attributes | form | List<InventoryDetailAttribute> | No | |
| LocationDetails | form | List<InventoryDetailByLocation> | No | |
| Images | form | List<ImageInfo> | No | |
| HasImages | form | bool | No | |
| Barcodes | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No | |
| Priority | form | int | No | |
| WebType | query | int | No | 1 is 'Don't Send to Web', 2 is 'Guided Navigation' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SaqPk | form | long | No | |
| LocationInfo | form | LocationInfo | No | |
| Serials | form | List<InventoryDetailBySerial> | No | |
| Substitutes | form | List<InventoryDetailSubstitute> | No | |
| Retail | form | decimal | No | |
| OurPrice | form | decimal | No | |
| SalePrice | form | decimal? | No | |
| SaleInfo | form | string | No | |
| PriceA | form | decimal | No | |
| PriceB | form | decimal | No | |
| PriceC | form | decimal | No | |
| MinPrice | form | decimal | No | |
| CustomerPrice | form | decimal | No | |
| AllowPriceChange | form | bool | No | |
| Qty | form | decimal | No | |
| QtyAvail | form | decimal | No | |
| ActiveeHoldbackQty | form | decimal | No | |
| ReorderMin | form | int | No | |
| ReorderMax | form | int | No | |
| AverageCost | form | decimal? | No | |
| WeightedCost | form | decimal? | No | |
| Locator | form | string | No | |
| SelectionCode | form | string | No | |
| SelectionCodeDescription | form | string | No | |
| Spiff | form | decimal | No | |
| CurrentSpotCheckQty | form | decimal? | No | |
| QtyOut | form | decimal | No | |
| QtyOnOrder | form | decimal | No | |
| AvailableForSTR | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Desc | form | string | No | |
| ShortDesc | form | string | No | |
| Region | form | string | No | |
| Latitude | form | decimal | No | |
| Longitude | form | decimal | No | |
| InStorePickup | form | string | No | |
| Active | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SasPk | form | long | No | |
| Serial | form | string | No | |
| Retail | form | decimal | No | |
| OurPrice | form | decimal | No | |
| SalePrice | form | decimal? | No | |
| Status | form | string | No | |
| SaleInfo | form | string | No | |
| PriceA | form | decimal | No | |
| PriceB | form | decimal | No | |
| PriceC | form | decimal | No | |
| MinPrice | form | decimal | No | |
| AllowPriceChange | form | bool | No | |
| Cost | form | decimal? | No | |
| WeightedCost | form | decimal? | No | |
| Notes | form | string | No | |
| Attributes | form | List<InventoryDetailAttribute> | No | |
| Images | form | List<ImageInfo> | No | |
| HasImages | form | bool | No | |
| IsActiveeHoldback | form | bool | No | |
| CustomerAcct | form | int? | No | |
| AvailableForSTR | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Model | form | string | No | |
| Sku | form | string | No | |
| Mfg | form | string | No | |
| Description | form | string | No | |
| Price | form | decimal | No | |
| AvailableQty | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SadPk | form | long | No | |
| SkuPk | form | long | No | |
| CatPk | form | long | No | |
| SubPk | form | long | No | |
| Item | form | string | No | |
| Description | form | string | No | |
| Price | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dimension | form | string | No | |
| WebDescription | form | string | No | |
| Summary | form | string | No | |
| SETitle | form | string | No | |
| SEDescription | form | string | No | |
| SEKeywords | form | string | No | |
| SEAltText | form | string | No | |
| SEHtmlFreeText | form | string | No | |
| Unpublished | form | bool | No | |
| FreeShipping | form | bool | No | |
| IsFeatured | form | bool | No | |
| WebCategoryIds | form | List<long> | No |
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,"MinimumAvailableQuantity":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"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":{"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"},"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","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"}}