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
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 LocationInfo:
    id: int = 0
    desc: Optional[str] = None
    short_desc: Optional[str] = None
    region: Optional[str] = None
    latitude: Decimal = decimal.Decimal(0)
    longitude: Decimal = decimal.Decimal(0)
    in_store_pickup: Optional[str] = None
    active: bool = False
    cash_sale_acct: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Transfer:
    ref_number: Optional[str] = None
    date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    from_: Optional[LocationInfo] = field(metadata=config(field_name='from'), default=None)
    to: Optional[LocationInfo] = None
    is_request: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransferLineItem:
    qty_in: Decimal = decimal.Decimal(0)
    qty_out: Decimal = decimal.Decimal(0)
    sku: Optional[str] = None
    desc: Optional[str] = None
    notes: Optional[str] = None
    over_shipment: bool = False
    is_a_d_book: bool = False
    sku_pk: Optional[int] = None
    saq_pk: Optional[int] = None
    sas_pk: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransferDetailsResponse(BaseResponse):
    transfer_info: Optional[Transfer] = None
    line_items: Optional[List[TransferLineItem]] = None


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

    ref_number: Optional[str] = None
    # @ApiMember(DataType="string", Description="Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.", Name="Mode", ParameterType="query")
    mode: Optional[str] = None
    """
    Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.
    """

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