Shipwell API

The Shipwell Developer Hub

Welcome to the Shipwell developer hub. You'll find comprehensive guides and documentation to help you start working with Shipwell API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Environments

There are two base URLs for making API calls, one for production and the other for training, development, or testing. As a developer, you can test with the Sandbox APIs and then deploy to production by switching your integration to the production base URLs. The base URLs for the two APIs are as follows:

Environment
Base URL

Note that these two environments are completely separate and any calls to the sandbox environment will not be reflected in the production environment. All 3rd party connections to carriers, vendors, and other services may be mocked out in the sandbox environment and will not actually make production calls. You can access your sandbox environment and test the system with mock data. Note that you will need to specify a version in the url to get the specific version of the API endpoint.

Versioning

Our current versioning scheme utilizes a vXX major version scheme in the URL. So use of the endpoints above and append a /v2 to your {{baseUrl}}. We will be moving towards version date in the header in subsequent deployments.

Updated 15 days ago

Environments


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.