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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    // @DataMember
    public Region: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

    public constructor(init?: Partial<LocationInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Transfer
{
    // @DataMember
    public RefNumber: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public From: LocationInfo;

    // @DataMember
    public To: LocationInfo;

    // @DataMember
    public IsRequest: boolean;

    public constructor(init?: Partial<Transfer>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TransferLineItem
{
    // @DataMember
    public QtyIn: number;

    // @DataMember
    public QtyOut: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Desc: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public OverShipment: boolean;

    // @DataMember
    public IsADBook: boolean;

    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SaqPk?: number;

    // @DataMember
    public SasPk?: number;

    public constructor(init?: Partial<TransferLineItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TransferDetailsResponse extends BaseResponse
{
    // @DataMember
    public TransferInfo: Transfer;

    // @DataMember
    public LineItems: TransferLineItem[];

    public constructor(init?: Partial<TransferDetailsResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description TransferDetailsRequires active-e Inventory Service */
// @DataContract
export class TransferDetailsRequest extends BaseSecureRequest
{
    // @DataMember
    public RefNumber: string;

    /** @description Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.", Name="Mode", ParameterType="query")
    public Mode: string;

    public constructor(init?: Partial<TransferDetailsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript TransferDetailsRequest 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/TransferDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}