AIM Web Services

<back to all web services

GetActiveE3PartyRequest

GetActiveE3Party
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:
GET/api/GetActiveE3Party
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
@DataContract
open class GetActiveE3PartyRequest : BaseRequest()
{
    @DataMember
    var StartOffset:Int? = null

    @DataMember
    var RecordCount:Int? = null

    /**
    * Inventory, Packages, or NI. Defaults to Inventory.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Inventory, Packages, or NI. Defaults to Inventory.", Name="InventoryType", ParameterType="query")
    var InventoryType:String? = null

    /**
    * Only Items in the sent WebCategory will be returned
    */
    @DataMember
    @ApiMember(DataType="string", Description="Only Items in the sent WebCategory will be returned", Name="WebCategory", ParameterType="query")
    var WebCategory:String? = null

    /**
    * If sent, only grab 3 Party Feed records updated after the date passed.
    */
    @DataMember
    @ApiMember(DataType="string", Description="If sent, only grab 3 Party Feed records updated after the date passed.", Format="date", Name="Date", ParameterType="query")
    var Date:Date? = null

    /**
    * If sent, only the SKU sent will be returned
    */
    @DataMember
    @ApiMember(DataType="string", Description="If sent, only the SKU sent will be returned", Name="Sku", ParameterType="query")
    var Sku:String? = null

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

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetActiveE3PartyResponse : BaseResponse()
{
    @DataMember
    var StartOffset:Int? = null

    @DataMember
    var RecordCount:Int? = null

    @DataMember
    var Records:ArrayList<ActiveE3Party> = ArrayList<ActiveE3Party>()
}

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

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

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

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

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

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

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

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

@DataContract
open class ActiveE3Party
{
    @DataMember
    var Model:String? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var WebNumber:String? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var Mfg:String? = null

    @DataMember
    var Type:String? = null

    @DataMember
    var Barcode:String? = null

    @DataMember
    var BarcodeList:ArrayList<String> = ArrayList<String>()

    @DataMember
    var Selcode:String? = null

    @DataMember
    var Color:String? = null

    @DataMember
    var Size:String? = null

    @DataMember
    var Web_Cat_1:String? = null

    @DataMember
    var Web_Cat_2:String? = null

    @DataMember
    var Web_Cat_3:String? = null

    @DataMember
    var Web_Cat_4:String? = null

    @DataMember
    var URL:String? = null

    @DataMember
    var Image_Small:String? = null

    @DataMember
    var Image_Medium:String? = null

    @DataMember
    var Web_Desc:String? = null

    @DataMember
    var Ebay_cat1:String? = null

    @DataMember
    var Ebay_cat2:String? = null

    @DataMember
    var Ebay_storecat1:String? = null

    @DataMember
    var Ebay_storecat2:String? = null

    @DataMember
    var Ebay_title:String? = null

    @DataMember
    var Ebay_subtitle:String? = null

    @DataMember
    var Ebay_desc:String? = null

    @DataMember
    var Ebay_template:String? = null

    @DataMember
    var Ebay_duration:String? = null

    @DataMember
    var Ebay_format:String? = null

    @DataMember
    var Ebay_paypreset:String? = null

    @DataMember
    var Ebay_shippreset:String? = null

    @DataMember
    var Ebay_shipdest:String? = null

    @DataMember
    var Ebay_image1:String? = null

    @DataMember
    var Ebay_image2:String? = null

    @DataMember
    var Ebay_image3:String? = null

    @DataMember
    var Ebay_image4:String? = null

    @DataMember
    var Ebay_image5:String? = null

    @DataMember
    var Ebay_image6:String? = null

    @DataMember
    var Ebay_image7:String? = null

    @DataMember
    var Ebay_image8:String? = null

    @DataMember
    var Ebay_image9:String? = null

    @DataMember
    var Ebay_image10:String? = null

    @DataMember
    var Ebay_image11:String? = null

    @DataMember
    var Ebay_image12:String? = null

    @DataMember
    var Ebay_image13:String? = null

