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

    /**
    * S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory
    */
    @DataMember
    @ApiMember(DataType="string", Description="S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory", Name="Type")
    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

    @DataMember
    var AIMCategorization:String? = 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 .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.

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

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

<GetActiveE3PartyResponse 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>
  <RecordCount>0</RecordCount>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Misc">
    <d2p1:ActiveE3Party>
      <d2p1:AE_Sale_Price>0</d2p1:AE_Sale_Price>
      <d2p1:AIMCategorization>String</d2p1:AIMCategorization>
      <d2p1:Approval>false</d2p1:Approval>
      <d2p1:Arranger>String</d2p1:Arranger>
      <d2p1:Artist>String</d2p1:Artist>
      <d2p1:Audio_URL>String</d2p1:Audio_URL>
      <d2p1:Barcode>String</d2p1:Barcode>
      <d2p1:BarcodeList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:BarcodeList>
      <d2p1:Call_To_Order>false</d2p1:Call_To_Order>
      <d2p1:Color>String</d2p1:Color>
      <d2p1:Composer>String</d2p1:Composer>
      <d2p1:Cost>0</d2p1:Cost>
      <d2p1:Desc>String</d2p1:Desc>
      <d2p1:Dimension>String</d2p1:Dimension>
      <d2p1:Discontinued>false</d2p1:Discontinued>
      <d2p1:Ebay>false</d2p1:Ebay>
      <d2p1:Ebay_buyitnow>0</d2p1:Ebay_buyitnow>
      <d2p1:Ebay_cat1>String</d2p1:Ebay_cat1>
      <d2p1:Ebay_cat2>String</d2p1:Ebay_cat2>
      <d2p1:Ebay_depth>0</d2p1:Ebay_depth>
      <d2p1:Ebay_desc>String</d2p1:Ebay_desc>
      <d2p1:Ebay_duration>String</d2p1:Ebay_duration>
      <d2p1:Ebay_format>String</d2p1:Ebay_format>
      <d2p1:Ebay_image1>String</d2p1:Ebay_image1>
      <d2p1:Ebay_image10>String</d2p1:Ebay_image10>
      <d2p1:Ebay_image11>String</d2p1:Ebay_image11>
      <d2p1:Ebay_image12>String</d2p1:Ebay_image12>
      <d2p1:Ebay_image13>String</d2p1:Ebay_image13>
      <d2p1:Ebay_image14>String</d2p1:Ebay_image14>
      <d2p1:Ebay_image15>String</d2p1:Ebay_image15>
      <d2p1:Ebay_image16>String</d2p1:Ebay_image16>
      <d2p1:Ebay_image17>String</d2p1:Ebay_image17>
      <d2p1:Ebay_image18>String</d2p1:Ebay_image18>
      <d2p1:Ebay_image19>String</d2p1:Ebay_image19>
      <d2p1:Ebay_image2>String</d2p1:Ebay_image2>
      <d2p1:Ebay_image20>String</d2p1:Ebay_image20>
      <d2p1:Ebay_image21>String</d2p1:Ebay_image21>
      <d2p1:Ebay_image22>String</d2p1:Ebay_image22>
      <d2p1:Ebay_image23>String</d2p1:Ebay_image23>
      <d2p1:Ebay_image24>String</d2p1:Ebay_image24>
      <d2p1:Ebay_image3>String</d2p1:Ebay_image3>
      <d2p1:Ebay_image4>String</d2p1:Ebay_image4>
      <d2p1:Ebay_image5>String</d2p1:Ebay_image5>
      <d2p1:Ebay_image6>String</d2p1:Ebay_image6>
      <d2p1:Ebay_image7>String</d2p1:Ebay_image7>
      <d2p1:Ebay_image8>String</d2p1:Ebay_image8>
      <d2p1:Ebay_image9>String</d2p1:Ebay_image9>
      <d2p1:Ebay_length>0</d2p1:Ebay_length>
      <d2p1:Ebay_paypreset>String</d2p1:Ebay_paypreset>
      <d2p1:Ebay_qty>0</d2p1:Ebay_qty>
      <d2p1:Ebay_reserve>0</d2p1:Ebay_reserve>
      <d2p1:Ebay_shipdest>String</d2p1:Ebay_shipdest>
      <d2p1:Ebay_shippreset>String</d2p1:Ebay_shippreset>
      <d2p1:Ebay_start>0</d2p1:Ebay_start>
      <d2p1:Ebay_storecat1>String</d2p1:Ebay_storecat1>
      <d2p1:Ebay_storecat2>String</d2p1:Ebay_storecat2>
      <d2p1:Ebay_subtitle>String</d2p1:Ebay_subtitle>
      <d2p1:Ebay_template>String</d2p1:Ebay_template>
      <d2p1:Ebay_title>String</d2p1:Ebay_title>
      <d2p1:Ebay_width>0</d2p1:Ebay_width>
      <d2p1:Ebay_wtmajor>0</d2p1:Ebay_wtmajor>
      <d2p1:Ebay_wtminor>0</d2p1:Ebay_wtminor>
      <d2p1:ExtPk>0</d2p1:ExtPk>
      <d2p1:Image_Large>String</d2p1:Image_Large>
      <d2p1:Image_Medium>String</d2p1:Image_Medium>
      <d2p1:Image_Small>String</d2p1:Image_Small>
      <d2p1:InventoryAttributes i:nil="true" />
      <d2p1:Invoice_Notes>String</d2p1:Invoice_Notes>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:Level>String</d2p1:Level>
      <d2p1:LocationQtys i:nil="true" />
      <d2p1:Location_qtys>String</d2p1:Location_qtys>
      <d2p1:MPN>String</d2p1:MPN>
      <d2p1:Margin_Perc>0</d2p1:Margin_Perc>
      <d2p1:Mfg>String</d2p1:Mfg>
      <d2p1:Min_Price>0</d2p1:Min_Price>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:Our_Price>0</d2p1:Our_Price>
      <d2p1:POS_Reminder>String</d2p1:POS_Reminder>
      <d2p1:Price_A>0</d2p1:Price_A>
      <d2p1:Price_B>0</d2p1:Price_B>
      <d2p1:Price_C>0</d2p1:Price_C>
      <d2p1:ProductCode>String</d2p1:ProductCode>
      <d2p1:Published>false</d2p1:Published>
      <d2p1:Qty>0</d2p1:Qty>
      <d2p1:Qty_Available>0</d2p1:Qty_Available>
      <d2p1:Related_Products>String</d2p1:Related_Products>
      <d2p1:Requires_Products>String</d2p1:Requires_Products>
      <d2p1:Restricted_Qtys>String</d2p1:Restricted_Qtys>
      <d2p1:Retail>0</d2p1:Retail>
      <d2p1:SE_desc>String</d2p1:SE_desc>
      <d2p1:SE_keywords>String</d2p1:SE_keywords>
      <d2p1:SE_title>String</d2p1:SE_title>
      <d2p1:Sample_URL>String</d2p1:Sample_URL>
      <d2p1:Selcode>String</d2p1:Selcode>
      <d2p1:SellSerialsOnline>false</d2p1:SellSerialsOnline>
      <d2p1:Size>String</d2p1:Size>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:TOC>String</d2p1:TOC>
      <d2p1:Type>String</d2p1:Type>
      <d2p1:URL>String</d2p1:URL>
      <d2p1:Upsell_Products>String</d2p1:Upsell_Products>
      <d2p1:Voicing>String</d2p1:Voicing>
      <d2p1:WCost>0</d2p1:WCost>
      <d2p1:Web>false</d2p1:Web>
      <d2p1:WebNumber>String</d2p1:WebNumber>
      <d2p1:Web_Cat_1>String</d2p1:Web_Cat_1>
      <d2p1:Web_Cat_2>String</d2p1:Web_Cat_2>
      <d2p1:Web_Cat_3>String</d2p1:Web_Cat_3>
      <d2p1:Web_Cat_4>String</d2p1:Web_Cat_4>
      <d2p1:Web_Desc>String</d2p1:Web_Desc>
      <d2p1:WebcatChild1>String</d2p1:WebcatChild1>
      <d2p1:WebcatChild2>String</d2p1:WebcatChild2>
      <d2p1:WebcatChild3>String</d2p1:WebcatChild3>
      <d2p1:WebcatChild4>String</d2p1:WebcatChild4>
      <d2p1:Weight>0</d2p1:Weight>
    </d2p1:ActiveE3Party>
  </Records>
  <StartOffset>0</StartOffset>
</GetActiveE3PartyResponse>