| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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,"AIMCategorization":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}