AIM Web Services

<back to all web services

StockCheckRequest

StockCheck
Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce

The following routes are available for this service:
POST/api/StockCheck
StockCheckRequest Parameters:
NameParameterData TypeRequiredDescription
ItemsbodyList<StockCheckItem>No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
StockCheckItem Parameters:
NameParameterData TypeRequiredDescription
SKUformstringNo
LocationIdformlong?No
SerialNumberformstringNo
QtyRequestedformdecimal?No
StockCheckResponse Parameters:
NameParameterData TypeRequiredDescription
EverythingAvailableformboolNo
OutOfStockItemsformList<StockCheckErrorItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
StockCheckErrorItem Parameters:
NameParameterData TypeRequiredDescription
SKUformstringNo
LocationIdformlong?No
SerialNumberformstringNo
QtyRequestedformdecimal?No
MessageformstringNo

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/StockCheck HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Items":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0}],"ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"EverythingAvailable":false,"OutOfStockItems":[{"SKU":"String","LocationId":0,"SerialNumber":"String","QtyRequested":0,"Message":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}