AIM Web Services

<back to all web services

InventoryAutoPriceRequest

InventoryAutoPrice
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryAutoPrice
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class AutoPriceRecord {
    /** @param {{Id?:number,Description?:string,Category?:number,CategoryDescription?:string,SubCategory?:number,SubCategoryDescription?:string,Vendor?:number,VendorName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
    /** @type {?number} */
    Category;
    /** @type {string} */
    CategoryDescription;
    /** @type {?number} */
    SubCategory;
    /** @type {string} */
    SubCategoryDescription;
    /** @type {?number} */
    Vendor;
    /** @type {string} */
    VendorName;
}
export class InventoryAutoPriceResponse extends BaseResponse {
    /** @param {{AutoPriceRecords?:AutoPriceRecord[],MinimumPrice?:number,PriceA?:number,PriceB?:number,PriceC?:number,OurPrice?:number,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AutoPriceRecord[]} */
    AutoPriceRecords;
    /** @type {?number} */
    MinimumPrice;
    /** @type {?number} */
    PriceA;
    /** @type {?number} */
    PriceB;
    /** @type {?number} */
    PriceC;
    /** @type {?number} */
    OurPrice;
}
export class InventoryAutoPriceRequest extends BaseSecureRequest {
    /** @param {{Category?:number,SubCategory?:number,Vendor?:number,AutoPriceId?:number,MinimumPrice?:number,PriceA?:number,PriceB?:number,PriceC?:number,OurPrice?:number,RetailPrice?:number,Cost?:number,WeightedCost?:number,VendorNormalCost?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    Category;
    /** @type {?number} */
    SubCategory;
    /** @type {?number} */
    Vendor;
    /** @type {?number} */
    AutoPriceId;
    /** @type {number} */
    MinimumPrice;
    /** @type {number} */
    PriceA;
    /** @type {number} */
    PriceB;
    /** @type {number} */
    PriceC;
    /** @type {number} */
    OurPrice;
    /** @type {number} */
    RetailPrice;
    /** @type {number} */
    Cost;
    /** @type {number} */
    WeightedCost;
    /** @type {number} */
    VendorNormalCost;
}

JavaScript InventoryAutoPriceRequest 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/InventoryAutoPrice HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"AutoPriceRecords":[{"Id":0,"Description":"String","Category":0,"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Vendor":0,"VendorName":"String"}],"MinimumPrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"OurPrice":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}