AIM Web Services

<back to all web services

InventoryHistoryRequest

InventoryHistory
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryHistory

// @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;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (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 InventoryHistoryObj
{
    // @DataMember
    public DateVal: string;

    // @DataMember
    public SDateVal: string;

    // @DataMember
    public Acct: number;

    // @DataMember
    public Sub: number;

    // @DataMember
    public CusName: string;

    // @DataMember
    public Qty: number;

    // @DataMember
    public Amt: number;

    // @DataMember
    public Ref: string;

    // @DataMember
    public Type: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Employee: string;

    // @DataMember
    public EmployeeName: string;

    // @DataMember
    public Stloc: string;

    // @DataMember
    public Dunn: string;

    // @DataMember
    public SoldDesc: string;

    // @DataMember
    public Tcp_rtncode: string;

    // @DataMember
    public TableName: string;

    // @DataMember
    public TraPk?: number;

    // @DataMember
    public CusPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public SaqPk?: number;

    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SadPk?: number;

    // @DataMember
    public TablePk: number;

    // @DataMember
    public Description: string;

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

// @DataContract
export class ImageInfo
{
    // @DataMember
    public Url: string;

    // @DataMember
    public ImageStream: string;

    // @DataMember
    public ImageSize: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public UriPk?: number;

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

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

    // @DataMember
    public Value: string;

    // @DataMember
    public Priority: number;

    /** @description 1 is 'Don't Send to Web', 2 is 'Guided Navigation' */
    // @DataMember
    // @ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Guided Navigation'", Name="WebType", ParameterType="query")
    public WebType: number;

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

// @DataContract
export class LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    // @DataMember
    public Region: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

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

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

    // @DataMember
    public Serial: string;

    // @DataMember
    public Retail: number;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public SalePrice?: 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 ActiveEPrice: number;

    // @DataMember
    public AllowPriceChange: boolean;

    // @DataMember
    public Cost?: number;

    // @DataMember
    public WeightedCost?: number;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Attributes: InventoryDetailAttribute[];

    // @DataMember
    public Images: ImageInfo[];

    // @DataMember
    public HasImages: boolean;

    // @DataMember
    public IsActiveeHoldback: boolean;

    // @DataMember
    public CustomerAcct?: number;

    // @DataMember
    public AvailableForSTR: boolean;

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

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

    // @DataMember
    public Sku: string;

    // @DataMember
    public Mfg: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public AvailableQty: number;

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

// @DataContract
export class InventoryDetailByLocation
{
    // @DataMember
    public SaqPk: number;

    // @DataMember
    public LocationInfo: LocationInfo;

    // @DataMember
    public Serials: InventoryDetailBySerial[];

    // @DataMember
    public Substitutes: InventoryDetailSubstitute[];

    // @DataMember
    public Retail: number;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public SalePrice?: number;

    // @DataMember
    public SaleInfo: string;

    // @DataMember
    public PriceA: number;

    // @DataMember
    public PriceB: number;

    // @DataMember
    public PriceC: number;

    // @DataMember
    public MinPrice: number;

    // @DataMember
    public ActiveEPrice: number;

    // @DataMember
    public CustomerPrice: number;

    // @DataMember
    public AllowPriceChange: boolean;

    // @DataMember
    public Qty: number;

    // @DataMember
    public QtyAvail: number;

    // @DataMember
    public ActiveeHoldbackQty: number;

    // @DataMember
    public ReorderMin: number;

    // @DataMember
    public ReorderMax: number;

    // @DataMember
    public AverageCost?: number;

    // @DataMember
    public WeightedCost?: number;

    // @DataMember
    public Locator: string;

    // @DataMember
    public SelectionCode: string;

    // @DataMember
    public SelectionCodeDescription: string;

    // @DataMember
    public Spiff: number;

    // @DataMember
    public CurrentSpotCheckQty?: number;

    // @DataMember
    public QtyOut: number;

    // @DataMember
    public QtyOnOrder: number;

    // @DataMember
    public AvailableForSTR: number;

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

// @DataContract
export class InventoryDetailByVariant
{
    // @DataMember
    public SkuPk: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public VendorCost?: number;

    // @DataMember
    public VendorName: string;

    // @DataMember
    public Attributes: InventoryDetailAttribute[];

    // @DataMember
    public LocationDetails: InventoryDetailByLocation[];

    // @DataMember
    public Images: ImageInfo[];

    // @DataMember
    public HasImages: boolean;

    // @DataMember
    public Barcodes: string[];

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

// @DataContract
export class AddOnDetail
{
    // @DataMember
    public SadPk: number;

    // @DataMember
    public SkuPk: number;

    // @DataMember
    public CatPk: number;

    // @DataMember
    public SubPk: number;

    // @DataMember
    public Item: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Price: number;

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

// @DataContract
export class ActiveEInfo
{
    // @DataMember
    public Dimension: string;

    // @DataMember
    public WebDescription: string;

    // @DataMember
    public Summary: string;

    // @DataMember
    public SETitle: string;

    // @DataMember
    public SEDescription: string;

    // @DataMember
    public SEKeywords: string;

    // @DataMember
    public SEAltText: string;

    // @DataMember
    public SEHtmlFreeText: string;

    // @DataMember
    public Unpublished: boolean;

    // @DataMember
    public FreeShipping: boolean;

    // @DataMember
    public IsFeatured: boolean;

    // @DataMember
    public WebCategoryIds: number[];

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

// @DataContract
export class InventoryDetailResponse extends BaseResponse
{
    // @DataMember
    public SadPk: number;

    // @DataMember
    public InvType: string;

    // @DataMember
    public Model: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Mfg: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public CategoryDescription: string;

    // @DataMember
    public SubCategory: number;

    // @DataMember
    public SubCategoryDescription: string;

    // @DataMember
    public SelectionCode: string;

    // @DataMember
    public SelectionCodeDescription: string;

    // @DataMember
    public SellSerialsOnline: boolean;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Images: ImageInfo[];

    // @DataMember
    public HasImages: boolean;

    // @DataMember
    public VariantDetails: InventoryDetailByVariant[];

    // @DataMember
    public AddOns: AddOnDetail[];

    // @DataMember
    public ActiveEInfo: ActiveEInfo;

    // @DataMember
    public Weight: number;

    // @DataMember
    public Unit: string;

    // @DataMember
    public ShipCharge: number;

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

// @DataContract
export class InventoryHistoryResponse extends BaseResponse
{
    // @DataMember
    // @ApiMember(Name="HistoryRecords", ParameterType="body")
    public HistoryRecords: InventoryHistoryObj[];

    // @DataMember
    // @ApiMember(Name="InventoryDetail", ParameterType="body")
    public InventoryDetail: InventoryDetailResponse;

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

/** @description InventoryHistoryRequires active-e Inventory Service */
// @DataContract
export class InventoryHistoryRequest extends BaseSecureRequest
{
    // @DataMember
    public LocId?: number;

    // @DataMember
    public Item: string;

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

TypeScript InventoryHistoryRequest 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/InventoryHistory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HistoryRecords":[{"Acct":0,"Sub":0,"CusName":"String","Qty":0,"Amt":0,"Ref":"String","Type":"String","Serial":"String","Employee":"String","EmployeeName":"String","Stloc":"String","Dunn":"String","SoldDesc":"String","Tcp_rtncode":"String","TableName":"String","TraPk":0,"CusPk":0,"SasPk":0,"SaqPk":0,"SkuPk":0,"SadPk":0,"TablePk":0,"Description":"String"}],"InventoryDetail":{"SadPk":0,"InvType":"String","Model":"String","Description":"String","Mfg":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","SelectionCode":"String","SelectionCodeDescription":"String","SellSerialsOnline":false,"Notes":"String","Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"HasImages":true,"VariantDetails":[{}],"AddOns":[{}],"ActiveEInfo":{"Dimension":"String","WebDescription":"String","Summary":"String","SETitle":"String","SEDescription":"String","SEKeywords":"String","SEAltText":"String","SEHtmlFreeText":"String","Unpublished":false,"FreeShipping":false,"IsFeatured":false,"WebCategoryIds":[0]},"Weight":0,"Unit":"String","ShipCharge":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}