API Reference

When backwards-incompatible changes are made to the API, a new, dated version is released. The current version of the API is 2022-10. You can use the same token to make calls to all versions.

Wonderment API versions are explicitly declared in the URLs that your app makes requests to.
Example: /{api_version}/shipments/search/8675309

Backwards-compatible changes

The following changes are backwards-compatible:

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque strings such as error messages and other human-readable strings.
  • Adding new event types. Your webhook listener should gracefully handle unfamiliar event types.