ShipStation API LTL Sandbox

ShipStation API gives you the ability to test the LTL workflow using our sandbox. This will allow you to use our test LTL carriers to get comfortable with the process and test that your application handles different scenarios properly before going to production.

Sandbox Access

If your ShipStation API account was created before Sandbox support, you will need to contact support to enable this feature for you. If that is the case, you will see a message in your dashboard.

LTL Test Carriers

The ShipStation API sandbox allows you to connect three different LTL test carriers to your account. Each of these carriers simulates a different condition your app might encounter when working with LTL shipments in ShipStation API.

The following test carriers are available in the sandbox:

TEST - Use this carrier_code to test successful scenarios. As long as the request is syntactically correct, you will always receive a successful response from this carrier.
WARN - Use this carrier_code to test conditions that generate a warning, such as specifying an invalid accessorial service. As long as the request is syntactically correct, you will always receive a warning response from this carrier.
FAIL - Use this carrier_code to test conditions that generate an error. As long as the request is syntactically correct, you will always receive an error response from this carrier.

The data returned from the sandbox carriers will always be the same as long as the request is syntactically correct. Building your application to accept all three types of structured responses will ensure that when you move into production you will have full support for all LTL carriers we integrate with.

Connect Carriers

You'll first need to connect each of the test carriers to your ShipStation API account before you can make requests.

To connect an LTL test carrier, send an empty request body to the connection endpoint, inserting the preferred carrier_code in the URL.

Example Request & Response

POST/v-beta/ltl/connections/:carrier_code

1
2
3
4
5
6
7
8
POST /v-beta/ltl/connections/test HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_SANDBOX_API_KEY_HERE__
Content-Type: application/json
{
  "credentials": {}
}

Example response:

1
2
3
{
  "carrier_id": "6d989d94-0eb2-41cc-a0da-3f476a17d1b4"
}