AIM 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:
Name	Parameter	Data Type	Required	Description
StartOffset	query	int?	No
RecordCount	query	int?	No
InventoryType	query	string	No	Inventory, Packages, or NI. Defaults to Inventory.
WebCategory	query	string	No	Only Items in the sent WebCategory will be returned
Date	query	string	No	If sent, only grab 3 Party Feed records updated after the date passed.
Sku	query	string	No	If sent, only the SKU sent will be returned
IncludeAttributes	query	bool?	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**GetActiveE3PartyResponse** Parameters:
Name	Parameter	Data Type	Required
StartOffset	form	int	No
RecordCount	form	int	No
Records	form	List<ActiveE3Party>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**ActiveE3Party** Parameters:
Name	Parameter	Data Type	Required	Description
Model	form	string	No
Sku	form	string	No
WebNumber	form	string	No
Desc	form	string	No
Mfg	form	string	No
Type	form	string	No	S is serialized, T is Title/Media, A is all other Accessories, P is packages, N is Non-Inventory
Barcode	form	string	No
BarcodeList	form	List<string>	No
Selcode	form	string	No
Color	form	string	No
Size	form	string	No
Web_Cat_1	form	string	No
Web_Cat_2	form	string	No
Web_Cat_3	form	string	No
Web_Cat_4	form	string	No
URL	form	string	No
Image_Small	form	string	No
Image_Medium	form	string	No
Web_Desc	form	string	No
Ebay_cat1	form	string	No
Ebay_cat2	form	string	No
Ebay_storecat1	form	string	No
Ebay_storecat2	form	string	No
Ebay_title	form	string	No
Ebay_subtitle	form	string	No
Ebay_desc	form	string	No
Ebay_template	form	string	No
Ebay_duration	form	string	No
Ebay_format	form	string	No
Ebay_paypreset	form	string	No
Ebay_shippreset	form	string	No
Ebay_shipdest	form	string	No
Ebay_image1	form	string	No
Ebay_image2	form	string	No
Ebay_image3	form	string	No
Ebay_image4	form	string	No
Ebay_image5	form	string	No
Ebay_image6	form	string	No
Ebay_image7	form	string	No
Ebay_image8	form	string	No
Ebay_image9	form	string	No
Ebay_image10	form	string	No
Ebay_image11	form	string	No
Ebay_image12	form	string	No
Ebay_image13	form	string	No
Ebay_image14	form	string	No
Ebay_image15	form	string	No
Ebay_image16	form	string	No
Ebay_image17	form	string	No
Ebay_image18	form	string	No
Ebay_image19	form	string	No
Ebay_image20	form	string	No
Ebay_image21	form	string	No
Ebay_image22	form	string	No
Ebay_image23	form	string	No
Ebay_image24	form	string	No
ProductCode	form	string	No
Dimension	form	string	No
Restricted_Qtys	form	string	No
Related_Products	form	string	No
Upsell_Products	form	string	No
Requires_Products	form	string	No
Image_Large	form	string	No
Audio_URL	form	string	No
MPN	form	string	No
Composer	form	string	No
Arranger	form	string	No
Artist	form	string	No
Voicing	form	string	No
Level	form	string	No
Sample_URL	form	string	No
TOC	form	string	No
SE_desc	form	string	No
SE_keywords	form	string	No
SE_title	form	string	No
Notes	form	string	No
Invoice_Notes	form	string	No
POS_Reminder	form	string	No
LocationQtys	form	IEnumerable<QtyByLoc>	No
Location_qtys	form	string	No
WebcatChild1	form	string	No
WebcatChild2	form	string	No
WebcatChild3	form	string	No
WebcatChild4	form	string	No
Qty	form	decimal	No
Qty_Available	form	decimal	No
Cost	form	decimal	No
Our_Price	form	decimal	No
Retail	form	decimal	No
Min_Price	form	decimal	No
Price_A	form	decimal	No
Price_B	form	decimal	No
Price_C	form	decimal	No
AE_Sale_Price	form	decimal	No
Weight	form	decimal	No
Ebay_qty	form	decimal	No
Ebay_start	form	decimal	No
Ebay_reserve	form	decimal	No
Ebay_buyitnow	form	decimal	No
WCost	form	decimal	No
Margin_Perc	form	decimal	No
Ebay_length	form	int	No
Ebay_width	form	int	No
Ebay_depth	form	int	No
Ebay_wtmajor	form	int	No
Ebay_wtminor	form	int	No
Ebay	form	bool	No
Web	form	bool	No
Published	form	bool	No
Approval	form	bool	No
Call_To_Order	form	bool	No
Discontinued	form	bool	No
SellSerialsOnline	form	bool	No
LastUpdated	form	DateTime	No
InventoryAttributes	form	IEnumerable<InventoryAttribute>	No
ExtPk	form	long	No
AIMCategorization	form	string	No

**QtyByLoc** Parameters:
Name	Parameter	Data Type	Required
Location	form	string	No
Quantity	form	decimal	No
LocatorCode	form	string	No
SerialItems	form	IEnumerable<SerialItem>	No

**SerialItem** Parameters:
Name	Parameter	Data Type	Required
SasPk	form	long	No
Serial	form	string	No
Retail	form	decimal	No
OurPrice	form	decimal	No
SalePrice	form	decimal?	No
AE_Sale_Price	form	decimal	No
Status	form	string	No
SaleInfo	form	string	No
PriceA	form	decimal	No
PriceB	form	decimal	No
PriceC	form	decimal	No
MinPrice	form	decimal	No
Notes	form	string	No
Source	form	string	No
Attributes	form	IEnumerable<InventoryAttribute>	No

**InventoryAttribute** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

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>

AIM Web Services

GetActiveE3PartyRequest

GetActiveE3Party Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce

HTTP + XML

GetActiveE3Party
Requires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce