notification APIv1.2.0

test

POST
/subscription/{subscription_id}/test
This method triggers a mocked test payload that includes a notification ID, publish date, and so on. Use this method to test your subscription end-to-end.

You can create the subscription in disabled mode, test it using this method, and when everything is ready, you can enable the subscription (see the enableSubscription method).

Note: Use the notificationId to tell the difference between a test payload and a real payload.

Input

Resource URI (production)

POST https://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/test

URI parameters

ParameterTypeDescription
subscription_idstringThe unique identifier for the subscription.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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

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.

Output

HTTP response headers

Output container/fieldTypeDescription
notificationIdstringThe unique identifier for the notification for this test message.

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.

StatusMeaning
202Accepted
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195013API_NOTIFICATIONREQUEST Invalid subscription Id.

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: Test a subscription

Triggers a mocked test payload to the destination.

Input

The only input is the subscription_id as a path parameter.
POST
https://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/test

Output

A successful call returns the HTTP status code 202 Accepted and the notificationId.