Sandbox Environment

ShipEngine's sandbox environment gives you a safe place to experiment, test, and develop your app without incurring costs or affecting your production data.

How to Use the Sandbox

To use our sandbox environment the only thing you need to change is your API key. You'll use a sandbox key rather than a normal API key. Sandbox keys always start with TEST_ to make it obvious whether you're using a production or sandbox key.

Other than the API key, everything else is the same. So you can easily test and develop your application in the sandbox and then when you're ready to go to production all you need to do is change the API key.

Costs

You won't incur any costs for anything you do in the sandbox. This gives your developers the freedom to "kick the tires" and experiement with our API without worrying about costing the company real money.

Data Isolation

Sandbox data is isolated from production data, so anything you create in the sandbox will not be accessible in production, or vice-versa. This means you can safely experiement and delete data without affecting your production system.

Differences in Behavior

Our sandbox environment matches the production environment as much as possible, but there are a few differences to be aware of:

Limited Carriers

We currently only support the three major US carriers — UPS, FedEx, and USPS (Stamps.com). Other carriers will be added in the future, including international carriers.

Tip If your preferred carrier is not currently supported, you can still test and develop in our sandbox using one of the supported carriers. Then just switch the carrier_code and carrier_id when you go to production.

Test Labels

Shipping labels created in the sandbox cannot be used to ship actual packages. Depending on the carrier, the label will be watermarked or will have a warning message indicating that it's a test label.

Rates

The shipping rates that you get in the sandbox may not match the rates that you get in production. Any negotiated rate discounts that you have are not applied in the sandbox, and some rates are "dummy" rates to prevent abuse of our sandbox for production purposes.

Rate Limits

The sandbox environment has lower rate limits than the production environment. This helps prevent abuse of our sandbox for production purposes.