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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class LocationInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string ShortDesc { get; set; }

        [DataMember]
        public virtual string Region { get; set; }

        [DataMember]
        public virtual decimal Latitude { get; set; }

        [DataMember]
        public virtual decimal Longitude { get; set; }

        [DataMember]
        public virtual string InStorePickup { get; set; }

        [DataMember]
        public virtual bool Active { get; set; }

        [DataMember]
        public virtual int? CashSaleAcct { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")]
        public virtual string OAuthToken { get; set; }

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }
    }

    [DataContract]
    public partial class Transfer
    {
        [DataMember]
        public virtual string RefNumber { get; set; }

        [DataMember]
        public virtual DateTime DateTime { get; set; }

        [DataMember]
        public virtual LocationInfo From { get; set; }

        [DataMember]
        public virtual LocationInfo To { get; set; }

        [DataMember]
        public virtual bool IsRequest { get; set; }
    }

    ///<summary>
    ///TransferDetailsRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class TransferDetailsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual string RefNumber { get; set; }

        ///<summary>
        ///Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.", Name="Mode", ParameterType="query")]
        public virtual string Mode { get; set; }
    }

    [DataContract]
    public partial class TransferDetailsResponse
        : BaseResponse
    {
        public TransferDetailsResponse()
        {
            LineItems = new List<TransferLineItem>{};
        }

        [DataMember]
        public virtual Transfer TransferInfo { get; set; }

        [DataMember]
        public virtual List<TransferLineItem> LineItems { get; set; }
    }

    [DataContract]
    public partial class TransferLineItem
    {
        [DataMember]
        public virtual decimal QtyIn { get; set; }

        [DataMember]
        public virtual decimal QtyOut { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string Desc { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual bool OverShipment { get; set; }

        [DataMember]
        public virtual bool IsADBook { get; set; }

        [DataMember]
        public virtual long? SkuPk { get; set; }

        [DataMember]
        public virtual long? SaqPk { get; set; }

        [DataMember]
        public virtual long? SasPk { get; set; }
    }

}

C# 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>