AIM Web Services

InventoryDetailRequest

InventoryDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET	/api/InventoryDetail

**InventoryDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Pk	query	integer	No	The PK being used for lookup. Can be used in conjunction with PkType. Do not use if Model is passed in.
PkType	query	string	No	The type of PK being used for lookup. Can be SAD, SKU, SAS, or EXT. Only used if PK is passed in. Defaults to SAD if not sent.
Model	query	string	No	The Model being used for lookup. Do not use if Pk is passed in.
SkipImages	body	bool	No
IncludeSerialInfo	body	bool	No
CustomerAcct	query	integer	No	If sent, the Customer Acct will be used for customer specific pricing.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	Header	string	No	The Login Token return by the Security API. Required for secured calls.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	Header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	Header	string	Yes	The OAuthToken token return by AeServices30
DeviceId	Header	string	No	The Device ID of the Mobile Device. Not used for non-mobile devices.
AppId	Header	string	Yes	An identifier for your integration

**InventoryDetailResponse** Parameters:
Name	Parameter	Data Type	Required
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
ShipCharge	form	decimal	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
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

**ImageInfo** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
ImageStream	form	string	No
ImageSize	form	string	No
ErrorMessage	form	string	No
UriPk	form	long?	No

**InventoryDetailByVariant** Parameters:
Name	Parameter	Data Type	Required
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

**InventoryDetailAttribute** Parameters:
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 'Send To Web'

**InventoryDetailByLocation** Parameters:
Name	Parameter	Data Type	Required
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
ActiveEPrice	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

**LocationInfo** Parameters:
Name	Parameter	Data Type	Required
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
CashSaleAcct	form	int?	No

**InventoryDetailBySerial** Parameters:
Name	Parameter	Data Type	Required
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
ActiveEPrice	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

**InventoryDetailSubstitute** Parameters:
Name	Parameter	Data Type	Required
Model	form	string	No
Sku	form	string	No
Mfg	form	string	No
Description	form	string	No
Price	form	decimal	No
AvailableQty	form	decimal	No

**AddOnDetail** Parameters:
Name	Parameter	Data Type	Required
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

**ActiveEInfo** Parameters:
Name	Parameter	Data Type	Required
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
HidePrice	form	bool	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

HTTP + JSON

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

POST /api/InventoryDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Pk":0,"PkType":"String","Model":"String","SkipImages":false,"IncludeSerialInfo":false,"CustomerAcct":0,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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],"HidePrice":false},"Weight":0,"Unit":"String","ShipCharge":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}

AIM Web Services

InventoryDetailRequest

InventoryDetail Requires active-e Inventory Service

HTTP + JSON

InventoryDetail
Requires active-e Inventory Service