Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

Operating an application in the Sandbox is essentially the same as operating it in the Production environment. The main difference is that the application needs to be pointed to the Sandbox environment instead of the Production environment. See the Making a Call documentation for the API you're using (e.g., Routing the Request in the Trading API docs) for more information on how to point an application to either the Production or the Sandbox environment.

Learn more about the Sandbox

Sandbox benefits

  • The Sandbox duplicates much of the functionality that is on the eBay Web site. It processes API calls in exactly the same manner as does the Production environment, and it includes a subset of the eBay site's Web pages. The difference is that all the users are test users (created by developers like you) and all the money exchanged is test money.
  • Use the Sandbox to experiment with function calls, to prototype new routines, to test your application's business logic, and to make sure your application adheres to eBay's Application Growth Check Requirements before you actually apply for the Application Growth Check.
  • Before you begin working with the eBay API, and before you attempt to connect to the Sandbox, make sure all the tools in your local development environment work properly.
  • Great for testing Buying, Selling and After Sale flows. You will not incur production charges by purchasing and selling items in the Sandbox. We recommend the production for testing searching capabilities.

Before you can make API calls in the sandbox environment, you must generate Sandbox application keys. Production application keys will not work in the Sandbox.

Learn how to generate Sandbox application keys.

Create test users

Complete this form to create test users for the Sandbox. For further instructions, see Create a test Sandbox user in the Get Started with eBay APIs guide.

Reset test user password

Once logged into your eBay developer account, use the Reset Sandbox User Password page to reset the password of your Sandbox test user account. You can navigate to this page from the page header by selecting Develop -> Tools -> eBay Sandbox -> Reset Password

To reset the password, enter the username for your Test User whose password you are trying to reset (prefixed with TESTUSER_). Then, enter the new password. Select the Save Password button under these fields to save your changes.

Sandbox status

Periodically check the Sandbox section of the API status page for any existing Sandbox issues.