POST/destination
This method allows applications to create a destination. A destination is an endpoint that receives HTTP push notifications.
A single destination for all topics is valid, as is individual destinations for each topic.
To update a destination, use the updateDestination call.
The destination created will need to be referenced while creating or updating a subscription to a topic.
Note: The destination should be created and ready to respond with the expected challengeResponse for the endpoint to be registered successfully. Refer to the Notification API overview for more information.
Input
Resource URI
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
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
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
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| deliveryConfig | DeliveryConfig | This container is used to specify the destination endpoint and verification token associated with this endpoint. Occurrence: Required |
| deliveryConfig.endpoint | string | The endpoint for this destination. Occurrence: Required |
| deliveryConfig.verificationToken | string | The verification token associated with this endpoint. Occurrence: Required |
| name | string | The seller-specified name for the destination endpoint. Occurrence: Optional |
| status | DestinationStatusEnum | This field sets the status for the destination endpoint as Occurrence: Required |
Output
HTTP response headers
See HTTP response headers for details.
| Header | Meaning |
|---|---|
| Location | The destination resource created. |
Response payload
This call has no payload.
Response fields
This call has no field definitions.
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 |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 409 | Conflict |
| 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. |
| 195003 | API_NOTIFICATION | REQUEST | Please provide configurations required for notifications. Refer to /config |
| 195016 | API_NOTIFICATION | REQUEST | Invalid name. Markups or lengths greater than 64 not supported |
| 195017 | API_NOTIFICATION | REQUEST | Invalid or missing endpoint. |
| 195018 | API_NOTIFICATION | REQUEST | Invalid or missing destination status. Supported values:[ENABLED,DISABLED] |
| 195019 | API_NOTIFICATION | REQUEST | Invalid or missing verification token for this endpoint. |
| 195020 | API_NOTIFICATION | REQUEST | Challenge verification failed for requested endpoint |
| 195021 | API_NOTIFICATION | REQUEST | Destination exists for this endpoint |
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: Create a destination
This call creates a destination.
Input
The inputs are the optional name, and the required deliveryConfig including the endpoint and the verificationToken.
POSThttps://api.ebay.com/commerce/notification/v1/destination
Output
A successful call returns the HTTP status code 204 No Content. This method has no response payload.