AIM Web Services

<back to all web services

StockCheckRequest

StockCheck
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/api/StockCheck
"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 StockCheckErrorItem {
    /** @param {{SKU?:string,LocationId?:number,SerialNumber?:string,QtyRequested?:number,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SKU;
    /** @type {?number} */
    LocationId;
    /** @type {string} */
    SerialNumber;
    /** @type {?number} */
    QtyRequested;
    /** @type {string} */
    Message;
}
export class StockCheckResponse extends BaseResponse {
    /** @param {{EverythingAvailable?:boolean,OutOfStockItems?:StockCheckErrorItem[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    EverythingAvailable;
    /** @type {StockCheckErrorItem[]} */
    OutOfStockItems;
}
export class StockCheckItem {
    /** @param {{SKU?:string,LocationId?:number,SerialNumber?:string,QtyRequested?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SKU;
    /** @type {?number} */
    LocationId;
    /** @type {string} */
    SerialNumber;
    /** @type {?number} */
    QtyRequested;
}
export class StockCheckRequest extends BaseRequest {
    /** @param {{Items?:StockCheckItem[],ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {StockCheckItem[]} */
    Items;
}

JavaScript StockCheckRequest 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/StockCheck HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StockCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <Items>
    <StockCheckItem>
      <LocationId>0</LocationId>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckItem>
  </Items>
</StockCheckRequest>

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

<StockCheckResponse 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>
  <EverythingAvailable>false</EverythingAvailable>
  <OutOfStockItems>
    <StockCheckErrorItem>
      <LocationId>0</LocationId>
      <Message>String</Message>
      <QtyRequested>0</QtyRequested>
      <SKU>String</SKU>
      <SerialNumber>String</SerialNumber>
    </StockCheckErrorItem>
  </OutOfStockItems>
</StockCheckResponse>