AIM Web Services

<back to all web services

ReceiveStoreToStoreTransferRequest

ReceiveStoreToStoreTransfer
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/ReceiveStoreToStoreTransfer
"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 ReceiveStoreToStoreTransferResponse extends BaseResponse {
    /** @param {{ErrorItems?:ScanErrorItem[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ScanErrorItem[]} */
    ErrorItems;
}
export class ScanTransferItem {
    /** @param {{SkuPk?:number,SasPk?:number,Sku?:string,Serial?:string,Quantity?:number,ExceptionInfo?:ExceptionInfo,OvershipItem?: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} */
    OvershipItem;
}
export class ReceiveStoreToStoreTransferRequest extends BaseSecureRequest {
    /** @param {{RefNumber?:string,Items?:ScanTransferItem[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
    /** @type {ScanTransferItem[]} */
    Items;
}

JavaScript ReceiveStoreToStoreTransferRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/ReceiveStoreToStoreTransfer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RefNumber":"String","Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"OvershipItem":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorItems":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}