Skip to main content

GET/destination/{destination_id}

This method allows applications to fetch the details for a destination. The details include the destination name, status, and configuration, including the endpoint and verification token.

Input

Resource URI

GET https://api.ebay.com/commerce/notification/v1/destination/{destination_id}

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

ParameterTypeDescription
destination_idstringThe unique identifier of the destination to retrieve. Use getDestinations to retrieve destination IDs.

Occurrence: Required

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

The configuration associated with this destination.

Occurrence: Always

deliveryConfig.endpointstring

The endpoint for this destination.

Note: The provided endpoint URL should use the HTTPS protocol, and it should not contain an internal IP address or localhost in its path.

Occurrence: Always

deliveryConfig.verificationTokenstring

The verification token associated with this endpoint.

Note: The provided verification token must be between 32 and 80 characters. Allowed characters include alphanumeric characters, underscores (_), and hyphens (-); no other characters are allowed.

Occurrence: Always

destinationIdstring

The unique identifier for the destination.

Occurrence: Always

namestring

The name associated with this destination.

Occurrence: Conditional

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

StatusMeaning
200OK
404Not Found
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.
195022API_NOTIFICATIONREQUESTInvalid or missing destination id.

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: Get destinations

This call retrieves the details and status of the specified destination.

Input

The input is destination_id.

GEThttps://api.ebay.com/commerce/notification/v1/destination/{destination_id}

Output

If the call is successful, the destinationId, name, status, and deliveryConfig are returned.