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.
This method is not supported in Sandbox environment.
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.
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):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
The unique identifier for the destination.
The name associated with this destination.
The status for this destination.
The configuration associated with this destination.
The endpoint for this destination.
The verification token associated with this endpoint.
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.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|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.|
This call has no warnings.
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.
The input is destination_id.
If the call is successful, the destinationId, name, status, and deliveryConfig are returned.