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
This method is not supported in Sandbox environment.
URI parameters
| Parameter | Type | Description |
|---|---|---|
| destination_id | string | The 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.
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 |
|---|---|---|
| destinationId | string | The unique identifier for the destination. Occurrence: Conditional |
| name | string | The name associated with this destination. Occurrence: Conditional |
| status | DestinationStatusEnum | The status for this destination.
Occurrence: Required |
| deliveryConfig | destination | 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 404 | Not Found |
| 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. |
| 195022 | API_NOTIFICATION | REQUEST | Invalid 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.