Important update on Sales Order API Changes

[Rozhat]

Important update on Sales Order API Changes

The previously communicated end-of-life date for the old SalesOrder V1 and V2 endpoints has been postponed. This decision was made after receiving input from several ISVs and considering the many other changes we are bringing related to the end of VNI. 

As we transition to the next generation of our APIs, some of our old SalesOrder V1 and V2 endpoints will be deprecated during 2025.

We understand you're eager for a concrete end-of-life date for the V1/V2 SalesOrder endpoints, but we cannot provide one yet. Rest assured, we will provide at least a six-month notice ahead of the actual end-of-life date.

However, we highly recommend initiating the transition to the V3 API as soon as possible.

By starting early, you'll not only be ahead of the curve but also gain the advantage of ample time for testing and ensure a seamless integration before the deadline. This will give you flexibility and time to thoroughly test your integrations with the V3 API, helping to guarantee a smooth cutover when the time comes.

Why is this happening?

To be able to meet the demand for more functionality as well as improved functionality in combination with the demand for higher throughput of transactions, we have to move from the Classic endpoints to NextGen endpoints.

Our new SalesOrder V3 endpoint will offer improved functionality, increased security, and better performance. Put in other words, by retiring older endpoints, we can focus on delivering these enhancements without the constraints of maintaining outdated systems.

In summary, this change ensures that you will benefit from the latest technology and innovations we offer. It’s part of our goal to provide you with a more robust, efficient, and future-proof service.

How will this affect you?

This change will require you to rewrite integrations that use the affected V1/V2 endpoints.

For most instances, this change should be quite manageable. But for more complicated integration, this can be a time-consuming process with necessary testing to confirm that your integration is working as expected.

What remains to be done before v3 covers the v1/v2 functionality?

The v3 endpoints are planned to cover the functionality of the Sales Order v1/v2 endpoints (see list below), by March 2025. Follow our release notes for updates on this matter.

The only functionality that is still under development is the LOT/Serial and expiration date functionality.

What should you do next?

1. Identify: Determine if your Visma Net Integrations utilize any of the V1/V2 endpoints listed below.
   
   

2. Plan: If you are using the affected endpoints, start planning your project to migrate to the V3 endpoints.
   
   

3. Contact: If you are a Visma Net customer, contact your partner or integration vendor to clarify the necessary steps for your specific instance.

 

What are the changes?

The following API endpoints are scheduled for removal:

Method	Endpoint	Status
GET	/controller/api/v1/salesorder/{orderNbr}	To be removed
GET	/controller/api/v1/salesorder/{orderType}/{orderNbr}	To be removed
GET	/controller/api/v1/salesorder/{orderType}/{orderNbr}/rotrut	To be removed
GET	/controller/api/v1/salesorder	To be removed
GET	/controller/api/v1/salesorder/{orderType}/{orderNbr}/commissions	To be removed
POST	/controller/api/v1/salesorder	To be removed
POST	/controller/api/v1/salesorder/{saleOrderNumber}/action/cancelSalesOrder	To be removed
POST	/controller/api/v1/salesorder/{salesOrderNumber}/action/reopenSalesOrder	To be removed
PUT	/controller/api/v1/salesorder/{orderNbr}	To be removed
GET	/controller/api/v1/salesorderbasic/{orderNbr}	To be removed
GET	/controller/api/v1/salesorderbasic/{orderType}/{orderNbr}	To be removed
GET	/controller/api/v1/salesorderbasic	To be removed
POST	/controller/api/v1/salesorderbasic	To be removed
PUT	/controller/api/v1/salesorderbasic/{orderNbr}	To be removed
POST	/controller/api/v2/salesorderbasic	To be removed
POST	/controller/api/v2/salesorder	To be removed
POST	/controller/api/v2/salesorder/{saleOrderNumber}/action/cancelSalesOrder	To be removed
POST	/controller/api/v2/salesorder/{salesOrderNumber}/action/reopenSalesOrder	To be removed

All necessary features will be integrated into the new Sales Order Service API before the transition date. We are committed to ensuring a smooth transition and will provide updates as they become available.