GET/destination
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.
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 |
---|---|---|
limit | string | The maximum number of destinations to return per page from the result set. Min: 10 Max: 100 Default: 20 Occurrence: Optional |
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. 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 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):
https://api.ebay.com/oauth/api_scope
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 |
---|---|---|
destinations | array of Destination | An array that contains the destination details. Occurrence: Conditional |
destinations.deliveryConfig | DeliveryConfig | The configuration associated with this destination. Occurrence: Always |
destinations.deliveryConfig.endpoint | string | The endpoint for this destination. Occurrence: Always |
destinations.deliveryConfig.verificationToken | string | The verification token associated with this endpoint. Occurrence: Always |
destinations.destinationId | string | The unique identifier for the destination. Occurrence: Always |
destinations.name | string | The name associated with this destination. Occurrence: Conditional |
destinations.status | DestinationStatusEnum | The status for this destination.
Occurrence: Always |
href | string | The path to the call URI that produced the current page of results. Occurrence: Always |
limit | integer | The number of records to show in the current response. Occurrence: Conditional |
next | string | 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. Occurrence: Conditional |
total | integer | The total number of matches for the search criteria. Occurrence: Conditional |
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 |
400 | Bad Request |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
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. |
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: Browse the details and status of previously created destination details
This call retrieves the group of previously created destination details.
Input
There are no required inputs.
GEThttps://api.ebay.com/commerce/notification/v1/destination
Output
A successful call returns a list of the previously created destinations.