| GET | /api/ShippingAddressLookup |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Acct | query | int? | No | Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter. |
| ShipId | query | long? | No | Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter. |
| 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 |
|---|---|---|---|---|
| ShipTos | form | List<ShipToInfo> | 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 |
|---|---|---|---|---|
| Id | form | long | No | |
| Name | form | string | No | |
| Attention | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| Country | form | string | No | |
| form | string | No | ||
| Phone | form | string | No | |
| Phone2 | form | string | No | |
| Notes | form | string | No | |
| Primary | form | bool | No | |
| TaxLoc | 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/ShippingAddressLookup HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ShipTos":[{"Id":0,"Name":"String","Attention":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","Email":"String","Phone":"String","Phone2":"String","Notes":"String","Primary":false,"TaxLoc":"String","Active":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}