Retrieve your delivery addresses
Retrieves a list of delivery addresses for the authenticated user.
URL: | https://api.trademe.co.nz/v1/MyTradeMe/DeliveryAddresses.{file_format} |
---|---|
HTTP Method: | GET |
Requires Authentication? | Yes |
Permission Required: | MyTradeMeRead: Read your membership & listing data. |
Supported Formats: | XML, JSON |
Rate Limited? | Yes |
URL parameters
file_format | Enumeration (required) | The format of the response. | ||||
---|---|---|---|---|---|---|
|
Query String parameters
Returns
Collection of <Address>
A collection of delivery addresses.
Name | String or null |
The name of the person whom the item is being delivered to. |
---|---|---|
Address1 | String or null |
The first line of the address. |
Address2 | String or null |
The second line of the address (optional). |
Suburb | String or null |
The suburb (optional). |
City | String or null |
The city. |
Postcode | String or null |
The postcode (optional). |
Country | String or null |
The country (currently restricted to "New Zealand" or "Australia"). |
IsMembershipAddress | Boolean |
Indicates whether this address is a membership address. This type of address is comprised of address details that are supplied when registering an account. Do not supply this value when adding or updating a delivery address. |
Id | Integer |
The ID of the delivery address. The membership address always has an ID of zero. This field is ignored when adding a delivery address. |