SuiteTalk SOAP Web Services Platform Overview
The SOAP web services platform provides programmatic access to your NetSuite data and business processes through an XML-based application programming interface (API). Generally speaking, the SOAP web services platform has the following characteristics:
-
SOAP encoded web services – the Platform uses SOAP-based web services with document style, or Doc style, encoding.
Doc style encoding consists of message-oriented exchanges where an XML schema specified within the SOAP message defines the structure of any messages sent between two applications. RPC exchanges are NOT supported.
-
HTTPS Transport – currently the only transport supported is HTTPS as defined in the WSDL document.
For a list of NetSuite records that are supported in SOAP web services development, see SOAP Web Services Supported Records and the SOAP Schema Browser . To see code samples of all SOAP web services operations, see SOAP Web Services Operations.
To maintain the highest security standards for connectivity, NetSuite periodically updates server certificates and the trusted certificate store we use for https requests. We expect client applications that integrate with NetSuite to use an up-to-date certificate store, to ensure that integrations do not break because of certificates expiring or changing security standards. This issue typically does not affect modern browsers because these clients are maintained to use the latest certificates.
Although the following material pertains to the 2023.2 WSDL, NetSuite continues to support endpoints released prior to 2023.2. For documentation about older endpoints that are supported, see SOAP Web Services Archives. For more information, see also NetSuite WSDL and XSD Structure and NetSuite WSDL Versioning.
In This Guide
Refer to the following sections to learn more about the SOAP web services platform:
SOAP Web Services Setup — provides steps for getting your SOAP web services development environment set up to create your first service. It also describes how to modify or set SOAP web services preferences. This section also describes general concepts that pertains to SOAP web services development.
SOAP Web Services Preferences — provides information on setting company-wide preferences, request level preferences, search preferences, and setting the Internal ID preference.
Integration Management — provides information about managing external applications by using integration records.
Roles and Permissions in SOAP Web Services — defines the concept of a role within NetSuite and the necessity of providing a role ID during authentication. This section also describes how to assign a default role to a SOAP web services user, as well as how to set a “Web Services Only” role for a user.
Records, Fields, Forms, and Sublists in SOAP Web Services — describes how to work with records, field, and sublist objects in SOAP web services. This section also provides information on working with custom forms.
SOAP Web Services Processing — describes how to process requests synchronously versus asynchronously. Also provided are steps for monitoring your SOAP web services requests.
SOAP Web Services Security — describes all aspects of SOAP web services security and session management.
Platform Features — describes the Web Services Concurrent License.
Types — describes the various types available in the SOAP web services platform.
SOAP Web Services Operations — describes each operation that can be performed through SOAP web services and provides SOAP, C# and Java code samples.
SOAP Web Services PHP Toolkit — describes the tools that assist in the development of PHP applications that interface to the SOAP web services platform.
SOAP Web Services Error Handling and Error Codes — provides tables of possible SOAP faults, fault status codes and error status codes that can be thrown for a particular request.