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 X-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.