AIM Web Services

<back to all web services

ReceiveStoreToStoreTransferRequest

ReceiveStoreToStoreTransfer
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/ReceiveStoreToStoreTransfer
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExceptionInfo:
    barcode: Optional[str] = None
    description: Optional[str] = None
    base64_image: Optional[str] = None
    category: int = 0
    sub_category: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScanErrorItem(IScanItem):
    sku_pk: Optional[int] = None
    sas_pk: Optional[int] = None
    sku: Optional[str] = None
    serial: Optional[str] = None
    quantity: Decimal = decimal.Decimal(0)
    exception_info: Optional[ExceptionInfo] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReceiveStoreToStoreTransferResponse(BaseResponse):
    error_items: Optional[List[ScanErrorItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScanTransferItem(IScanItem):
    sku_pk: Optional[int] = None
    sas_pk: Optional[int] = None
    sku: Optional[str] = None
    serial: Optional[str] = None
    quantity: Decimal = decimal.Decimal(0)
    exception_info: Optional[ExceptionInfo] = None
    overship_item: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReceiveStoreToStoreTransferRequest(BaseSecureRequest):
    """
    ReceiveStoreToStoreTransferRequires active-e Inventory Service
    """

    ref_number: Optional[str] = None
    items: Optional[List[ScanTransferItem]] = None

Python ReceiveStoreToStoreTransferRequest 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/ReceiveStoreToStoreTransfer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReceiveStoreToStoreTransferRequest 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>
  <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>
  <RefNumber>String</RefNumber>
</ReceiveStoreToStoreTransferRequest>

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

<ReceiveStoreToStoreTransferResponse 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>
</ReceiveStoreToStoreTransferResponse>