    @DataMember
    var Ebay_image14:String? = null

    @DataMember
    var Ebay_image15:String? = null

    @DataMember
    var Ebay_image16:String? = null

    @DataMember
    var Ebay_image17:String? = null

    @DataMember
    var Ebay_image18:String? = null

    @DataMember
    var Ebay_image19:String? = null

    @DataMember
    var Ebay_image20:String? = null

    @DataMember
    var Ebay_image21:String? = null

    @DataMember
    var Ebay_image22:String? = null

    @DataMember
    var Ebay_image23:String? = null

    @DataMember
    var Ebay_image24:String? = null

    @DataMember
    var ProductCode:String? = null

    @DataMember
    var Dimension:String? = null

    @DataMember
    var Restricted_Qtys:String? = null

    @DataMember
    var Related_Products:String? = null

    @DataMember
    var Upsell_Products:String? = null

    @DataMember
    var Requires_Products:String? = null

    @DataMember
    var Image_Large:String? = null

    @DataMember
    var Audio_URL:String? = null

    @DataMember
    var MPN:String? = null

    @DataMember
    var Composer:String? = null

    @DataMember
    var Arranger:String? = null

    @DataMember
    var Artist:String? = null

    @DataMember
    var Voicing:String? = null

    @DataMember
    var Level:String? = null

    @DataMember
    var Sample_URL:String? = null

    @DataMember
    var TOC:String? = null

    @DataMember
    var SE_desc:String? = null

    @DataMember
    var SE_keywords:String? = null

    @DataMember
    var SE_title:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Invoice_Notes:String? = null

    @DataMember
    var POS_Reminder:String? = null

    @DataMember
    var LocationQtys:ArrayList<QtyByLoc> = ArrayList<QtyByLoc>()

    @DataMember
    var Location_qtys:String? = null

    @DataMember
    var WebcatChild1:String? = null

    @DataMember
    var WebcatChild2:String? = null

    @DataMember
    var WebcatChild3:String? = null

    @DataMember
    var WebcatChild4:String? = null

    @DataMember
    var Qty:BigDecimal? = null

    @DataMember
    var Qty_Available:BigDecimal? = null

    @DataMember
    var Cost:BigDecimal? = null

    @DataMember
    var Our_Price:BigDecimal? = null

    @DataMember
    var Retail:BigDecimal? = null

    @DataMember
    var Min_Price:BigDecimal? = null

    @DataMember
    var Price_A:BigDecimal? = null

    @DataMember
    var Price_B:BigDecimal? = null

    @DataMember
    var Price_C:BigDecimal? = null

    @DataMember
    var AE_Sale_Price:BigDecimal? = null

    @DataMember
    var Weight:BigDecimal? = null

    @DataMember
    var Ebay_qty:BigDecimal? = null

    @DataMember
    var Ebay_start:BigDecimal? = null

    @DataMember
    var Ebay_reserve:BigDecimal? = null

    @DataMember
    var Ebay_buyitnow:BigDecimal? = null

    @DataMember
    var WCost:BigDecimal? = null

    @DataMember
    var Margin_Perc:BigDecimal? = null

    @DataMember
    var Ebay_length:Int? = null

    @DataMember
    var Ebay_width:Int? = null

    @DataMember
    var Ebay_depth:Int? = null

    @DataMember
    var Ebay_wtmajor:Int? = null

    @DataMember
    var Ebay_wtminor:Int? = null

    @DataMember
    var Ebay:Boolean? = null

    @DataMember
    var Web:Boolean? = null

    @DataMember
    var Published:Boolean? = null

    @DataMember
    var Approval:Boolean? = null

    @DataMember
    var Call_To_Order:Boolean? = null

    @DataMember
    var Discontinued:Boolean? = null

    @DataMember
    var SellSerialsOnline:Boolean? = null

    @DataMember
    var LastUpdated:Date? = null

    @DataMember
    var InventoryAttributes:ArrayList<InventoryAttribute> = ArrayList<InventoryAttribute>()

