| GET | /api/GetActiveE3Party |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class InventoryAttribute {
/** @param {{Name?:string,Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Value;
}
export class SerialItem {
/** @param {{SasPk?:number,Serial?:string,Retail?:number,OurPrice?:number,SalePrice?:number,AE_Sale_Price?:number,Status?:string,SaleInfo?:string,PriceA?:number,PriceB?:number,PriceC?:number,MinPrice?:number,Notes?:string,Source?:string,Attributes?:InventoryAttribute[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SasPk;
/** @type {string} */
Serial;
/** @type {number} */
Retail;
/** @type {number} */
OurPrice;
/** @type {?number} */
SalePrice;
/** @type {number} */
AE_Sale_Price;
/** @type {string} */
Status;
/** @type {string} */
SaleInfo;
/** @type {number} */
PriceA;
/** @type {number} */
PriceB;
/** @type {number} */
PriceC;
/** @type {number} */
MinPrice;
/** @type {string} */
Notes;
/** @type {string} */
Source;
/** @type {InventoryAttribute[]} */
Attributes;
}
export class QtyByLoc {
/** @param {{Location?:string,Quantity?:number,LocatorCode?:string,SerialItems?:SerialItem[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Location;
/** @type {number} */
Quantity;
/** @type {string} */
LocatorCode;
/** @type {SerialItem[]} */
SerialItems;
}
export class ActiveE3Party {
/** @param {{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,LocationQtys?:QtyByLoc[],Location_qtys?:string,WebcatChild1?:string,WebcatChild2?:string,WebcatChild3?:string,WebcatChild4?:string,Qty?:number,Qty_Available?:number,Cost?:number,Our_Price?:number,Retail?:number,Min_Price?:number,Price_A?:number,Price_B?:number,Price_C?:number,AE_Sale_Price?:number,Weight?:number,Ebay_qty?:number,Ebay_start?:number,Ebay_reserve?:number,Ebay_buyitnow?:number,WCost?:number,Margin_Perc?:number,Ebay_length?:number,Ebay_width?:number,Ebay_depth?:number,Ebay_wtmajor?:number,Ebay_wtminor?:number,Ebay?:boolean,Web?:boolean,Published?:boolean,Approval?:boolean,Call_To_Order?:boolean,Discontinued?:boolean,SellSerialsOnline?:boolean,LastUpdated?:string,InventoryAttributes?:InventoryAttribute[],ExtPk?:number,AIMCategorization?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Model;
/** @type {string} */
Sku;
/** @type {string} */
WebNumber;
/** @type {string} */
Desc;
/** @type {string} */
Mfg;
/**
* @type {string}
* @description S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory */
Type;
/** @type {string} */
Barcode;
/** @type {string[]} */
BarcodeList;
/** @type {string} */
Selcode;
/** @type {string} */
Color;
/** @type {string} */
Size;
/** @type {string} */
Web_Cat_1;
/** @type {string} */
Web_Cat_2;
/** @type {string} */
Web_Cat_3;
/** @type {string} */
Web_Cat_4;
/** @type {string} */
URL;
/** @type {string} */
Image_Small;
/** @type {string} */
Image_Medium;
/** @type {string} */
Web_Desc;
/** @type {string} */
Ebay_cat1;
/** @type {string} */
Ebay_cat2;
/** @type {string} */
Ebay_storecat1;
/** @type {string} */
Ebay_storecat2;
/** @type {string} */
Ebay_title;
/** @type {string} */
Ebay_subtitle;
/** @type {string} */
Ebay_desc;
/** @type {string} */
Ebay_template;
/** @type {string} */
Ebay_duration;
/** @type {string} */
Ebay_format;
/** @type {string} */
Ebay_paypreset;
/** @type {string} */
Ebay_shippreset;
/** @type {string} */
Ebay_shipdest;
/** @type {string} */
Ebay_image1;
/** @type {string} */
Ebay_image2;
/** @type {string} */
Ebay_image3;
/** @type {string} */
Ebay_image4;
/** @type {string} */
Ebay_image5;
/** @type {string} */
Ebay_image6;
/** @type {string} */
Ebay_image7;
/** @type {string} */
Ebay_image8;
/** @type {string} */
Ebay_image9;
/** @type {string} */
Ebay_image10;
/** @type {string} */
Ebay_image11;
/** @type {string} */
Ebay_image12;
/** @type {string} */
Ebay_image13;
/** @type {string} */
Ebay_image14;
/** @type {string} */
Ebay_image15;
/** @type {string} */
Ebay_image16;
/** @type {string} */
Ebay_image17;
/** @type {string} */
Ebay_image18;
/** @type {string} */
Ebay_image19;
/** @type {string} */
Ebay_image20;
/** @type {string} */
Ebay_image21;
/** @type {string} */
Ebay_image22;
/** @type {string} */
Ebay_image23;
/** @type {string} */
Ebay_image24;
/** @type {string} */
ProductCode;
/** @type {string} */
Dimension;
/** @type {string} */
Restricted_Qtys;
/** @type {string} */
Related_Products;
/** @type {string} */
Upsell_Products;
/** @type {string} */
Requires_Products;
/** @type {string} */
Image_Large;
/** @type {string} */
Audio_URL;
/** @type {string} */
MPN;
/** @type {string} */
Composer;
/** @type {string} */
Arranger;
/** @type {string} */
Artist;
/** @type {string} */
Voicing;
/** @type {string} */
Level;
/** @type {string} */
Sample_URL;
/** @type {string} */
TOC;
/** @type {string} */
SE_desc;
/** @type {string} */
SE_keywords;
/** @type {string} */
SE_title;
/** @type {string} */
Notes;
/** @type {string} */
Invoice_Notes;
/** @type {string} */
POS_Reminder;
/** @type {QtyByLoc[]} */
LocationQtys;
/** @type {string} */
Location_qtys;
/** @type {string} */
WebcatChild1;
/** @type {string} */
WebcatChild2;
/** @type {string} */
WebcatChild3;
/** @type {string} */
WebcatChild4;
/** @type {number} */
Qty;
/** @type {number} */
Qty_Available;
/** @type {number} */
Cost;
/** @type {number} */
Our_Price;
/** @type {number} */
Retail;
/** @type {number} */
Min_Price;
/** @type {number} */
Price_A;
/** @type {number} */
Price_B;
/** @type {number} */
Price_C;
/** @type {number} */
AE_Sale_Price;
/** @type {number} */
Weight;
/** @type {number} */
Ebay_qty;
/** @type {number} */
Ebay_start;
/** @type {number} */
Ebay_reserve;
/** @type {number} */
Ebay_buyitnow;
/** @type {number} */
WCost;
/** @type {number} */
Margin_Perc;
/** @type {number} */
Ebay_length;
/** @type {number} */
Ebay_width;
/** @type {number} */
Ebay_depth;
/** @type {number} */
Ebay_wtmajor;
/** @type {number} */
Ebay_wtminor;
/** @type {boolean} */
Ebay;
/** @type {boolean} */
Web;
/** @type {boolean} */
Published;
/** @type {boolean} */
Approval;
/** @type {boolean} */
Call_To_Order;
/** @type {boolean} */
Discontinued;
/** @type {boolean} */
SellSerialsOnline;
/** @type {string} */
LastUpdated;
/** @type {InventoryAttribute[]} */
InventoryAttributes;
/** @type {number} */
ExtPk;
/** @type {string} */
AIMCategorization;
}
export class GetActiveE3PartyResponse extends BaseResponse {
/** @param {{StartOffset?:number,RecordCount?:number,Records?:ActiveE3Party[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
StartOffset;
/** @type {number} */
RecordCount;
/** @type {ActiveE3Party[]} */
Records;
}
export class GetActiveE3PartyRequest extends BaseRequest {
/** @param {{StartOffset?:number,RecordCount?:number,InventoryType?:string,WebCategory?:string,Date?:string,Sku?:string,IncludeAttributes?:boolean,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
StartOffset;
/** @type {?number} */
RecordCount;
/**
* @type {string}
* @description Inventory, Packages, or NI. Defaults to Inventory. */
InventoryType;
/**
* @type {string}
* @description Only Items in the sent WebCategory will be returned */
WebCategory;
/**
* @type {?string}
* @description If sent, only grab 3 Party Feed records updated after the date passed. */
Date;
/**
* @type {string}
* @description If sent, only the SKU sent will be returned */
Sku;
/** @type {?boolean} */
IncludeAttributes;
}
JavaScript GetActiveE3PartyRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>