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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM.BL.Core.Misc;

namespace AIM.BL.Core.Misc
{
    [DataContract]
    public partial class ActiveE3Party
    {
        public ActiveE3Party()
        {
            BarcodeList = new List<string>{};
        }

        [DataMember]
        public virtual string Model { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string WebNumber { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string Mfg { get; set; }

        ///<summary>
        ///S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory
        ///</summary>
        [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")]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual string Barcode { get; set; }

        [DataMember]
        public virtual List<string> BarcodeList { get; set; }

        [DataMember]
        public virtual string Selcode { get; set; }

        [DataMember]
        public virtual string Color { get; set; }

        [DataMember]
        public virtual string Size { get; set; }

        [DataMember]
        public virtual string Web_Cat_1 { get; set; }

        [DataMember]
        public virtual string Web_Cat_2 { get; set; }

        [DataMember]
        public virtual string Web_Cat_3 { get; set; }

        [DataMember]
        public virtual string Web_Cat_4 { get; set; }

        [DataMember]
        public virtual string URL { get; set; }

        [DataMember]
        public virtual string Image_Small { get; set; }

        [DataMember]
        public virtual string Image_Medium { get; set; }

        [DataMember]
        public virtual string Web_Desc { get; set; }

        [DataMember]
        public virtual string Ebay_cat1 { get; set; }

        [DataMember]
        public virtual string Ebay_cat2 { get; set; }

        [DataMember]
        public virtual string Ebay_storecat1 { get; set; }

        [DataMember]
        public virtual string Ebay_storecat2 { get; set; }

        [DataMember]
        public virtual string Ebay_title { get; set; }

        [DataMember]
        public virtual string Ebay_subtitle { get; set; }

        [DataMember]
        public virtual string Ebay_desc { get; set; }

        [DataMember]
        public virtual string Ebay_template { get; set; }

        [DataMember]
        public virtual string Ebay_duration { get; set; }

        [DataMember]
        public virtual string Ebay_format { get; set; }

        [DataMember]
        public virtual string Ebay_paypreset { get; set; }

        [DataMember]
        public virtual string Ebay_shippreset { get; set; }

        [DataMember]
        public virtual string Ebay_shipdest { get; set; }

        [DataMember]
        public virtual string Ebay_image1 { get; set; }

        [DataMember]
        public virtual string Ebay_image2 { get; set; }

        [DataMember]
        public virtual string Ebay_image3 { get; set; }

        [DataMember]
        public virtual string Ebay_image4 { get; set; }

        [DataMember]
        public virtual string Ebay_image5 { get; set; }

        [DataMember]
        public virtual string Ebay_image6 { get; set; }

        [DataMember]
        public virtual string Ebay_image7 { get; set; }

        [DataMember]
        public virtual string Ebay_image8 { get; set; }

        [DataMember]
        public virtual string Ebay_image9 { get; set; }

        [DataMember]
        public virtual string Ebay_image10 { get; set; }

        [DataMember]
        public virtual string Ebay_image11 { get; set; }

        [DataMember]
        public virtual string Ebay_image12 { get; set; }

        [DataMember]
        public virtual string Ebay_image13 { get; set; }

        [DataMember]
        public virtual string Ebay_image14 { get; set; }

        [DataMember]
        public virtual string Ebay_image15 { get; set; }

        [DataMember]
        public virtual string Ebay_image16 { get; set; }

        [DataMember]
        public virtual string Ebay_image17 { get; set; }

        [DataMember]
        public virtual string Ebay_image18 { get; set; }

        [DataMember]
        public virtual string Ebay_image19 { get; set; }

        [DataMember]
        public virtual string Ebay_image20 { get; set; }

        [DataMember]
        public virtual string Ebay_image21 { get; set; }

        [DataMember]
        public virtual string Ebay_image22 { get; set; }

        [DataMember]
        public virtual string Ebay_image23 { get; set; }

        [DataMember]
        public virtual string Ebay_image24 { get; set; }

        [DataMember]
        public virtual string ProductCode { get; set; }

        [DataMember]
        public virtual string Dimension { get; set; }

        [DataMember]
        public virtual string Restricted_Qtys { get; set; }

        [DataMember]
        public virtual string Related_Products { get; set; }

        [DataMember]
        public virtual string Upsell_Products { get; set; }

        [DataMember]
        public virtual string Requires_Products { get; set; }

        [DataMember]
        public virtual string Image_Large { get; set; }

        [DataMember]
        public virtual string Audio_URL { get; set; }

        [DataMember]
        public virtual string MPN { get; set; }

        [DataMember]
        public virtual string Composer { get; set; }

        [DataMember]
        public virtual string Arranger { get; set; }

        [DataMember]
        public virtual string Artist { get; set; }

        [DataMember]
        public virtual string Voicing { get; set; }

        [DataMember]
        public virtual string Level { get; set; }

        [DataMember]
        public virtual string Sample_URL { get; set; }

        [DataMember]
        public virtual string TOC { get; set; }

        [DataMember]
        public virtual string SE_desc { get; set; }

        [DataMember]
        public virtual string SE_keywords { get; set; }

        [DataMember]
        public virtual string SE_title { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual string Invoice_Notes { get; set; }

        [DataMember]
        public virtual string POS_Reminder { get; set; }

        [DataMember]
        public virtual IEnumerable<QtyByLoc> LocationQtys { get; set; }

        [DataMember]
        public virtual string Location_qtys { get; set; }

        [DataMember]
        public virtual string WebcatChild1 { get; set; }

        [DataMember]
        public virtual string WebcatChild2 { get; set; }

        [DataMember]
        public virtual string WebcatChild3 { get; set; }

        [DataMember]
        public virtual string WebcatChild4 { get; set; }

        [DataMember]
        public virtual decimal Qty { get; set; }

        [DataMember]
        public virtual decimal Qty_Available { get; set; }

        [DataMember]
        public virtual decimal Cost { get; set; }

        [DataMember]
        public virtual decimal Our_Price { get; set; }

        [DataMember]
        public virtual decimal Retail { get; set; }

        [DataMember]
        public virtual decimal Min_Price { get; set; }

        [DataMember]
        public virtual decimal Price_A { get; set; }

        [DataMember]
        public virtual decimal Price_B { get; set; }

        [DataMember]
        public virtual decimal Price_C { get; set; }

        [DataMember]
        public virtual decimal AE_Sale_Price { get; set; }

        [DataMember]
        public virtual decimal Weight { get; set; }

        [DataMember]
        public virtual decimal Ebay_qty { get; set; }

        [DataMember]
        public virtual decimal Ebay_start { get; set; }

        [DataMember]
        public virtual decimal Ebay_reserve { get; set; }

        [DataMember]
        public virtual decimal Ebay_buyitnow { get; set; }

        [DataMember]
        public virtual decimal WCost { get; set; }

        [DataMember]
        public virtual decimal Margin_Perc { get; set; }

        [DataMember]
        public virtual int Ebay_length { get; set; }

        [DataMember]
        public virtual int Ebay_width { get; set; }

        [DataMember]
        public virtual int Ebay_depth { get; set; }

        [DataMember]
        public virtual int Ebay_wtmajor { get; set; }

        [DataMember]
        public virtual int Ebay_wtminor { get; set; }

        [DataMember]
        public virtual bool Ebay { get; set; }

        [DataMember]
        public virtual bool Web { get; set; }

        [DataMember]
        public virtual bool Published { get; set; }

        [DataMember]
        public virtual bool Approval { get; set; }

        [DataMember]
        public virtual bool Call_To_Order { get; set; }

        [DataMember]
        public virtual bool Discontinued { get; set; }

        [DataMember]
        public virtual bool SellSerialsOnline { get; set; }

        [DataMember]
        public virtual DateTime LastUpdated { get; set; }

        [DataMember]
        public virtual IEnumerable<InventoryAttribute> InventoryAttributes { get; set; }

        [DataMember]
        public virtual long ExtPk { get; set; }

        [DataMember]
        public virtual string AIMCategorization { get; set; }
        [DataContract]
        public partial class QtyByLoc
        {
            [DataMember]
            public virtual string Location { get; set; }

            [DataMember]
            public virtual decimal Quantity { get; set; }

            [DataMember]
            public virtual string LocatorCode { get; set; }

            [DataMember]
            public virtual IEnumerable<SerialItem> SerialItems { get; set; }
        }

        [DataContract]
        public partial class InventoryAttribute
        {
            [DataMember]
            public virtual string Name { get; set; }

            [DataMember]
            public virtual string Value { get; set; }
        }

        [DataContract]
        public partial class SerialItem
        {
            [DataMember]
            public virtual long SasPk { get; set; }

            [DataMember]
            public virtual string Serial { get; set; }

            [DataMember]
            public virtual decimal Retail { get; set; }

            [DataMember]
            public virtual decimal OurPrice { get; set; }

            [DataMember]
            public virtual decimal? SalePrice { get; set; }

            [DataMember]
            public virtual decimal AE_Sale_Price { get; set; }

            [DataMember]
            public virtual string Status { get; set; }

            [DataMember]
            public virtual string SaleInfo { get; set; }

            [DataMember]
            public virtual decimal PriceA { get; set; }

            [DataMember]
            public virtual decimal PriceB { get; set; }

            [DataMember]
            public virtual decimal PriceC { get; set; }

            [DataMember]
            public virtual decimal MinPrice { get; set; }

            [DataMember]
            public virtual string Notes { get; set; }

            [DataMember]
            public virtual string Source { get; set; }

            [DataMember]
            public virtual IEnumerable<InventoryAttribute> Attributes { get; set; }
        }

    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    ///<summary>
    ///GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
    ///</summary>
    [DataContract]
    public partial class GetActiveE3PartyRequest
        : BaseRequest
    {
        [DataMember]
        public virtual int? StartOffset { get; set; }

        [DataMember]
        public virtual int? RecordCount { get; set; }

        ///<summary>
        ///Inventory, Packages, or NI. Defaults to Inventory.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Inventory, Packages, or NI. Defaults to Inventory.", Name="InventoryType", ParameterType="query")]
        public virtual string InventoryType { get; set; }

        ///<summary>
        ///Only Items in the sent WebCategory will be returned
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Only Items in the sent WebCategory will be returned", Name="WebCategory", ParameterType="query")]
        public virtual string WebCategory { get; set; }

        ///<summary>
        ///If sent, only grab 3 Party Feed records updated after the date passed.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, only grab 3 Party Feed records updated after the date passed.", Format="date", Name="Date", ParameterType="query")]
        public virtual DateTime? Date { get; set; }

        ///<summary>
        ///If sent, only the SKU sent will be returned
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, only the SKU sent will be returned", Name="Sku", ParameterType="query")]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual bool? IncludeAttributes { get; set; }
    }

    [DataContract]
    public partial class GetActiveE3PartyResponse
        : BaseResponse
    {
        public GetActiveE3PartyResponse()
        {
            Records = new List<ActiveE3Party>{};
        }

        [DataMember]
        public virtual int StartOffset { get; set; }

        [DataMember]
        public virtual int RecordCount { get; set; }

        [DataMember]
        public virtual List<ActiveE3Party> Records { get; set; }
    }

}

C# 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>