    @DataMember
    var ExtPk:Long? = null
}

@DataContract
open class QtyByLoc
{
    @DataMember
    var Location:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var LocatorCode:String? = null

    @DataMember
    var SerialItems:ArrayList<SerialItem> = ArrayList<SerialItem>()
}

@DataContract
open class SerialItem
{
    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Retail:BigDecimal? = null

    @DataMember
    var OurPrice:BigDecimal? = null

    @DataMember
    var SalePrice:BigDecimal? = null

    @DataMember
    var AE_Sale_Price:BigDecimal? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var SaleInfo:String? = null

    @DataMember
    var PriceA:BigDecimal? = null

    @DataMember
    var PriceB:BigDecimal? = null

    @DataMember
    var PriceC:BigDecimal? = null

    @DataMember
    var MinPrice:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Source:String? = null

    @DataMember
    var Attributes:ArrayList<InventoryAttribute> = ArrayList<InventoryAttribute>()
}

@DataContract
open class InventoryAttribute
{
    @DataMember
    var Name:String? = null

    @DataMember
    var Value:String? = null
}

Kotlin GetActiveE3PartyRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetActiveE3Party HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"StartOffset":0,"RecordCount":0,"Records":[{"Model":"String","Sku":"String","WebNumber":"String","Desc":"String","Mfg":"String","Type":"String","Barcode":"String","BarcodeList":["String"],"Selcode":"String","Color":"String","Size":"String","Web_Cat_1":"String","Web_Cat_2":"String","Web_Cat_3":"String","Web_Cat_4":"String","URL":"String","Image_Small":"String","Image_Medium":"String","Web_Desc":"String","Ebay_cat1":"String","Ebay_cat2":"String","Ebay_storecat1":"String","Ebay_storecat2":"String","Ebay_title":"String","Ebay_subtitle":"String","Ebay_desc":"String","Ebay_template":"String","Ebay_duration":"String","Ebay_format":"String","Ebay_paypreset":"String","Ebay_shippreset":"String","Ebay_shipdest":"String","Ebay_image1":"String","Ebay_image2":"String","Ebay_image3":"String","Ebay_image4":"String","Ebay_image5":"String","Ebay_image6":"String","Ebay_image7":"String","Ebay_image8":"String","Ebay_image9":"String","Ebay_image10":"String","Ebay_image11":"String","Ebay_image12":"String","Ebay_image13":"String","Ebay_image14":"String","Ebay_image15":"String","Ebay_image16":"String","Ebay_image17":"String","Ebay_image18":"String","Ebay_image19":"String","Ebay_image20":"String","Ebay_image21":"String","Ebay_image22":"String","Ebay_image23":"String","Ebay_image24":"String","ProductCode":"String","Dimension":"String","Restricted_Qtys":"String","Related_Products":"String","Upsell_Products":"String","Requires_Products":"String","Image_Large":"String","Audio_URL":"String","MPN":"String","Composer":"String","Arranger":"String","Artist":"String","Voicing":"String","Level":"String","Sample_URL":"String","TOC":"String","SE_desc":"String","SE_keywords":"String","SE_title":"String","Notes":"String","Invoice_Notes":"String","POS_Reminder":"String","Location_qtys":"String","WebcatChild1":"String","WebcatChild2":"String","WebcatChild3":"String","WebcatChild4":"String","Qty":0,"Qty_Available":0,"Cost":0,"Our_Price":0,"Retail":0,"Min_Price":0,"Price_A":0,"Price_B":0,"Price_C":0,"AE_Sale_Price":0,"Weight":0,"Ebay_qty":0,"Ebay_start":0,"Ebay_reserve":0,"Ebay_buyitnow":0,"WCost":0,"Margin_Perc":0,"Ebay_length":0,"Ebay_width":0,"Ebay_depth":0,"Ebay_wtmajor":0,"Ebay_wtminor":0,"Ebay":false,"Web":false,"Published":false,"Approval":false,"Call_To_Order":false,"Discontinued":false,"SellSerialsOnline":false,"ExtPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}