GET/dropoff_sites
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve metadata for one or more drop-off sites associated with a seller's eDIS account.
Pagination query parameters are provided that allow users to control how many drop-off site locations are returned in the response.
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
| Parameter | Type | Description |
|---|---|---|
| offset | integer | This query parameter specifies the number of drop-off site locations to skip in the result set before returning the first location in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.Default: 0 Occurrence: Optional |
| limit | integer | This query parameter sets the maximum number of drop-off site locations to return on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.Max: 200Default: 50 Occurrence: Optional |
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 |
|---|---|---|
| dropoffSiteList | GetDropoffSitesResponsesData | This container returns a list of all of the drop-off site locations associated with an eDIS account. Occurrence: Always |
| dropoffSiteList.dropoffSites | array of GetDropoffSitesResponses | This array returns address, contact, and identifier information for each of a seller's drop-off locations associated with their eDIS account. Occurrence: Always |
| dropoffSiteList.dropoffSites.city | string | The city code of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.contact | string | The name of the contact person associated with the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.country | string | The two-letter country code associated with the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.district | string | The district code of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.dropoffSiteId | string | The unique identifier of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.name | string | The name of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.phone | string | The phone number associated with the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.province | string | The province code of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.street1 | string | The first line of the street address of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.street2 | string | The second line, if applicable, of the street address of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.street3 | string | The third line, if applicable, of the street address of the drop-off site location. Occurrence: Always |
| dropoffSiteList.dropoffSites.type | string | The type of the drop-off site location. Occurrence: Always |
| dropoffSiteList.href | string | The URL to the current page of the result set. Occurrence: Always |
| dropoffSiteList.limit | integer | The value of the limit parameter submitted in the request. Occurrence: Always |
| dropoffSiteList.next | string | The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set. Occurrence: Conditional |
| dropoffSiteList.offset | integer | The value of the offset parameter submitted in the request. Occurrence: Always |
| dropoffSiteList.prev | string | The URI for the previous page of results. This is returned if there is a previous page of results from the result set. Occurrence: Conditional |
| dropoffSiteList.total | integer | The total number of results that match the input criteria. 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 drop-off site locations associated with your eDIS account
This method retrieves all all drop-off site locations associated with the user's eDIS account.
Input
The limit and offset query parameters can be used with this method. In this sample, the limit is 15 and the offset is 0. There is no payload used for this request.
GEThttps://api.ebay.com/sell/edelivery_international_shipping/v1/dropoff_sites?offset=0&limit=15
Output
If the call is successful, information about each drop-off site location associated with a user's eDIS account is returned in the dropoffSites array.