Search our Help.

Using the Sandbox

Follow

Page contents

Points to note

Setup the Unleashed Sandbox tutorial video

Create a Sandbox

Use a Sandbox

Unleashed's Sandbox feature allows you to create a copy of your current Unleashed account in a separate environment. This environment allows you to develop, test and learn more about Unleashed's functionalities and behaviours without affecting the data in your live Unleashed account. Upon creation, the Sandbox will replicate your live account but any changes made to your Sandbox will not apply to your live account, and vice versa. 

Points to note

Please read these notes carefully to avoid accidental data loss or inadvertent changes to your account:

  • Only the account owner can create the Sandbox environment.
  • You can only have one Sandbox per account. 
  • A Sandbox is created using a back-up of your live account from up to 24 hours ago. 
  • The Sandbox account will expire and be deleted 21 days after being created. The expiration date cannot be extended and a deleted Sandbox cannot be restored.
  • All existing users in your live account are automatically included with access to the Sandbox upon it's creation. 
  • New users must be manually invited to an existing Sandbox as well as the live account, with a maximum of 5 users per Sandbox. 
  • Any changes made to a Sandbox account cannot be synced to the live version of the account.
  • Before creating or working in a Sandbox environment, ensure all other web browser windows or tabs logged into Unleashed are closed. Unleashed only supports a single active organization at a time for a given user.
  • If you create a transaction for your Sandbox environment while a browser tab is open in your live account, there is a chance that the transaction will be saved to your live account. Ensure all tabs in your browser are logged in to your Sandbox when testing. 
  • The B2B Portal cannot be tested in the Sandbox account.
  • Email functionality is not available in Sandbox accounts.
  • To test the Advanced Shipping Module or Ecommerce Hub integrations in a Sandbox before adding them to your live account Submit a request in the Support Portal.
  • Each Sandbox account will have a unique API ID and Key to test third party integrations. We strongly suggest not connecting a Sandbox to live third party integrations in the interest of preserving data integrity.
  • A Sandbox's API usage limit will replicate the API usage limit of the live account at the point of creation.
  • File Library documents, e.g. product images are not copied to the Sandbox environment.
    • If you perform any action which attempts to export images from the Sandbox to another system, it will fail to retrieve the image, as the images are not stored in the Sandbox. This would include using our Shopify integration to export the Default Image to Shopify, this would fail to occur and an error would appear in the connection log.
  • If you delete the current Sandbox and create a new one immediately, in the majority of cases it will restore the data from the previous one, however, this is dependent on the amount of data in the Sandbox and cannot be guaranteed. We recommend you export any data you need to keep from your current Sandbox, this can be reimported into the new Sandbox if needed.

Setup the Unleashed Sandbox tutorial video

Create a Sandbox

  1. Close all other web browser windows or tabs of Unleashed
  2. As the account owner, go to your name's dropdown menu in the top right of Unleashed.
  3. Select My Account.
  4. Click Create Sandbox in the top right of your page.
  5. In the confirmation dialog box, click Yes to continue or No to exit. A notification is displayed after the Sandbox is successfully created.

Use a Sandbox

When in Sandbox mode, you can test using and integrating with an Unleashed account, without it affecting your live account's data. To access an existing Sandbox account:

  1. Go to the My Account page.
  2. Select the Sandbox account and click View
  3.  A message is displayed at the top of the screen to indicate that you are using the Sandbox 

The Sandbox's expiration date will be displayed in the banner across the top of your Unleashed page.

Exiting the Sandbox

  1. Go to the My Account page.
  2. Select the account you want to access and click View.  

Delete a Sandbox

  1. In the Sandbox account, go to the My Account page.
  2. Select your live Unleashed account and click View.
  3. In the live Unleashed account, go to the My Account page.
  4. Click Delete Sandbox.
  5. In the confirmation pop-up, click Yes.

You will receive a notification confirming the Sandbox deletion.

Was this article helpful?
1 out of 2 found this helpful