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

Versioning

How Shipwell does versioning

All requests use your company's API version, which is set in the Manage > Company section of the Shipwell platform unless you override the API version. Events generated by API requests will always be structured according to your company's API version. If you do not set an API version, the latest version of Shipwell's API will be used.

To set the API version on a specific request, send a Shipwell-Version header.

See your company's configuration settings to change or upgrade your API version. As a precaution, use API versioning to test a new API version before committing to an upgrade.

Updated 21 days ago

Versioning


How Shipwell does versioning

Suggested Edits are limited on API Reference Pages

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