GET/address_preference
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve information about all the ship-from and/or return addresses associated with a seller's eDIS account.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/scope/sell.edelivery
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| addressPreferenceList | GetAddressPreferenceListResponsesData | This container returns all ship-from and/or return addresses associated with a seller's eDIS account. Occurrence: Always |
| addressPreferenceList.addresses | array of GetAddressPreferencesResponses | This array returns a list of address, contact, and identifier information for each of a seller's ship-from and/or return addresses associated with their eDIS account. Occurrence: Always |
| addressPreferenceList.addresses.addressId | string | The unique identifier of the address. Occurrence: Always |
| addressPreferenceList.addresses.city | string | The city code of the address. Occurrence: Always |
| addressPreferenceList.addresses.cityName | string | The city name of the address. Occurrence: Always |
| addressPreferenceList.addresses.company | string | The company name associated with the address. Occurrence: Always |
| addressPreferenceList.addresses.contact | string | The name of the contact person associated with the address. Occurrence: Always |
| addressPreferenceList.addresses.countryCode | string | The two-letter country code of the address. Occurrence: Always |
| addressPreferenceList.addresses.countryName | string | The country name of the address. Occurrence: Always |
| addressPreferenceList.addresses.district | string | The district code of the address. Occurrence: Always |
| addressPreferenceList.addresses.districtName | string | The district name of the address. Occurrence: Always |
| addressPreferenceList.addresses.name | string | The name of the address. Occurrence: Always |
| addressPreferenceList.addresses.phone | string | The phone number associated with the address. Occurrence: Always |
| addressPreferenceList.addresses.postcode | string | The postal code of the address. Occurrence: Always |
| addressPreferenceList.addresses.province | string | The province code of the address. Occurrence: Always |
| addressPreferenceList.addresses.provinceName | string | The province name of the address. Occurrence: Always |
| addressPreferenceList.addresses.street1 | string | The first line of the street address of the address. Occurrence: Always |
| addressPreferenceList.addresses.street2 | string | The second line of the street address of the address. Occurrence: Always |
| addressPreferenceList.addresses.street3 | string | The third line of the street address of address. Occurrence: Always |
| addressPreferenceList.addresses.type | AddressTypeEnum | The address type of the address. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 355000 | API_EDIS | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 355400 | API_EDIS | REQUEST | The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieve all addresses associated with your eDIS account
This method retrieves all addresses associated with the user's eDIS account.
Input
There are no input parameters for this method.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/address_preference
Output
If the call is successful, information about each address associated with a user's eDIS account is returned.
In this sample, two addresses, along with their location, contact, and identifier information, are returned.