| Requires any of the roles: | Reseller, Merchant |
| GET | /merchants/{merchantKey}/addresses | Gets a collection of addresses matching the merchant key provided. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | path | integer | Yes | The key of the merchant addresses to fetch. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantAddresses | model | List<MerchantAddress> | No | A collection of addresses. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MerchantKey | model | int | No | Unique (system-generated) identifier. |
| AddressType | model | string | No | Shipping or Billing address type. |
| AddressKey | model | int | No | The unqique database key for the address. |
| StreetAddress1 | model | string | No | The street of the address. |
| StreetAddress2 | model | string | No | The street of the address. |
| StreetAddress3 | model | string | No | The street of the address. |
| City | model | string | No | The city of the address. |
| State | model | string | No | The state of the address. |
| PostalCode | model | string | No | The postal code of the address. |
| Country | model | string | No | The country of the address. |
| Telephone | model | string | No | The telephone number. |
| EmailAddress | model | string | No | The email address. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /merchants/{merchantKey}/addresses HTTP/1.1
Host: syntch.simpay.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
MerchantAddresses:
[
{
MerchantKey: 0,
AddressType: String,
AddressKey: 0,
StreetAddress1: String,
StreetAddress2: String,
StreetAddress3: String,
City: String,
State: String,
PostalCode: String,
Country: String,
Telephone: String,
EmailAddress: String
}
]
}