AIM Web Services

<back to all web services

StoreToStoreTransferRequest

StoreToStoreTransfer
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/StoreToStoreTransfer
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* StoreToStoreTransferRequires active-e Inventory Service
*/
@DataContract
open class StoreToStoreTransferRequest : BaseSecureRequest()
{
    @DataMember
    var FromLocPk:Long? = null

    @DataMember
    var FromLocation:String? = null

    @DataMember
    var ToLocPk:Long? = null

    @DataMember
    var ToLocation:String? = null

    @DataMember
    var Items:ArrayList<ScanTransferItem> = ArrayList<ScanTransferItem>()

    @DataMember
    var IsRequest:Boolean? = null

    @DataMember
    var RequestRefNumber:String? = null

    @DataMember
    var Notes:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class ScanTransferItem : IScanItem
{
    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ExceptionInfo:ExceptionInfo? = null

    @DataMember
    var OvershipItem:Boolean? = null
}

@DataContract
open class ExceptionInfo
{
    @DataMember
    var Barcode:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var Base64Image:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var SubCategory:Int? = null
}

@DataContract
open class StoreToStoreTransferResponse : BaseResponse()
{
    @DataMember
    var RefNumber:String? = null

    @DataMember
    var ErrorItems:ArrayList<ScanErrorItem> = ArrayList<ScanErrorItem>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ScanErrorItem : IScanItem
{
    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ExceptionInfo:ExceptionInfo? = null

    @DataMember
    var ErrorMessage:String? = null
}

Kotlin StoreToStoreTransferRequest 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.

POST /api/StoreToStoreTransfer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StoreToStoreTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <FromLocPk>0</FromLocPk>
  <FromLocation>String</FromLocation>
  <IsRequest>false</IsRequest>
  <Items>
    <StoreToStoreTransferRequest.ScanTransferItem>
      <ExceptionInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Barcode>String</d4p1:Barcode>
        <d4p1:Base64Image>String</d4p1:Base64Image>
        <d4p1:Category>0</d4p1:Category>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:SubCategory>0</d4p1:SubCategory>
      </ExceptionInfo>
      <OvershipItem>false</OvershipItem>
      <Quantity>0</Quantity>
      <SasPk>0</SasPk>
      <Serial>String</Serial>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
    </StoreToStoreTransferRequest.ScanTransferItem>
  </Items>
  <Notes>String</Notes>
  <RequestRefNumber>String</RequestRefNumber>
  <ToLocPk>0</ToLocPk>
  <ToLocation>String</ToLocation>
</StoreToStoreTransferRequest>

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

<StoreToStoreTransferResponse 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>
  <ErrorItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanErrorItem>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanErrorItem>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</StoreToStoreTransferResponse>