| GET | /api/TransferDetails |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/**
* @type {string}
* @description The OAuthToken token return by AeServices30 */
OAuthToken;
/**
* @type {string}
* @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
DeviceId;
/**
* @type {string}
* @description An identifier for your integration */
AppId;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The Login Token return by the Security API. Required for secured calls. */
Token;
}
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,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?: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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TransferDetailsResponse 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>
<LineItems>
<TransferLineItem>
<Desc>String</Desc>
<IsADBook>false</IsADBook>
<Notes>String</Notes>
<OverShipment>false</OverShipment>
<QtyIn>0</QtyIn>
<QtyOut>0</QtyOut>
<SaqPk>0</SaqPk>
<SasPk>0</SasPk>
<Sku>String</Sku>
<SkuPk>0</SkuPk>
</TransferLineItem>
</LineItems>
<TransferInfo>
<DateTime>0001-01-01T00:00:00</DateTime>
<From xmlns:d3p1="http://schemas.datacontract.org/2004/07/AIM">
<d3p1:Active>false</d3p1:Active>
<d3p1:CashSaleAcct>0</d3p1:CashSaleAcct>
<d3p1:Desc>String</d3p1:Desc>
<d3p1:Id>0</d3p1:Id>
<d3p1:InStorePickup>String</d3p1:InStorePickup>
<d3p1:Latitude>0</d3p1:Latitude>
<d3p1:Longitude>0</d3p1:Longitude>
<d3p1:Region>String</d3p1:Region>
<d3p1:ShortDesc>String</d3p1:ShortDesc>
</From>
<IsRequest>false</IsRequest>
<RefNumber>String</RefNumber>
<To xmlns:d3p1="http://schemas.datacontract.org/2004/07/AIM">
<d3p1:Active>false</d3p1:Active>
<d3p1:CashSaleAcct>0</d3p1:CashSaleAcct>
<d3p1:Desc>String</d3p1:Desc>
<d3p1:Id>0</d3p1:Id>
<d3p1:InStorePickup>String</d3p1:InStorePickup>
<d3p1:Latitude>0</d3p1:Latitude>
<d3p1:Longitude>0</d3p1:Longitude>
<d3p1:Region>String</d3p1:Region>
<d3p1:ShortDesc>String</d3p1:ShortDesc>
</To>
</TransferInfo>
</TransferDetailsResponse>