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
// @ts-nocheck

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName?: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress?: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status?: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class InventoryAttribute
{
    // @DataMember
    public Name?: string;

    // @DataMember
    public Value?: string;

    public constructor(init?: Partial<InventoryAttribute>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SerialItem
{
    // @DataMember
    public SasPk: number;

    // @DataMember
    public Serial?: string;

    // @DataMember
    public Retail: number;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public SalePrice?: number;

    // @DataMember
    public AE_Sale_Price: number;

    // @DataMember
    public Status?: string;

    // @DataMember
    public SaleInfo?: string;

    // @DataMember
    public PriceA: number;

    // @DataMember
    public PriceB: number;

    // @DataMember
    public PriceC: number;

    // @DataMember
    public MinPrice: number;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public Source?: string;

    // @DataMember
    public Attributes?: InventoryAttribute[];

    public constructor(init?: Partial<SerialItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QtyByLoc
{
    // @DataMember
    public Location?: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public LocatorCode?: string;

    // @DataMember
    public SerialItems?: SerialItem[];

    public constructor(init?: Partial<QtyByLoc>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ActiveE3Party
{
    // @DataMember
    public Model?: string;

    // @DataMember
    public Sku?: string;

    // @DataMember
    public WebNumber?: string;

    // @DataMember
    public Desc?: string;

    // @DataMember
    public Mfg?: string;

    /** @description 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 Type?: string;

    // @DataMember
    public Barcode?: string;

    // @DataMember
    public BarcodeList?: string[];

    // @DataMember
    public Selcode?: string;

    // @DataMember
    public Color?: string;

    // @DataMember
    public Size?: string;

    // @DataMember
    public Web_Cat_1?: string;

    // @DataMember
    public Web_Cat_2?: string;

    // @DataMember
    public Web_Cat_3?: string;

    // @DataMember
    public Web_Cat_4?: string;

    // @DataMember
    public URL?: string;

    // @DataMember
    public Image_Small?: string;

    // @DataMember
    public Image_Medium?: string;

    // @DataMember
    public Web_Desc?: string;

    // @DataMember
    public Ebay_cat1?: string;

    // @DataMember
    public Ebay_cat2?: string;

    // @DataMember
    public Ebay_storecat1?: string;

    // @DataMember
    public Ebay_storecat2?: string;

    // @DataMember
    public Ebay_title?: string;

    // @DataMember
    public Ebay_subtitle?: string;

    // @DataMember
    public Ebay_desc?: string;

    // @DataMember
    public Ebay_template?: string;

    // @DataMember
    public Ebay_duration?: string;

    // @DataMember
    public Ebay_format?: string;

    // @DataMember
    public Ebay_paypreset?: string;

    // @DataMember
    public Ebay_shippreset?: string;

    // @DataMember
    public Ebay_shipdest?: string;

    // @DataMember
    public Ebay_image1?: string;

    // @DataMember
    public Ebay_image2?: string;

    // @DataMember
    public Ebay_image3?: string;

    // @DataMember
    public Ebay_image4?: string;

    // @DataMember
    public Ebay_image5?: string;

    // @DataMember
    public Ebay_image6?: string;

    // @DataMember
    public Ebay_image7?: string;

    // @DataMember
    public Ebay_image8?: string;

    // @DataMember
    public Ebay_image9?: string;

    // @DataMember
    public Ebay_image10?: string;

    // @DataMember
    public Ebay_image11?: string;

    // @DataMember
    public Ebay_image12?: string;

    // @DataMember
    public Ebay_image13?: string;

    // @DataMember
    public Ebay_image14?: string;

    // @DataMember
    public Ebay_image15?: string;

    // @DataMember
    public Ebay_image16?: string;

    // @DataMember
    public Ebay_image17?: string;

    // @DataMember
    public Ebay_image18?: string;

    // @DataMember
    public Ebay_image19?: string;

    // @DataMember
    public Ebay_image20?: string;

    // @DataMember
    public Ebay_image21?: string;

    // @DataMember
    public Ebay_image22?: string;

    // @DataMember
    public Ebay_image23?: string;

    // @DataMember
    public Ebay_image24?: string;

    // @DataMember
    public ProductCode?: string;

    // @DataMember
    public Dimension?: string;

    // @DataMember
    public Restricted_Qtys?: string;

    // @DataMember
    public Related_Products?: string;

    // @DataMember
    public Upsell_Products?: string;

    // @DataMember
    public Requires_Products?: string;

    // @DataMember
    public Image_Large?: string;

    // @DataMember
    public Audio_URL?: string;

    // @DataMember
    public MPN?: string;

    // @DataMember
    public Composer?: string;

    // @DataMember
    public Arranger?: string;

    // @DataMember
    public Artist?: string;

    // @DataMember
    public Voicing?: string;

    // @DataMember
    public Level?: string;

    // @DataMember
    public Sample_URL?: string;

    // @DataMember
    public TOC?: string;

    // @DataMember
    public SE_desc?: string;

    // @DataMember
    public SE_keywords?: string;

    // @DataMember
    public SE_title?: string;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public Invoice_Notes?: string;

    // @DataMember
    public POS_Reminder?: string;

    // @DataMember
    public LocationQtys?: QtyByLoc[];

    // @DataMember
    public Location_qtys?: string;

    // @DataMember
    public WebcatChild1?: string;

    // @DataMember
    public WebcatChild2?: string;

    // @DataMember
    public WebcatChild3?: string;

    // @DataMember
    public WebcatChild4?: string;

    // @DataMember
    public Qty: number;

    // @DataMember
    public Qty_Available: number;

    // @DataMember
    public Cost: number;

    // @DataMember
    public Our_Price: number;

    // @DataMember
    public Retail: number;

    // @DataMember
    public Min_Price: number;

    // @DataMember
    public Price_A: number;

    // @DataMember
    public Price_B: number;

    // @DataMember
    public Price_C: number;

    // @DataMember
    public AE_Sale_Price: number;

    // @DataMember
    public Weight: number;

    // @DataMember
    public Ebay_qty: number;

    // @DataMember
    public Ebay_start: number;

    // @DataMember
    public Ebay_reserve: number;

    // @DataMember
    public Ebay_buyitnow: number;

    // @DataMember
    public WCost: number;

    // @DataMember
    public Margin_Perc: number;

    // @DataMember
    public Ebay_length: number;

    // @DataMember
    public Ebay_width: number;

    // @DataMember
    public Ebay_depth: number;

    // @DataMember
    public Ebay_wtmajor: number;

    // @DataMember
    public Ebay_wtminor: number;

    // @DataMember
    public Ebay: boolean;

    // @DataMember
    public Web: boolean;

    // @DataMember
    public Published: boolean;

    // @DataMember
    public Approval: boolean;

    // @DataMember
    public Call_To_Order: boolean;

    // @DataMember
    public Discontinued: boolean;

    // @DataMember
    public SellSerialsOnline: boolean;

    // @DataMember
    public LastUpdated: string;

    // @DataMember
    public InventoryAttributes?: InventoryAttribute[];

    // @DataMember
    public ExtPk: number;

    // @DataMember
    public AIMCategorization?: string;

    public constructor(init?: Partial<ActiveE3Party>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetActiveE3PartyResponse extends BaseResponse
{
    // @DataMember
    public StartOffset: number;

    // @DataMember
    public RecordCount: number;

    // @DataMember
    public Records?: ActiveE3Party[];

    public constructor(init?: Partial<GetActiveE3PartyResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetActiveE3PartyRequires active-e Inventory Service or active-e Vortx E-Commerce or active-e 3rd Party E-Commerce */
// @DataContract
export class GetActiveE3PartyRequest extends BaseRequest
{
    // @DataMember
    public StartOffset?: number;

    // @DataMember
    public RecordCount?: number;

    /** @description Inventory, Packages, or NI. Defaults to Inventory. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Inventory, Packages, or NI. Defaults to Inventory.", Name="InventoryType", ParameterType="query")
    public InventoryType?: string;

    /** @description 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 WebCategory?: string;

    /** @description If sent, only grab 3 Party Feed records updated after the date passed. Note that a date *and* time can be be passed into this field. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, only grab 3 Party Feed records updated after the date passed. Note that a date *and* time can be be passed into this field.", Format="datetime", Name="Date", ParameterType="query")
    public Date?: string;

    /** @description 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 Sku?: string;

    // @DataMember
    public IncludeAttributes?: boolean;

    public constructor(init?: Partial<GetActiveE3PartyRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetActiveE3PartyRequest DTOs

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>