Versioning

The InPost REST API is versioned. The API version name is based on the date when the API version was released. For example, the API version 2024-06-01 was released on June 1st, 2024.

Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:

• removing an entire operation
• removing or renaming a parameter
• removing or renaming a response field
• adding a new required parameter
• making a previously optional parameter required
• changing the type of a parameter or response field
• removing enum values
• adding a new validation rule to an existing parameter
• changing authentication or authorization requirements

Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:

• adding an operation
• adding an optional parameter
• adding an optional request header
• adding a response field
• adding a response header
• adding enum values

When a new REST API version is released, the previous API version will be supported for at least 12 months following the release of the new API version.

Specifying an API version

You should use the X-InPost-Api-Version header to specify an API version. For example:

curl --header "X-InPost-Api-Version:2024-06-01" https://api.inpost-group.com

Requests without the X-InPost-Api-Version header will default to use the current version, which is now 2024-06-01.

If you specify an API version that is no longer supported, you will receive a 400 error.

Also you can check current version by calling:

curl https://api.inpost-group.com \
  -H "Authorization: Bearer {token}"
  -H "Content-Type: application/json"