Versioning and changelog

This section provides an overview of the versioning schema and presents the currently available versions along with their respective changelogs.

Version numbers are prefixed to every operation path; for example, /1/find/search would indicate that version 1 is in use.

Breaking changes

Any breaking change that we need to introduce to the API interface would result in an increase in the current version number, and we will communicate this change actively and properly beforehand. We strive to minimize the introduction of breaking changes, reserving them only for situations where they are unavoidable. Consequently, you can expect support for a version to extend over longer periods.

Examples of breaking changes include removing fields, dropping support for certain headers, removing a path completely, and significantly altering the behavior of a path or operation..

Non-breaking changes

Non-breaking or minor changes are introduced to the API versions on the fly, along with bug and security fixes, without increasing any version number. These changes are expected to happen with a certain frequency, and the most important ones are added to the version's changelog below. With some exceptions, non-breaking changes are not communicated beforehand.

Examples of non-breaking changes include adding new fields, adding new paths/operations, performance improvements, bugfixes, fixing security issues, and slightly changing the behavior of a path/operation without changing its intention, meaning, or expected result

Version 1

Changelog

2025-03-11

• added new projection field results.highlights, providing the ability to highlight textual matches in the search results (see more)

2025-03-10

• added new projection field results.attributes, providing structured metadata about parts with translated labels and values (see more)

2025-01-30

• added a new search auxiliary endpoint /1/find/filters/attributes, for fetching available attribute filters (see more)
• added a new search auxiliary endpoint /1/find/filters/attributes/options, for fetching available options for a given attribute filter (see more)
• added a new search auxiliary endpoint /1/find/filters/hierarchy, for fetching available hierarchy filter options (see more)

2024-09-20

• added results.nameLanguage projection
• added request.fallbackLanguages optional field.
• added support for organization's fallback languages in the returned part names.

2024-07-04

• added new optional header, X-Partium-ExternalUserId, for cases where users are not individually managed.

2024-05-29

• added the ability to update and remove the image of a previous search when continuing it.

2024-05-15

• New fields added to the response of the two existing search endpoints:
  • results.mountingLocationsCount: the count of different spots this item appears in the BOM.

2024-04-30

• New fields added to the response of the two existing search endpoints:
  • results.images.partiumId: uniquely identifies a part-type image.
  • results.images.expireAt: specifies when the image expires.

2024-04-26

• matches.organization field is now optional when sub organizations are not configured. It is mandatory otherwise.

2024-04-23

• introduced a new endpoint, GET /search/state/{sessionId}, which allows retrieving the state of a previous search given its sessionId.

2024-04-11

• introduced a new option, projection.request, which allows the inclusion of the request body within the request field of the search response.

2024-04-05

• matches.exact field is now deprecated and will cause errors in future releases. You can from now on send any type of text using the matches.text field.

2024-04-03

• added the resultOptions.limit optional field to the search request body, allowing to crop the results list.
• added the resultsTotalCount field to the search response, indicating the total number of results.

2024-02-01

• initial release of the API, including the Image and Description searches