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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<InventoryQtyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AeId>String</AeId>
  <Model>String</Model>
  <Pk>0</Pk>
  <Sku>String</Sku>
  <SkuPk>0</SkuPk>
</InventoryQtyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryQtyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Variants>
    <InventoryQtyResponse.InventoryQtyByVariant i:nil="true" />
  </Variants>
</InventoryQtyResponse>