Sandbox Environment

The Sandbox feature allows Admin users to create an isolated testing environment where they can freely experiment and integrate the API without affecting their production data. All users of the merchant can switch between Live and Sandbox environment once the sandbox has been created.

Sandbox Guide

Creating a Sandbox Environment

1. Navigate to Settings in the UI.

2. Go to the Sandbox section.

3. Click Create Sandbox to generate a new environment.

Sandbox settings section

Your sandbox environment will have its own API key, resources, and data, completely separate from production. For convenience the sandbox creation process will create up to 10 copies of your products or create a dummy active product such that you can get started expermenting on the Seller Center.

Switching Between Sandbox and Production

For the UI, you can switch between Live and Sandbox environment through the sandbox settings section or in the header account menu.

For the API, you can use your Sandbox API Key when making requests to the sandbox environment and the Production API Key when working with live data.

Deleting a Sandbox

If you no longer need a sandbox, you can delete it from the Settings page. This will remove all sandbox-related data, API keys associated with it and move all users from sandbox to live.

Sandbox Exclusive Functionalities

Skipping Approval for Products

To maximize flexibility in the sandbox environment, the approval process for products is bypassed. This means that as soon as you attempt to publish a product in sandbox mode, it becomes active immediately. In contrast, in the production environment, all products must go through an approval process before they can be listed in the shop.

Simulating Orders

Since the sandbox environment is entirely isolated from real customers, no actual orders will be received. To facilitate testing, the Receive Orders button is available on the Orders page in the UI. This feature allows you to generate test orders using active products, enabling you to simulate order workflows and integration scenarios without affecting live operations.

Receive Orders button