API Reference

Versioning

The current version of the Partner API is 2023-02-01

Versioning is handled using the Crezco-Version header. Where the header contains no version information the latest version of the API will be used. To use a specific version of the API set the header as follows:

Crezco-Version: yyyy-MM-dd

where the value is an ISO 8601 date when the API was released. For example:

  • Crezco-Version: 2023-01-26 - use the 26th Jan version of the API
  • Crezco-Version: 2023-08-01 - use the 1st August version of the API

Backward incompatible changes will result in a new version of the API being released. The version number will correspond to the date of the release.

When the header is set to a value that is not supported in the called API you will receive a 406 - Not Acceptable response. The body will contain a representation of the valid versions that the API supports.