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 java.io.InputStream
import net.servicestack.client.*


/**
* InventoryQtyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
@DataContract
open class InventoryQtyRequest : BaseRequest()
{
    @DataMember
    open var Pk:Long? = null

    @DataMember
    open var Model:String? = null

    @DataMember
    open var AeId:String? = null

    @DataMember
    open var SkuPk:Long? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var SendVendorQtyAsSeperateLocation:Boolean? = null
}

@DataContract
open 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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class InventoryQtyResponse : BaseResponse()
{
    @DataMember
    open var Variants:ArrayList<InventoryQtyByVariant>? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    open var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class InventoryQtyByVariant
{
    @DataMember
    open var Sku:String? = null

    @DataMember
    open var AeVariantName:String? = null

    @DataMember
    open var Locations:ArrayList<InventoryQtyByLocation>? = null
}

@DataContract
open class InventoryQtyByLocation
{
    @DataMember
    open var LocationInfo:LocationInfo? = null

    @DataMember
    open var QtyAvail:BigDecimal? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    open var Id:Long? = null

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null

    @DataMember
    open var Region:String? = null

    @DataMember
    open var Latitude:BigDecimal? = null

    @DataMember
    open var Longitude:BigDecimal? = null

    @DataMember
    open var InStorePickup:String? = null

    @DataMember
    open var Active:Boolean? = null

    @DataMember
    open var CashSaleAcct:Int? = null
}

Kotlin 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","DeviceId":"String","AppId":"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"}}