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 Foundation
import ServiceStack

/**
* GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce
*/
// @DataContract
public class GetActiveE3PartyRequest : BaseRequest
{
    // @DataMember
    public var startOffset:Int?

    // @DataMember
    public var recordCount:Int?

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

    /**
    * 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")
    public var webCategory:String

    /**
    * 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")
    public var date:Date?

    /**
    * 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")
    public var sku:String

    // @DataMember
    public var includeAttributes:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case startOffset
        case recordCount
        case inventoryType
        case webCategory
        case date
        case sku
        case includeAttributes
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
        recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
        inventoryType = try container.decodeIfPresent(String.self, forKey: .inventoryType)
        webCategory = try container.decodeIfPresent(String.self, forKey: .webCategory)
        date = try container.decodeIfPresent(Date.self, forKey: .date)
        sku = try container.decodeIfPresent(String.self, forKey: .sku)
        includeAttributes = try container.decodeIfPresent(Bool.self, forKey: .includeAttributes)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
        if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
        if inventoryType != nil { try container.encode(inventoryType, forKey: .inventoryType) }
        if webCategory != nil { try container.encode(webCategory, forKey: .webCategory) }
        if date != nil { try container.encode(date, forKey: .date) }
        if sku != nil { try container.encode(sku, forKey: .sku) }
        if includeAttributes != nil { try container.encode(includeAttributes, forKey: .includeAttributes) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class GetActiveE3PartyResponse : BaseResponse
{
    // @DataMember
    public var startOffset:Int

    // @DataMember
    public var recordCount:Int

    // @DataMember
    public var records:[ActiveE3Party] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case startOffset
        case recordCount
        case records
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
        recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
        records = try container.decodeIfPresent([ActiveE3Party].self, forKey: .records) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
        if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
        if records.count > 0 { try container.encode(records, forKey: .records) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class ActiveE3Party : Codable
{
    // @DataMember
    public var model:String

    // @DataMember
    public var sku:String

    // @DataMember
    public var webNumber:String

    // @DataMember
    public var desc:String

    // @DataMember
    public var mfg:String

    /**
    * 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")
    public var type:String

    // @DataMember
    public var barcode:String

    // @DataMember
    public var barcodeList:[String] = []

    // @DataMember
    public var selcode:String

    // @DataMember
    public var color:String

    // @DataMember
    public var size:String

    // @DataMember
    public var web_Cat_1:String

    // @DataMember
    public var web_Cat_2:String

    // @DataMember
    public var web_Cat_3:String

    // @DataMember
    public var web_Cat_4:String

    // @DataMember
    public var url:String

    // @DataMember
    public var image_Small:String

    // @DataMember
    public var image_Medium:String

    // @DataMember
    public var web_Desc:String

    // @DataMember
    public var ebay_cat1:String

    // @DataMember
    public var ebay_cat2:String

    // @DataMember
    public var ebay_storecat1:String

    // @DataMember
    public var ebay_storecat2:String

    // @DataMember
    public var ebay_title:String

    // @DataMember
    public var ebay_subtitle:String

    // @DataMember
    public var ebay_desc:String

    // @DataMember
    public var ebay_template:String

    // @DataMember
    public var ebay_duration:String

    // @DataMember
    public var ebay_format:String

    // @DataMember
    public var ebay_paypreset:String

    // @DataMember
    public var ebay_shippreset:String

    // @DataMember
    public var ebay_shipdest:String

    // @DataMember
    public var ebay_image1:String

    // @DataMember
    public var ebay_image2:String

    // @DataMember
    public var ebay_image3:String

    // @DataMember
    public var ebay_image4:String

    // @DataMember
    public var ebay_image5:String

    // @DataMember
    public var ebay_image6:String

    // @DataMember
    public var ebay_image7:String

    // @DataMember
    public var ebay_image8:String

    // @DataMember
    public var ebay_image9:String

    // @DataMember
    public var ebay_image10:String

    // @DataMember
    public var ebay_image11:String

    // @DataMember
    public var ebay_image12:String

    // @DataMember
    public var ebay_image13:String

    // @DataMember
    public var ebay_image14:String

    // @DataMember
    public var ebay_image15:String

    // @DataMember
    public var ebay_image16:String

    // @DataMember
    public var ebay_image17:String

    // @DataMember
    public var ebay_image18:String

    // @DataMember
    public var ebay_image19:String

    // @DataMember
    public var ebay_image20:String

    // @DataMember
    public var ebay_image21:String

    // @DataMember
    public var ebay_image22:String

    // @DataMember
    public var ebay_image23:String

    // @DataMember
    public var ebay_image24:String

    // @DataMember
    public var productCode:String

    // @DataMember
    public var dimension:String

    // @DataMember
    public var restricted_Qtys:String

    // @DataMember
    public var related_Products:String

    // @DataMember
    public var upsell_Products:String

    // @DataMember
    public var requires_Products:String

    // @DataMember
    public var image_Large:String

    // @DataMember
    public var audio_URL:String

    // @DataMember
    public var mpn:String

    // @DataMember
    public var composer:String

    // @DataMember
    public var arranger:String

    // @DataMember
    public var artist:String

    // @DataMember
    public var voicing:String

    // @DataMember
    public var level:String

    // @DataMember
    public var sample_URL:String

    // @DataMember
    public var toc:String

    // @DataMember
    public var sE_desc:String

    // @DataMember
    public var sE_keywords:String

    // @DataMember
    public var sE_title:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var invoice_Notes:String

    // @DataMember
    public var poS_Reminder:String

    // @DataMember
    public var locationQtys:[QtyByLoc] = []

    // @DataMember
    public var location_qtys:String

    // @DataMember
    public var webcatChild1:String

    // @DataMember
    public var webcatChild2:String

    // @DataMember
    public var webcatChild3:String

    // @DataMember
    public var webcatChild4:String

    // @DataMember
    public var qty:Double

    // @DataMember
    public var qty_Available:Double

    // @DataMember
    public var cost:Double

    // @DataMember
    public var our_Price:Double

    // @DataMember
    public var retail:Double

    // @DataMember
    public var min_Price:Double

    // @DataMember
    public var price_A:Double

    // @DataMember
    public var price_B:Double

    // @DataMember
    public var price_C:Double

    // @DataMember
    public var aE_Sale_Price:Double

    // @DataMember
    public var weight:Double

    // @DataMember
    public var ebay_qty:Double

    // @DataMember
    public var ebay_start:Double

    // @DataMember
    public var ebay_reserve:Double

    // @DataMember
    public var ebay_buyitnow:Double

    // @DataMember
    public var wCost:Double

    // @DataMember
    public var margin_Perc:Double

    // @DataMember
    public var ebay_length:Int

    // @DataMember
    public var ebay_width:Int

    // @DataMember
    public var ebay_depth:Int

    // @DataMember
    public var ebay_wtmajor:Int

    // @DataMember
    public var ebay_wtminor:Int

    // @DataMember
    public var ebay:Bool

    // @DataMember
    public var web:Bool

    // @DataMember
    public var published:Bool

    // @DataMember
    public var approval:Bool

    // @DataMember
    public var call_To_Order:Bool

    // @DataMember
    public var discontinued:Bool

    // @DataMember
    public var sellSerialsOnline:Bool

    // @DataMember
    public var lastUpdated:Date

    // @DataMember
    public var inventoryAttributes:[InventoryAttribute] = []

    // @DataMember
    public var extPk:Int

    // @DataMember
    public var aimCategorization:String

    required public init(){}
}

// @DataContract
public class QtyByLoc : Codable
{
    // @DataMember
    public var location:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var locatorCode:String

    // @DataMember
    public var serialItems:[SerialItem] = []

    required public init(){}
}

// @DataContract
public class SerialItem : Codable
{
    // @DataMember
    public var sasPk:Int

    // @DataMember
    public var serial:String

    // @DataMember
    public var retail:Double

    // @DataMember
    public var ourPrice:Double

    // @DataMember
    public var salePrice:Double?

    // @DataMember
    public var aE_Sale_Price:Double

    // @DataMember
    public var status:String

    // @DataMember
    public var saleInfo:String

    // @DataMember
    public var priceA:Double

    // @DataMember
    public var priceB:Double

    // @DataMember
    public var priceC:Double

    // @DataMember
    public var minPrice:Double

    // @DataMember
    public var notes:String

    // @DataMember
    public var source:String

    // @DataMember
    public var attributes:[InventoryAttribute] = []

    required public init(){}
}

// @DataContract
public class InventoryAttribute : Codable
{
    // @DataMember
    public var name:String

    // @DataMember
    public var value:String

    required public init(){}
}

Swift 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>