As part of our ongoing efforts to improve our system and streamline our API functionality, we are announcing the deprecation of several endpoints in the api/items
controller. These changes will take effect starting March 31, 2025. This blog post outlines the details of this transition, important dates to remember, and the actions required to ensure a smooth shift to our updated APIs.
Key Dates and Transition Process
Starting with version 2.5 until March 31, 2025: The affected endpoints will continue to function as normal but will include a new header in their response:Deprecation: "2025-03-31"
.
This header serves as a reminder that the endpoints will no longer be supported after the sunset date.
Final 14 Days (March 17–31, 2025): During the last two weeks before deprecation, these endpoints will start to throw random errors in 20% of requests. This behavior is designed to alert users to the impending shutdown, urging them to migrate before the endpoints are completely disabled.
After March 31, 2025: The deprecated endpoints will be fully disabled and will no longer work.
Affected Endpoints
The following API endpoints are scheduled for deprecation:
- GET
/api/items
- POST
/api/items
- PUT
/api/items
- PATCH
/api/items
- GET
/api/items/{number}
- GET
/api/items/extensions/{number}
- PUT
/api/items/extensions
- PATCH
/api/items/extensions
- POST
/api/items/views/{viewName}
- GET
/api/items/{number}/price_group
- POST
/api/items/import
- PUT
/api/items/{number}/set_cost
- PATCH
/api/items/{number}/set_cost
- GET
/api/price_groups/{code}/items
What You Need to Do
If your integration uses any of these endpoints, we strongly recommend switching to the generic alternatives available in our API. Migrating to the new endpoints will ensure uninterrupted access and compatibility with our system beyond the deprecation date.
Why This Change?
These changes are part of our broader initiative to optimize and unify our API architecture. By focusing on generic, scalable endpoints, we can enhance performance, reduce maintenance overhead, and introduce new features more rapidly in the future. We appreciate your understanding and cooperation in helping us make this transition as seamless as possible.
Stay Informed
As we approach the deprecation date, we will continue to provide reminders and updates. Be sure to monitor your API logs for the Deprecation
header.