AIM Web Services

<back to all web services

InventoryQtyRequest

InventoryQty
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, GET/api/InventoryQty
InventoryQtyRequest Parameters:
NameParameterData TypeRequiredDescription
Pkbodylong?No
ModelbodystringNo
AeIdbodystringNo
SkuPkbodylong?No
SkubodystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
InventoryQtyResponse Parameters:
NameParameterData TypeRequiredDescription
VariantsformList<InventoryQtyByVariant>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
InventoryQtyByVariant Parameters:
NameParameterData TypeRequiredDescription
SkuformstringNo
AeVariantNameformstringNo
LocationsformList<InventoryQtyByLocation>No
InventoryQtyByLocation Parameters:
NameParameterData TypeRequiredDescription
LocationInfoformLocationInfoNo
QtyAvailformdecimalNo
LocationInfo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescformstringNo
ShortDescformstringNo
RegionformstringNo
LatitudeformdecimalNo
LongitudeformdecimalNo
InStorePickupformstringNo
ActiveformboolNo

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

{"Pk":0,"Model":"String","AeId":"String","SkuPk":0,"Sku":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Variants":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}