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

public class dtos
{

    /**
    * InventoryQtyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
    */
    @DataContract
    public static class InventoryQtyRequest extends BaseRequest
    {
        @DataMember
        public Long Pk = null;

        @DataMember
        public String Model = null;

        @DataMember
        public String AeId = null;

        @DataMember
        public Long SkuPk = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public Boolean SendVendorQtyAsSeperateLocation = null;
        
        public Long getPk() { return Pk; }
        public InventoryQtyRequest setPk(Long value) { this.Pk = value; return this; }
        public String getModel() { return Model; }
        public InventoryQtyRequest setModel(String value) { this.Model = value; return this; }
        public String getAeId() { return AeId; }
        public InventoryQtyRequest setAeId(String value) { this.AeId = value; return this; }
        public Long getSkuPk() { return SkuPk; }
        public InventoryQtyRequest setSkuPk(Long value) { this.SkuPk = value; return this; }
        public String getSku() { return Sku; }
        public InventoryQtyRequest setSku(String value) { this.Sku = value; return this; }
        public Boolean isSendVendorQtyAsSeperateLocation() { return SendVendorQtyAsSeperateLocation; }
        public InventoryQtyRequest setSendVendorQtyAsSeperateLocation(Boolean value) { this.SendVendorQtyAsSeperateLocation = 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 InventoryQtyResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<InventoryQtyByVariant> Variants = null;
        
        public ArrayList<InventoryQtyByVariant> getVariants() { return Variants; }
        public InventoryQtyResponse setVariants(ArrayList<InventoryQtyByVariant> value) { this.Variants = 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 InventoryQtyByVariant
    {
        @DataMember
        public String Sku = null;

        @DataMember
        public String AeVariantName = null;

        @DataMember
        public ArrayList<InventoryQtyByLocation> Locations = null;
        
        public String getSku() { return Sku; }
        public InventoryQtyByVariant setSku(String value) { this.Sku = value; return this; }
        public String getAeVariantName() { return AeVariantName; }
        public InventoryQtyByVariant setAeVariantName(String value) { this.AeVariantName = value; return this; }
        public ArrayList<InventoryQtyByLocation> getLocations() { return Locations; }
        public InventoryQtyByVariant setLocations(ArrayList<InventoryQtyByLocation> value) { this.Locations = value; return this; }
    }

    @DataContract
    public static class InventoryQtyByLocation
    {
        @DataMember
        public LocationInfo LocationInfo = null;

        @DataMember
        public BigDecimal QtyAvail = null;
        
        public LocationInfo getLocationInfo() { return LocationInfo; }
        public InventoryQtyByLocation setLocationInfo(LocationInfo value) { this.LocationInfo = value; return this; }
        public BigDecimal getQtyAvail() { return QtyAvail; }
        public InventoryQtyByLocation setQtyAvail(BigDecimal value) { this.QtyAvail = value; return this; }
    }

    @DataContract
    public static class LocationInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String ShortDesc = null;

        @DataMember
        public String Region = null;

        @DataMember
        public BigDecimal Latitude = null;

        @DataMember
        public BigDecimal Longitude = null;

        @DataMember
        public String InStorePickup = null;

        @DataMember
        public Boolean Active = null;

        @DataMember
        public Integer CashSaleAcct = null;
        
        public Long getId() { return Id; }
        public LocationInfo setId(Long value) { this.Id = value; return this; }
        public String getDesc() { return Desc; }
        public LocationInfo setDesc(String value) { this.Desc = value; return this; }
        public String getShortDesc() { return ShortDesc; }
        public LocationInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
        public String getRegion() { return Region; }
        public LocationInfo setRegion(String value) { this.Region = value; return this; }
        public BigDecimal getLatitude() { return Latitude; }
        public LocationInfo setLatitude(BigDecimal value) { this.Latitude = value; return this; }
        public BigDecimal getLongitude() { return Longitude; }
        public LocationInfo setLongitude(BigDecimal value) { this.Longitude = value; return this; }
        public String getInStorePickup() { return InStorePickup; }
        public LocationInfo setInStorePickup(String value) { this.InStorePickup = value; return this; }
        public Boolean isActive() { return Active; }
        public LocationInfo setActive(Boolean value) { this.Active = value; return this; }
        public Integer getCashSaleAcct() { return CashSaleAcct; }
        public LocationInfo setCashSaleAcct(Integer value) { this.CashSaleAcct = value; return this; }
    }

}

Java InventoryQtyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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