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

<StockCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <Items>
    <StockCheckItem>
      <LocationId>0</LocationId>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckItem>
  </Items>
</StockCheckRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StockCheckResponse 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>
  <EverythingAvailable>false</EverythingAvailable>
  <OutOfStockItems>
    <StockCheckErrorItem>
      <LocationId>0</LocationId>
      <Message>String</Message>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckErrorItem>
  </OutOfStockItems>
</StockCheckResponse>