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

Namespace Global

    Namespace AIM.BL.Core.Misc

        <DataContract>
        Public Partial Class ActiveE3Party
            Public Sub New()
                BarcodeList = New List(Of String)
            End Sub

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property WebNumber As String

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property Mfg As String

            '''<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 Overridable Property Type As String

            <DataMember>
            Public Overridable Property Barcode As String

            <DataMember>
            Public Overridable Property BarcodeList As List(Of String)

            <DataMember>
            Public Overridable Property Selcode As String

            <DataMember>
            Public Overridable Property Color As String

            <DataMember>
            Public Overridable Property Size As String

            <DataMember>
            Public Overridable Property Web_Cat_1 As String

            <DataMember>
            Public Overridable Property Web_Cat_2 As String

            <DataMember>
            Public Overridable Property Web_Cat_3 As String

            <DataMember>
            Public Overridable Property Web_Cat_4 As String

            <DataMember>
            Public Overridable Property URL As String

            <DataMember>
            Public Overridable Property Image_Small As String

            <DataMember>
            Public Overridable Property Image_Medium As String

            <DataMember>
            Public Overridable Property Web_Desc As String

            <DataMember>
            Public Overridable Property Ebay_cat1 As String

            <DataMember>
            Public Overridable Property Ebay_cat2 As String

            <DataMember>
            Public Overridable Property Ebay_storecat1 As String

            <DataMember>
            Public Overridable Property Ebay_storecat2 As String

            <DataMember>
            Public Overridable Property Ebay_title As String

            <DataMember>
            Public Overridable Property Ebay_subtitle As String

            <DataMember>
            Public Overridable Property Ebay_desc As String

            <DataMember>
            Public Overridable Property Ebay_template As String

            <DataMember>
            Public Overridable Property Ebay_duration As String

            <DataMember>
            Public Overridable Property Ebay_format As String

            <DataMember>
            Public Overridable Property Ebay_paypreset As String

            <DataMember>
            Public Overridable Property Ebay_shippreset As String

            <DataMember>
            Public Overridable Property Ebay_shipdest As String

            <DataMember>
            Public Overridable Property Ebay_image1 As String

            <DataMember>
            Public Overridable Property Ebay_image2 As String

            <DataMember>
            Public Overridable Property Ebay_image3 As String

            <DataMember>
            Public Overridable Property Ebay_image4 As String

            <DataMember>
            Public Overridable Property Ebay_image5 As String

            <DataMember>
            Public Overridable Property Ebay_image6 As String

            <DataMember>
            Public Overridable Property Ebay_image7 As String

            <DataMember>
            Public Overridable Property Ebay_image8 As String

            <DataMember>
            Public Overridable Property Ebay_image9 As String

            <DataMember>
            Public Overridable Property Ebay_image10 As String

            <DataMember>
            Public Overridable Property Ebay_image11 As String

            <DataMember>
            Public Overridable Property Ebay_image12 As String

            <DataMember>
            Public Overridable Property Ebay_image13 As String

            <DataMember>
            Public Overridable Property Ebay_image14 As String

            <DataMember>
            Public Overridable Property Ebay_image15 As String

            <DataMember>
            Public Overridable Property Ebay_image16 As String

            <DataMember>
            Public Overridable Property Ebay_image17 As String

            <DataMember>
            Public Overridable Property Ebay_image18 As String

            <DataMember>
            Public Overridable Property Ebay_image19 As String

            <DataMember>
            Public Overridable Property Ebay_image20 As String

            <DataMember>
            Public Overridable Property Ebay_image21 As String

            <DataMember>
            Public Overridable Property Ebay_image22 As String

            <DataMember>
            Public Overridable Property Ebay_image23 As String

            <DataMember>
            Public Overridable Property Ebay_image24 As String

            <DataMember>
            Public Overridable Property ProductCode As String

            <DataMember>
            Public Overridable Property Dimension As String

            <DataMember>
            Public Overridable Property Restricted_Qtys As String

            <DataMember>
            Public Overridable Property Related_Products As String

            <DataMember>
            Public Overridable Property Upsell_Products As String

            <DataMember>
            Public Overridable Property Requires_Products As String

            <DataMember>
            Public Overridable Property Image_Large As String

            <DataMember>
            Public Overridable Property Audio_URL As String

            <DataMember>
            Public Overridable Property MPN As String

            <DataMember>
            Public Overridable Property Composer As String

            <DataMember>
            Public Overridable Property Arranger As String

            <DataMember>
            Public Overridable Property Artist As String

            <DataMember>
            Public Overridable Property Voicing As String

            <DataMember>
            Public Overridable Property Level As String

            <DataMember>
            Public Overridable Property Sample_URL As String

            <DataMember>
            Public Overridable Property TOC As String

            <DataMember>
            Public Overridable Property SE_desc As String

            <DataMember>
            Public Overridable Property SE_keywords As String

            <DataMember>
            Public Overridable Property SE_title As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Invoice_Notes As String

            <DataMember>
            Public Overridable Property POS_Reminder As String

            <DataMember>
            Public Overridable Property LocationQtys As IEnumerable(Of QtyByLoc)

            <DataMember>
            Public Overridable Property Location_qtys As String

            <DataMember>
            Public Overridable Property WebcatChild1 As String

            <DataMember>
            Public Overridable Property WebcatChild2 As String

            <DataMember>
            Public Overridable Property WebcatChild3 As String

            <DataMember>
            Public Overridable Property WebcatChild4 As String

            <DataMember>
            Public Overridable Property Qty As Decimal

            <DataMember>
            Public Overridable Property Qty_Available As Decimal

            <DataMember>
            Public Overridable Property Cost As Decimal

            <DataMember>
            Public Overridable Property Our_Price As Decimal

            <DataMember>
            Public Overridable Property Retail As Decimal

            <DataMember>
            Public Overridable Property Min_Price As Decimal

            <DataMember>
            Public Overridable Property Price_A As Decimal

            <DataMember>
            Public Overridable Property Price_B As Decimal

            <DataMember>
            Public Overridable Property Price_C As Decimal

            <DataMember>
            Public Overridable Property AE_Sale_Price As Decimal

            <DataMember>
            Public Overridable Property Weight As Decimal

            <DataMember>
            Public Overridable Property Ebay_qty As Decimal

            <DataMember>
            Public Overridable Property Ebay_start As Decimal

            <DataMember>
            Public Overridable Property Ebay_reserve As Decimal

            <DataMember>
            Public Overridable Property Ebay_buyitnow As Decimal

            <DataMember>
            Public Overridable Property WCost As Decimal

            <DataMember>
            Public Overridable Property Margin_Perc As Decimal

            <DataMember>
            Public Overridable Property Ebay_length As Integer

            <DataMember>
            Public Overridable Property Ebay_width As Integer

            <DataMember>
            Public Overridable Property Ebay_depth As Integer

            <DataMember>
            Public Overridable Property Ebay_wtmajor As Integer

            <DataMember>
            Public Overridable Property Ebay_wtminor As Integer

            <DataMember>
            Public Overridable Property Ebay As Boolean

            <DataMember>
            Public Overridable Property Web As Boolean

            <DataMember>
            Public Overridable Property Published As Boolean

            <DataMember>
            Public Overridable Property Approval As Boolean

            <DataMember>
            Public Overridable Property Call_To_Order As Boolean

            <DataMember>
            Public Overridable Property Discontinued As Boolean

            <DataMember>
            Public Overridable Property SellSerialsOnline As Boolean

            <DataMember>
            Public Overridable Property LastUpdated As Date

            <DataMember>
            Public Overridable Property InventoryAttributes As IEnumerable(Of InventoryAttribute)

            <DataMember>
            Public Overridable Property ExtPk As Long

            <DataMember>
            Public Overridable Property AIMCategorization As String

            <DataContract>
            Public Partial Class QtyByLoc
                <DataMember>
                Public Overridable Property Location As String

                <DataMember>
                Public Overridable Property Quantity As Decimal

                <DataMember>
                Public Overridable Property LocatorCode As String

                <DataMember>
                Public Overridable Property SerialItems As IEnumerable(Of SerialItem)
            End Class

            <DataContract>
            Public Partial Class InventoryAttribute
                <DataMember>
                Public Overridable Property Name As String

                <DataMember>
                Public Overridable Property Value As String
            End Class

            <DataContract>
            Public Partial Class SerialItem
                <DataMember>
                Public Overridable Property SasPk As Long

                <DataMember>
                Public Overridable Property Serial As String

                <DataMember>
                Public Overridable Property Retail As Decimal

                <DataMember>
                Public Overridable Property OurPrice As Decimal

                <DataMember>
                Public Overridable Property SalePrice As Nullable(Of Decimal)

                <DataMember>
                Public Overridable Property AE_Sale_Price As Decimal

                <DataMember>
                Public Overridable Property Status As String

                <DataMember>
                Public Overridable Property SaleInfo As String

                <DataMember>
                Public Overridable Property PriceA As Decimal

                <DataMember>
                Public Overridable Property PriceB As Decimal

                <DataMember>
                Public Overridable Property PriceC As Decimal

                <DataMember>
                Public Overridable Property MinPrice As Decimal

                <DataMember>
                Public Overridable Property Notes As String

                <DataMember>
                Public Overridable Property Source As String

                <DataMember>
                Public Overridable Property Attributes As IEnumerable(Of InventoryAttribute)
            End Class
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        '''<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
            Inherits BaseRequest
            <DataMember>
            Public Overridable Property StartOffset As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property RecordCount As Nullable(Of Integer)

            '''<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 Overridable Property InventoryType As String

            '''<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 Overridable Property WebCategory As String

            '''<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 Overridable Property [Date] As Nullable(Of Date)

            '''<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 Overridable Property Sku As String

            <DataMember>
            Public Overridable Property IncludeAttributes As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class GetActiveE3PartyResponse
            Inherits BaseResponse
            Public Sub New()
                Records = New List(Of ActiveE3Party)
            End Sub

            <DataMember>
            Public Overridable Property StartOffset As Integer

            <DataMember>
            Public Overridable Property RecordCount As Integer

            <DataMember>
            Public Overridable Property Records As List(Of ActiveE3Party)
        End Class
    End Namespace
End Namespace

VB.NET 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>