AIM Web Services

<back to all web services

InventoryQtyRequest

InventoryQty
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:
POST, GET/api/InventoryQty
"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 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 LocationInfo {
    /** @param {{Id?:number,Desc?:string,ShortDesc?:string,Region?:string,Latitude?:number,Longitude?:number,InStorePickup?:string,Active?:boolean,CashSaleAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ShortDesc;
    /** @type {string} */
    Region;
    /** @type {number} */
    Latitude;
    /** @type {number} */
    Longitude;
    /** @type {string} */
    InStorePickup;
    /** @type {boolean} */
    Active;
    /** @type {?number} */
    CashSaleAcct;
}
export class InventoryQtyByLocation {
    /** @param {{LocationInfo?:LocationInfo,QtyAvail?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {LocationInfo} */
    LocationInfo;
    /** @type {number} */
    QtyAvail;
}
export class InventoryQtyByVariant {
    /** @param {{Sku?:string,AeVariantName?:string,Locations?:InventoryQtyByLocation[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Sku;
    /** @type {string} */
    AeVariantName;
    /** @type {InventoryQtyByLocation[]} */
    Locations;
}
export class InventoryQtyResponse extends BaseResponse {
    /** @param {{Variants?:InventoryQtyByVariant[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {InventoryQtyByVariant[]} */
    Variants;
}
export class InventoryQtyRequest extends BaseRequest {
    /** @param {{Pk?:number,Model?:string,AeId?:string,SkuPk?:number,Sku?:string,SendVendorQtyAsSeperateLocation?:boolean,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    Pk;
    /** @type {string} */
    Model;
    /** @type {string} */
    AeId;
    /** @type {?number} */
    SkuPk;
    /** @type {string} */
    Sku;
    /** @type {boolean} */
    SendVendorQtyAsSeperateLocation;
}

JavaScript InventoryQtyRequest 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.

POST /api/InventoryQty HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InventoryQtyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AeId>String</AeId>
  <Model>String</Model>
  <Pk>0</Pk>
  <SendVendorQtyAsSeperateLocation>false</SendVendorQtyAsSeperateLocation>
  <Sku>String</Sku>
  <SkuPk>0</SkuPk>
</InventoryQtyRequest>

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

<InventoryQtyResponse 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>
  <Variants>
    <InventoryQtyResponse.InventoryQtyByVariant i:nil="true" />
  </Variants>
</InventoryQtyResponse>