This method allows applications to retrieve a paginated collection of destination resources and related details. The details include the destination names, statuses, and configurations, including the endpoints and verification tokens.
This method is not supported in Sandbox environment.
|limit||string||The maximum number of destinations to return per page from the result set.|
|continuation_token||string||This string value can be used to return the next page in the result set. The string to use here is returned in the next field of the current page of results. |
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.
This request requires an access token created with the client credentials 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):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
The total number of matches for the search criteria.
The path to the call URI that produced the current page of results.
The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.
The number of records to show in the current response.
|destinations||array of Destination|
An array that contains the destination details.
The unique identifier for the destination.
The name associated with this destination.
The status for this destination.
The configuration associated with this destination.
The endpoint for this destination.
The verification token associated with this endpoint.
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.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|195000||API_NOTIFICATION||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|195004||API_NOTIFICATION||REQUEST||Invalid limit. Supported ranges 10 - 100.|
|195005||API_NOTIFICATION||REQUEST||Invalid continuation token.|
This call has no warnings.
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: Browse the details and status of previously created destination details
This call retrieves the group of previously created destination details.
There are no required inputs.
A successful call returns a list of the previously created destinations.