{
"opencollection": "1.0.0",
"info": {
"name": "eBay Account Advertising_eligibility Destination API",
"version": "v1.9.2"
},
"items": [
{
"info": {
"name": "Destination",
"type": "folder"
},
"items": [
{
"info": {
"name": "getDestinations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/destination",
"params": [
{
"name": "continuation_token",
"value": "",
"type": "query",
"description": "This string value can be used to return the next page in the result set. The string to use here is returned in the next field of the current page of results."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of destinations to return per page from the result set.
Min: 10
Max: 100
Default: 20"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This method allows applications to retrieve a paginated collection of destination resources and related details. The details include the destination names, statuses, and configurations, including the endpoints and verification tokens."
},
{
"info": {
"name": "createDestination",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.ebay.com{basePath}/destination",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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 r"
},
{
"info": {
"name": "getDestination",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.ebay.com{basePath}/destination/:destination_id",
"params": [
{
"name": "destination_id",
"value": "",
"type": "path",
"description": "The unique identifier of the destination to retrieve. Use getDestinations to retrieve destination IDs."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "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."
},
{
"info": {
"name": "updateDestination",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.ebay.com{basePath}/destination/:destination_id",
"headers": [
{
"name": "Content-Type",
"value": ""
}
],
"params": [
{
"name": "destination_id",
"value": "",
"type": "path",
"description": "The unique identifier for the destination."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This method allows applications to update a destination.
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."
},
{
"info": {
"name": "deleteDestination",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.ebay.com{basePath}/destination/:destination_id",
"params": [
{
"name": "destination_id",
"value": "",
"type": "path",
"description": "The unique identifier of the destination to delete. Only disabled or marked down destinations can be deleted, and enabled destinations cannot be deleted. Use getDestination or getDestinations to see the current status of a destination. "
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This method provides applications a way to delete a destination.
The same destination ID can be used by many destinations.
Trying to delete an active destination results in an error. You can disable a subscription, and when the destination is no longer in use, you can delete it."
}
]
}
],
"bundled": true
}