| GET | /api/OpenStoreToStoreTransfers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ToLocationId | query | integer | No | If sent, only transfers to the given location will be returned. Defaults to all locations. |
| FromLocationId | query | integer | No | If sent, only transfers from the given location will be returned. Defaults to all locations. |
| Mode | query | string | No | Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests. |
| IncludeCompleted | query | bool | No |
| 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 |
|---|---|---|---|---|
| Transfers | form | List<Transfer> | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/OpenStoreToStoreTransfers HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Transfers":[{"RefNumber":"String","From":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false},"To":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false},"IsRequest":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}