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
StoreToStoreTransferRequest Parameters:
NameParameterData TypeRequiredDescription
FromLocPkbodylong?No
FromLocationbodystringNo
ToLocPkbodylong?No
ToLocationbodystringNo
ItemsbodyList<ScanTransferItem>No
IsRequestbodyboolNo
RequestRefNumberbodystringNo
NotesbodystringNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ScanTransferItem Parameters:
NameParameterData TypeRequiredDescription
SkuPkformlong?No
SasPkformlong?No
SkuformstringNo
SerialformstringNo
QuantityformdecimalNo
ExceptionInfoformExceptionInfoNo
OvershipItemformboolNo
ExceptionInfo Parameters:
NameParameterData TypeRequiredDescription
BarcodeformstringNo
DescriptionformstringNo
Base64ImageformstringNo
CategoryformintNo
SubCategoryformint?No
StoreToStoreTransferResponse Parameters:
NameParameterData TypeRequiredDescription
RefNumberformstringNo
ErrorItemsformList<ScanErrorItem>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ScanErrorItem Parameters:
NameParameterData TypeRequiredDescription
SkuPkformlong?No
SasPkformlong?No
SkuformstringNo
SerialformstringNo
QuantityformdecimalNo
ExceptionInfoformExceptionInfoNo
ErrorMessageformstringNo

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>