notification APIv1.2.0

getDestination

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

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

URI parameters

ParameterTypeDescription
destination_idstringThe unique identifier for the destination.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Output

HTTP response headers

Output container/fieldTypeDescription
destinationIdstringThe unique identifier for the destination.

Occurrence: Conditional

namestringThe name associated with this destination.

Occurrence: Conditional

statusDestinationStatusEnumThe 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

deliveryConfigdesinationThe 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
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

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.
GET
https://api.ebay.com/commerce/notification/v1/destination/{destination_id}

Output

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