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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * StockCheckRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
    */
    @DataContract
    public static class StockCheckRequest extends BaseRequest
    {
        @DataMember
        public ArrayList<StockCheckItem> Items = null;
        
        public ArrayList<StockCheckItem> getItems() { return Items; }
        public StockCheckRequest setItems(ArrayList<StockCheckItem> value) { this.Items = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class StockCheckItem
    {
        @DataMember
        public String SKU = null;

        @DataMember
        public Long LocationId = null;

        @DataMember
        public String SerialNumber = null;

        @DataMember
        public BigDecimal QtyRequested = null;
        
        public String getSku() { return SKU; }
        public StockCheckItem setSku(String value) { this.SKU = value; return this; }
        public Long getLocationId() { return LocationId; }
        public StockCheckItem setLocationId(Long value) { this.LocationId = value; return this; }
        public String getSerialNumber() { return SerialNumber; }
        public StockCheckItem setSerialNumber(String value) { this.SerialNumber = value; return this; }
        public BigDecimal getQtyRequested() { return QtyRequested; }
        public StockCheckItem setQtyRequested(BigDecimal value) { this.QtyRequested = value; return this; }
    }

    @DataContract
    public static class StockCheckResponse extends BaseResponse
    {
        @DataMember
        public Boolean EverythingAvailable = null;

        @DataMember
        public ArrayList<StockCheckErrorItem> OutOfStockItems = null;
        
        public Boolean isEverythingAvailable() { return EverythingAvailable; }
        public StockCheckResponse setEverythingAvailable(Boolean value) { this.EverythingAvailable = value; return this; }
        public ArrayList<StockCheckErrorItem> getOutOfStockItems() { return OutOfStockItems; }
        public StockCheckResponse setOutOfStockItems(ArrayList<StockCheckErrorItem> value) { this.OutOfStockItems = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class StockCheckErrorItem
    {
        @DataMember
        public String SKU = null;

        @DataMember
        public Long LocationId = null;

        @DataMember
        public String SerialNumber = null;

        @DataMember
        public BigDecimal QtyRequested = null;

        @DataMember
        public String Message = null;
        
        public String getSku() { return SKU; }
        public StockCheckErrorItem setSku(String value) { this.SKU = value; return this; }
        public Long getLocationId() { return LocationId; }
        public StockCheckErrorItem setLocationId(Long value) { this.LocationId = value; return this; }
        public String getSerialNumber() { return SerialNumber; }
        public StockCheckErrorItem setSerialNumber(String value) { this.SerialNumber = value; return this; }
        public BigDecimal getQtyRequested() { return QtyRequested; }
        public StockCheckErrorItem setQtyRequested(BigDecimal value) { this.QtyRequested = value; return this; }
        public String getMessage() { return Message; }
        public StockCheckErrorItem setMessage(String value) { this.Message = value; return this; }
    }

}

Java StockCheckRequest DTOs

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>