| GET | /api/TransferDetails |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefNumber | query | string | No | |
| Mode | query | string | No | Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransferInfo | form | Transfer | No | |
| LineItems | form | List<TransferLineItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefNumber | form | string | No | |
| DateTime | form | DateTime | No | |
| From | form | LocationInfo | No | |
| To | form | LocationInfo | No | |
| IsRequest | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Desc | form | string | No | |
| ShortDesc | form | string | No | |
| Region | form | string | No | |
| Latitude | form | decimal | No | |
| Longitude | form | decimal | No | |
| InStorePickup | form | string | No | |
| Active | form | bool | No | |
| CashSaleAcct | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QtyIn | form | decimal | No | |
| QtyOut | form | decimal | No | |
| Sku | form | string | No | |
| Desc | form | string | No | |
| Notes | form | string | No | |
| OverShipment | form | bool | No | |
| IsADBook | form | bool | No | |
| SkuPk | form | long? | No | |
| SaqPk | form | long? | No | |
| SasPk | form | long? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"TransferInfo":{"RefNumber":"String","From":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"To":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"IsRequest":false},"LineItems":[{"QtyIn":0,"QtyOut":0,"Sku":"String","Desc":"String","Notes":"String","OverShipment":false,"IsADBook":false,"SkuPk":0,"SaqPk":0,"SasPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}