AIM Web Services

<back to all web services

TransferInventoryOutRequest

TransferInventoryOut
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/TransferInventoryOut
"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 ExceptionInfo {
    /** @param {{Barcode?:string,Description?:string,Base64Image?:string,Category?:number,SubCategory?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Barcode;
    /** @type {string} */
    Description;
    /** @type {string} */
    Base64Image;
    /** @type {number} */
    Category;
    /** @type {?number} */
    SubCategory;
}
export class ScanErrorItem {
    /** @param {{SkuPk?:number,SasPk?:number,Sku?:string,Serial?:string,Quantity?:number,ExceptionInfo?:ExceptionInfo,ErrorMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    SkuPk;
    /** @type {?number} */
    SasPk;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Serial;
    /** @type {number} */
    Quantity;
    /** @type {ExceptionInfo} */
    ExceptionInfo;
    /** @type {string} */
    ErrorMessage;
}
export class TransferInventoryOutResponse extends BaseResponse {
    /** @param {{RefNumber?:string,ErrorItems?:ScanErrorItem[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
    /** @type {ScanErrorItem[]} */
    ErrorItems;
}
export class ScanTransferOutItem {
    /** @param {{SkuPk?:number,SasPk?:number,Sku?:string,Serial?:string,Quantity?:number,ExceptionInfo?:ExceptionInfo,Pending?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    SkuPk;
    /** @type {?number} */
    SasPk;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Serial;
    /** @type {number} */
    Quantity;
    /** @type {ExceptionInfo} */
    ExceptionInfo;
    /** @type {boolean} */
    Pending;
}
export class TransferInventoryOutRequest extends BaseSecureRequest {
    /** @param {{LocationPk?:number,ReasonCategory?:number,VendorNumber?:number,CustomerAcct?:number,RMA?:string,Items?:ScanTransferOutItem[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    LocationPk;
    /** @type {number} */
    ReasonCategory;
    /** @type {?number} */
    VendorNumber;
    /** @type {?number} */
    CustomerAcct;
    /** @type {string} */
    RMA;
    /** @type {ScanTransferOutItem[]} */
    Items;
}

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

<TransferInventoryOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Items>
    <TransferInventoryOutRequest.ScanTransferOutItem>
      <ExceptionInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Barcode>String</d4p1:Barcode>
        <d4p1:Base64Image>String</d4p1:Base64Image>
        <d4p1:Category>0</d4p1:Category>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:SubCategory>0</d4p1:SubCategory>
      </ExceptionInfo>
      <Pending>false</Pending>
      <Quantity>0</Quantity>
      <SasPk>0</SasPk>
      <Serial>String</Serial>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
    </TransferInventoryOutRequest.ScanTransferOutItem>
  </Items>
  <LocationPk>0</LocationPk>
  <RMA>String</RMA>
  <ReasonCategory>0</ReasonCategory>
  <VendorNumber>0</VendorNumber>
</TransferInventoryOutRequest>

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

<TransferInventoryOutResponse 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>
  <ErrorItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanErrorItem>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanErrorItem>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</TransferInventoryOutResponse>