getDestinations: eBay Notification API | eBay Developers Program

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

GET https://api.ebay.com/commerce/notification/v1/destination?

limit=string&

continuation_token=string

This method is not supported in Sandbox environment.

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

Copy complete valid JSON to clipboard

{ /* DestinationSearchResponse */

"total" : "integer",

"href" : "string",

"next" : "string",

"limit" : "integer",

"destinations" : [

{ /* Destination */

"destinationId" : "string",

"name" : "string",

"status" : "DestinationStatusEnum : [ENABLED,DISABLED,MARKED_DOWN]",

"deliveryConfig" :

{ /* DeliveryConfig */

"endpoint" : "string",

"verificationToken" : "string"

}

]

}

Response fields

Output container/field	Type	Description
total	integer	The total number of matches for the search criteria. Occurrence: Conditional
href	string	The path to the call URI that produced the current page of results. Occurrence: Always
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. This field is not returned if fewer records than specified by the limit field are returned. Occurrence: Conditional
limit	integer	The number of records to show in the current response. Default: 20 Occurrence: Conditional
destinations	array of Destination	An array that contains the destination details. Occurrence: Conditional
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. Note: The MARKED_DOWN value is set by eBay systems and cannot be used in a create or update call by applications. Valid values: `ENABLED` `DISABLED` `MARKED_DOWN` Occurrence: Always
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

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.