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