AIM Web Services

<back to all web services

OpenStoreToStoreTransfersRequest

OpenStoreToStoreTransfers
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/OpenStoreToStoreTransfers
"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 OpenStoreToStoreTransfersResponse extends BaseResponse {
    /** @param {{Transfers?:Transfer[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {Transfer[]} */
    Transfers;
}
export class OpenStoreToStoreTransfersRequest extends BaseSecureRequest {
    /** @param {{ToLocationId?:number,FromLocationId?:number,Mode?:string,IncludeCompleted?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description If sent, only transfers to the given location will be returned. Defaults to all locations. */
    ToLocationId;
    /**
     * @type {?number}
     * @description If sent, only transfers from the given location will be returned. Defaults to all locations. */
    FromLocationId;
    /**
     * @type {string}
     * @description Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests. */
    Mode;
    /** @type {boolean} */
    IncludeCompleted;
}

JavaScript OpenStoreToStoreTransfersRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/OpenStoreToStoreTransfers HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Transfers":[{"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}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}