NetSuite customers typically upgrade their Web Services Description Language (WSDL) version for two primary reasons:
- A newer version includes functionality that addresses specific business needs.
- The current WSDL version is scheduled for retirement by NetSuite (refer to Support for Existing WSDL Versions).
When planning a WSDL upgrade, it is recommended to upgrade to the latest available version to maximize the life cycle of your integrated application.
Key Considerations for Upgrading WSDL Versions
- No Mandatory Upgrade:
- While upgrading your WSDL is not required when your NetSuite account is upgraded, it is essential to re-test all existing integrations against the latest version of NetSuite to ensure functionality (refer to Testing After a NetSuite Upgrade).
- API Incompatibility:
- After upgrading, any incompatibilities between the old and new WSDL versions will be flagged in your development environment. Fixing these issues is a prerequisite to proceeding with unit testing, ensuring smooth transition during development.
Potential Re-Coding Requirements
Upgrading your WSDL version may necessitate re-coding parts of your application to align with changes in the NetSuite platform. Changes may include:
- New Required Fields:
- Fields that did not exist in previous versions may now be required.
- Optional Fields Becoming Required:
- A previously optional field in older versions may become mandatory in the new version.
- Field Removal:
- A field referenced in your integration might be removed from NetSuite.
- Data Type Changes:
- A field’s data type may have changed.
- SOAP Web Services Method Signature Changes:
- Modifications in the method signature for SOAP web services operations used in your integration.
For detailed insights into WSDL version changes, refer to the Araxis Merge Diff File or review the release notes from your current endpoint to the latest release.
Testing After a WSDL Upgrade
When upgrading your WSDL to utilize new NetSuite features, the following steps are recommended:
- Explore Features via the UI:
- Understand how the new feature works in the NetSuite UI, as SOAP web services typically mirror the UI functionality. This approach minimizes the learning curve for leveraging the feature programmatically.
- Plan and Test Extensively:
- Upgrading a WSDL version may involve significant planning and testing. To avoid disruptions, many organizations opt to upgrade only when their version is nearing retirement (see Support for Existing WSDL Versions).
Testing After a NetSuite Upgrade
NetSuite strives to ensure backward compatibility with each new version. However, unique workflows in your integration may be affected by account upgrades. To avoid issues:
- Test all existing integrations in your Release Preview account before the upgrade.
- Report any issues encountered during testing to facilitate a smooth production upgrade.
By following these practices, you can ensure your integrations remain functional and aligned with the latest NetSuite enhancements.