| 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}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Model;
/** @type {string} */
Sku;
/** @type {string} */
WebNumber;
/** @type {string} */
Desc;
/** @type {string} */
Mfg;
/** @type {string} */
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;
}
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 .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}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}