AIM Web Services

<back to all web services

TransferDetailsRequest

TransferDetails
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/TransferDetails
"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 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 Transfer {
    /** @param {{RefNumber?:string,DateTime?:string,From?:LocationInfo,To?:LocationInfo,IsRequest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
    /** @type {string} */
    DateTime;
    /** @type {LocationInfo} */
    From;
    /** @type {LocationInfo} */
    To;
    /** @type {boolean} */
    IsRequest;
}
export class TransferLineItem {
    /** @param {{QtyIn?:number,QtyOut?:number,Sku?:string,Desc?:string,Notes?:string,OverShipment?:boolean,IsADBook?:boolean,SkuPk?:number,SaqPk?:number,SasPk?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    QtyIn;
    /** @type {number} */
    QtyOut;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Desc;
    /** @type {string} */
    Notes;
    /** @type {boolean} */
    OverShipment;
    /** @type {boolean} */
    IsADBook;
    /** @type {?number} */
    SkuPk;
    /** @type {?number} */
    SaqPk;
    /** @type {?number} */
    SasPk;
}
export class TransferDetailsResponse extends BaseResponse {
    /** @param {{TransferInfo?:Transfer,LineItems?:TransferLineItem[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {Transfer} */
    TransferInfo;
    /** @type {TransferLineItem[]} */
    LineItems;
}
export class TransferDetailsRequest extends BaseSecureRequest {
    /** @param {{RefNumber?:string,Mode?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
    /**
     * @type {string}
     * @description Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred. */
    Mode;
}

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

GET /api/TransferDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"TransferInfo":{"RefNumber":"String","From":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"To":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"IsRequest":false},"LineItems":[{"QtyIn":0,"QtyOut":0,"Sku":"String","Desc":"String","Notes":"String","OverShipment":false,"IsADBook":false,"SkuPk":0,"SaqPk":0,"SasPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}