What we do
Tools
Industries
Department
How we workLet's talk →
Home/NetSuite/NetSuite API
NetSuite API

The NetSuite API: Which One to Use, and How to Connect to It

NetSuite has more than one API. SuiteTalk REST web services handle records and SuiteQL queries, RESTlets run your own SuiteScript behind an endpoint, and SuiteTalk SOAP is on its way out. Oracle now says new integrations should be built on REST with OAuth 2.0. Here's which one fits your job, then the mistakes that break integrations under real load.

Which NetSuite API for which job

Create, read or update standard and custom records (customers, items, sales orders, custom records): SuiteTalk REST web services, the record API.

Pull data out in bulk or join several record types: SuiteQL through the REST query endpoint. It's SQL-like, and usually far fewer calls than fetching records one by one.

Logic REST can't express, like several dependent writes in one call or a custom response shape: a RESTlet, which is SuiteScript you deploy and call over HTTPS. Oracle recommends RESTlets only where REST can't cover it.

Logic that should run inside NetSuite when a record saves or on a schedule: SuiteScript, not an external API call.

SuiteTalk SOAP: only for keeping an existing integration alive while you move it. Oracle stops new SOAP integrations from release 2027.1 and disables SOAP in 2028.2.

Token-based authentication or OAuth 2.0?

Most older integrations use token-based authentication (TBA). Oracle's direction is clear, but existing REST integrations on TBA aren't forced to move yet.

TBA

Fine for what already runs

  • Consumer key and secret plus a token ID and secret, signed on every request.
  • SOAP only works with TBA. It has no OAuth 2.0 option.
  • From release 2027.1 you can no longer build new integrations on TBA.
  • Existing REST and RESTlet integrations on TBA keep working. Oracle recommends moving them, but does not require it.
OAuth 2.0

What new integrations should use

  • Authorization code flow when a person signs in to grant access.
  • Client credentials (machine to machine) for server-to-server syncs, signed with a certificate you upload to NetSuite.
  • Machine-to-machine access tokens last 60 minutes and there is no refresh token, so the integration requests a new one itself.
  • Covers REST web services and RESTlets.

Building something new now? Use REST with OAuth 2.0 client credentials. Keep TBA only on integrations you aren't touching, and plan their move before you need to change them.

Where NetSuite integrations break

These are the faults that pass in a sandbox with ten test records and fail on the first real month end.

Every integration draws on the same concurrency pool

How you'll know: Requests get rejected at busy times, often when a connector, a reporting tool and your new sync all run at once.

Fix: Web services and RESTlet calls share one account-wide concurrency limit, set by your service tier and raised by SuiteCloud Plus licenses. Check it under Setup > Integration > Integration Management > Integration Governance, give each integration its own allocation, and queue and retry rather than firing calls in parallel.

Fetching records one at a time

How you'll know: A nightly export takes hours and gets slower every month as the record count grows.

Fix: Read in bulk with SuiteQL and paginate, then write back only what changed. Track a last-modified date so each run picks up where the last one stopped.

Custom fields and forms nobody mapped

How you'll know: A write fails with a missing-field error, or succeeds but leaves a required custom field blank that a workflow depends on.

Fix: List the custom fields, custom records and mandatory fields on each record type before writing any mapping, and test against the forms your users actually use.

Token expiry treated as an outage

How you'll know: An OAuth 2.0 sync fails roughly an hour after it starts, every time.

Fix: Machine-to-machine access tokens expire after 60 minutes. Request a new one before it runs out, or on the first authorization error, and retry that call.

A SOAP integration nobody has a plan for

How you'll know: An old connector or in-house script still calls a SOAP endpoint, and nobody knows which version.

Fix: Find every SOAP caller now. Oracle's last planned SOAP endpoint is 2025.2, and all SOAP integrations stop working in 2028.2. Rebuild on REST and run old and new side by side until the outputs match.

Prebuilt connector, or custom work on the API?

What you're connecting Usually enough When it needs custom API work
Salesforce or HubSpot to NetSuite A middleware connector, such as Celigo or Boomi, set up for the pairing. More in Salesforce and NetSuite and HubSpot and NetSuite. Your quote-to-order process has steps the connector's templates don't model, or deals carry custom fields that have to land on custom NetSuite records.
A common e-commerce or shipping platform A SuiteApp or connector built for that platform. Orders need splitting across subsidiaries or locations, or fulfilment rules depend on your own data.
A warehouse, support desk or in-house app nobody sells a connector for Nothing prebuilt, usually. Always custom: REST and SuiteQL for the data, a RESTlet if the logic has to run inside NetSuite.
A data warehouse or BI tool NetSuite's own analytics or a connector your BI tool ships with. You need incremental loads, deleted-record handling, or joins the connector doesn't offer.

Questions people ask

Does NetSuite have a REST API?

Yes. SuiteTalk REST web services cover record operations and SuiteQL queries, and Oracle now recommends REST with OAuth 2.0 for every new integration. The older SuiteTalk SOAP API still runs for existing integrations, but no new SOAP integrations can be built from release 2027.1 and SOAP is switched off in 2028.2.

What's the difference between SuiteTalk and SuiteScript?

SuiteTalk is the set of web services you call from outside NetSuite to move data in and out. SuiteScript is JavaScript that runs inside NetSuite, triggered by a record saving, a schedule or a button. A RESTlet sits between the two: SuiteScript you write and deploy, which outside systems call over HTTPS.

Can NetSuite integrate with Salesforce?

Yes. Most companies use middleware built for the pairing, and some build directly against both APIs when their sales process doesn't fit the connector's mapping. The Salesforce NetSuite integration page covers the trade-offs.

Do I need a developer to build on NetSuite's API?

For anything past a prebuilt connector's setup, yes. Authentication, concurrency limits, custom fields and error handling all need someone writing and testing code against a sandbox. n-frames does that work, from a single sync to replacing an inherited SOAP integration.

Is a prebuilt NetSuite connector enough, or do I need custom integration?

If you're syncing standard records (customers, items, ordinary sales orders) between NetSuite and a mainstream platform, a connector often covers it. Once a custom record type, a business-specific rule or a system nobody makes a connector for is involved, custom API work is usually the cleaner answer.

Is the NetSuite SOAP API being retired?

Yes. Oracle's last planned SOAP endpoint is 2025.2. From 2027.1 no new SOAP integrations can be built, because they rely on token-based authentication, which can't be used for new integrations from that release. In 2028.2 all SOAP endpoints are disabled and SOAP integrations stop working.

What is SuiteQL?

A SQL-like query language for NetSuite data. Through the REST API you send a query and get rows back, which makes bulk reads and joins across record types much cheaper than fetching records one at a time.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.