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;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: 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 .xml suffix or ?format=xml

HTTP + 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>