GET/subscription/{subscription_id}
This method allows applications to retrieve subscription details for the specified subscription.
Specify the subscription to retrieve using the subscription_id. Use the getSubscriptions method to browse all subscriptions if you do not know the subscription_id.
Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
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
| Parameter | Type | Description |
|---|---|---|
| subscription_id | string | The unique identifier of the subscription to retrieve. Use getSubscriptions to retrieve subscription IDs. 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 either authorization code grant flow or client credentials grant flow. Please refer to the note below for more details.
The access token must be created 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
https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly
https://api.ebay.com/oauth/api_scope/commerce.notification.subscription
See OAuth access tokens for more information.
Note: An OAuth token created with the client credentials grant flow and the https://api.ebay.com/oauth/api_scope scope is required in order to create, update, or retrieve application-based subscriptions to notification topics. An OAuth token created with the authorization code grant flow and the https://api.ebay.com/oauth/api_scope/commerce.notification.subscription scope is required in order to create, update, or retrieve user-based subscriptions to notification topics.
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 |
|---|---|---|
| creationDate | string | The creation date for this subscription. Occurrence: Conditional |
| destinationId | string | The unique identifier for the destination associated with this subscription. Occurrence: Conditional |
| filterId | string | The unique identifier for the filter associated with this subscription. Occurrence: Conditional |
| payload | SubscriptionPayloadDetail | The payload associated with this subscription. Occurrence: Conditional |
| payload.deliveryProtocol | ProtocolEnum | The supported delivery protocol of the notification topic. Occurrence: Required |
| payload.format | FormatTypeEnum | The supported data format of the payload. Occurrence: Required |
| payload.schemaVersion | string | The supported schema version for the notification topic. See the supportedPayloads.schemaVersion field for the topic in getTopics or getTopic response. Occurrence: Required |
| status | SubscriptionStatusEnum | The status of this subscription. Occurrence: Conditional |
| subscriptionId | string | The unique identifier for the subscription. Occurrence: Conditional |
| topicId | string | The unique identifier for the topic associated with this subscription. Occurrence: Conditional |
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. |
| 195013 | API_NOTIFICATION | REQUEST | The subscription id does not exist. |
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 subscription
This method allows applications or users to retrieve subscription details and status for the specified subscription (and application).
Input
Ths input specifies the subscription_id.
GEThttps://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}
Output
The output is a subscription and its details such as the subscriptionId, topicId, status, creationDate, payload, destinationId, and filterId.