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:

These URL's work for all API endpoints, with exception to any Event and Webhook endpoints.

Note that these two environments are completely separate. Use the sandbox environment to test API calls with mock data. Any requests made to the sandbox environment do not carry over into the production environment. All 3rd party connections to carriers, vendors will not make production calls. You will need to specify an API version in the URL to get the specific version of the API endpoint.

Versioning

Our current versioning scheme utilizes a vX major version scheme in the URL. Use of the endpoints above and append a /v2 to your {{baseUrl}}, with exception to the Event and Webhook endpoints. We will be moving towards version dates in the header in subsequent deployments.

Updated 5 months 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.