Skip to main content

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 (production)

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

URI parameters

ParameterTypeDescription
limitstringThe number of items, from the result set, returned in a single page. Range is from 10-100. If this parameter is omitted, the default value is used.

Default: 20

Maximum: 100 items per page

Occurrence: Optional

continuation_tokenstringThe continuation token for the next set 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.

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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/fieldTypeDescription
totalinteger

The total number of matches for the search criteria.

Occurrence: Conditional

hrefstring

The path to the call URI that produced the current page of results.

Occurrence: Always

nextstring

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

limitinteger

The number of records to show in the current response.

Default: 20

Occurrence: Conditional

destinationsarray of Destination

An array that contains the destination details.

Occurrence: Conditional

destinations.destinationIdstring

The unique identifier for the destination.

Occurrence: Conditional

destinations.namestring

The name associated with this destination.

Occurrence: Conditional

destinations.statusDestinationStatusEnum

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: Required

destinations.deliveryConfigdesination

The configuration associated with this destination.

Occurrence: Required

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.

StatusMeaning
200OK
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195004API_NOTIFICATIONREQUESTInvalid limit. Supported ranges 10 - 100.
195005API_NOTIFICATIONREQUESTInvalid 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.