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

// @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 ExceptionInfo
{
    // @DataMember
    public Barcode: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Base64Image: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public SubCategory?: number;

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

// @DataContract
export class ScanErrorItem implements IScanItem
{
    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ExceptionInfo: ExceptionInfo;

    // @DataMember
    public ErrorMessage: string;

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

// @DataContract
export class StoreToStoreTransferResponse extends BaseResponse
{
    // @DataMember
    public RefNumber: string;

    // @DataMember
    public ErrorItems: ScanErrorItem[];

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

// @DataContract
export class ScanTransferItem implements IScanItem
{
    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ExceptionInfo: ExceptionInfo;

    // @DataMember
    public OvershipItem: boolean;

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

/** @description StoreToStoreTransferRequires active-e Inventory Service */
// @DataContract
export class StoreToStoreTransferRequest extends BaseSecureRequest
{
    // @DataMember
    public FromLocPk?: number;

    // @DataMember
    public FromLocation: string;

    // @DataMember
    public ToLocPk?: number;

    // @DataMember
    public ToLocation: string;

    // @DataMember
    public Items: ScanTransferItem[];

    // @DataMember
    public IsRequest: boolean;

    // @DataMember
    public RequestRefNumber: string;

    // @DataMember
    public Notes: string;

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

TypeScript 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>