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
GetActiveE3PartyRequest Parameters:
NameParameterData TypeRequiredDescription
StartOffsetqueryint?No
RecordCountqueryint?No
InventoryTypequerystringNoInventory, Packages, or NI. Defaults to Inventory.
WebCategoryquerystringNoOnly Items in the sent WebCategory will be returned
DatequerystringNoIf sent, only grab 3 Party Feed records updated after the date passed.
SkuquerystringNoIf sent, only the SKU sent will be returned
IncludeAttributesquerybool?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
GetActiveE3PartyResponse Parameters:
NameParameterData TypeRequiredDescription
StartOffsetformintNo
RecordCountformintNo
RecordsformList<ActiveE3Party>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ActiveE3Party Parameters:
NameParameterData TypeRequiredDescription
ModelformstringNo
SkuformstringNo
WebNumberformstringNo
DescformstringNo
MfgformstringNo
TypeformstringNoS is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory
BarcodeformstringNo
BarcodeListformList<string>No
SelcodeformstringNo
ColorformstringNo
SizeformstringNo
Web_Cat_1formstringNo
Web_Cat_2formstringNo
Web_Cat_3formstringNo
Web_Cat_4formstringNo
URLformstringNo
Image_SmallformstringNo
Image_MediumformstringNo
Web_DescformstringNo
Ebay_cat1formstringNo
Ebay_cat2formstringNo
Ebay_storecat1formstringNo
Ebay_storecat2formstringNo
Ebay_titleformstringNo
Ebay_subtitleformstringNo
Ebay_descformstringNo
Ebay_templateformstringNo
Ebay_durationformstringNo
Ebay_formatformstringNo
Ebay_paypresetformstringNo
Ebay_shippresetformstringNo
Ebay_shipdestformstringNo
Ebay_image1formstringNo
Ebay_image2formstringNo
Ebay_image3formstringNo
Ebay_image4formstringNo
Ebay_image5formstringNo
Ebay_image6formstringNo
Ebay_image7formstringNo
Ebay_image8formstringNo
Ebay_image9formstringNo
Ebay_image10formstringNo
Ebay_image11formstringNo
Ebay_image12formstringNo
Ebay_image13formstringNo
Ebay_image14formstringNo
Ebay_image15formstringNo
Ebay_image16formstringNo
Ebay_image17formstringNo
Ebay_image18formstringNo
Ebay_image19formstringNo
Ebay_image20formstringNo
Ebay_image21formstringNo
Ebay_image22formstringNo
Ebay_image23formstringNo
Ebay_image24formstringNo
ProductCodeformstringNo
DimensionformstringNo
Restricted_QtysformstringNo
Related_ProductsformstringNo
Upsell_ProductsformstringNo
Requires_ProductsformstringNo
Image_LargeformstringNo
Audio_URLformstringNo
MPNformstringNo
ComposerformstringNo
ArrangerformstringNo
ArtistformstringNo
VoicingformstringNo
LevelformstringNo
Sample_URLformstringNo
TOCformstringNo
SE_descformstringNo
SE_keywordsformstringNo
SE_titleformstringNo
NotesformstringNo
Invoice_NotesformstringNo
POS_ReminderformstringNo
LocationQtysformIEnumerable<QtyByLoc>No
Location_qtysformstringNo
WebcatChild1formstringNo
WebcatChild2formstringNo
WebcatChild3formstringNo
WebcatChild4formstringNo
QtyformdecimalNo
Qty_AvailableformdecimalNo
CostformdecimalNo
Our_PriceformdecimalNo
RetailformdecimalNo
Min_PriceformdecimalNo
Price_AformdecimalNo
Price_BformdecimalNo
Price_CformdecimalNo
AE_Sale_PriceformdecimalNo
WeightformdecimalNo
Ebay_qtyformdecimalNo
Ebay_startformdecimalNo
Ebay_reserveformdecimalNo
Ebay_buyitnowformdecimalNo
WCostformdecimalNo
Margin_PercformdecimalNo
Ebay_lengthformintNo
Ebay_widthformintNo
Ebay_depthformintNo
Ebay_wtmajorformintNo
Ebay_wtminorformintNo
EbayformboolNo
WebformboolNo
PublishedformboolNo
ApprovalformboolNo
Call_To_OrderformboolNo
DiscontinuedformboolNo
SellSerialsOnlineformboolNo
LastUpdatedformDateTimeNo
InventoryAttributesformIEnumerable<InventoryAttribute>No
ExtPkformlongNo
AIMCategorizationformstringNo
QtyByLoc Parameters:
NameParameterData TypeRequiredDescription
LocationformstringNo
QuantityformdecimalNo
LocatorCodeformstringNo
SerialItemsformIEnumerable<SerialItem>No
SerialItem Parameters:
NameParameterData TypeRequiredDescription
SasPkformlongNo
SerialformstringNo
RetailformdecimalNo
OurPriceformdecimalNo
SalePriceformdecimal?No
AE_Sale_PriceformdecimalNo
StatusformstringNo
SaleInfoformstringNo
PriceAformdecimalNo
PriceBformdecimalNo
PriceCformdecimalNo
MinPriceformdecimalNo
NotesformstringNo
SourceformstringNo
AttributesformIEnumerable<InventoryAttribute>No
InventoryAttribute Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo

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

HTTP + JSON

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"}}