Netsuite API Client

Run REST calls and SuiteQL queries against NetSuite SuiteTalk WebServices.

Why this new package?

This package is a fork & merge of popular Netsuite packages netsuite-rest & suiteql, see here for the motivation. This package is ESM only. It adds types thanks to TypeScript, and more recent dependencies to handle recent CVEs on got package mainly. It meant to be actively supported in the future.

If you need to stay on CommonJS, you can still use netsuite-rest or suiteql by ehmad11!

Installation

npm i netsuite-api-client

Quick Start

To set up TBA in Netsuite, see the help topic Getting Started with Token-based Authentication.

import { NetsuiteApiClient } from "netsuite-api-client";
const client = new NetsuiteApiClient({
  consumer_key: process.env.consumer_key,
  consumer_secret_key: process.env.consumer_secret_key,
  token: process.env.token,
  token_secret: process.env.token_secret,
  realm: process.env.realm,
  base_url: process.env.base_url,
});

request

request accepts the following options:

• path (optional): REST path under /services/rest/.
• restletUrl (optional): full URL for RESTlet calls (bypasses path URL building).
• method (optional): HTTP method, defaults to GET.
• body (optional): request body as a string.
• heads (optional): additional headers.
• overrides (optional): raw got request options (OptionsOfTextResponseBody) merged into the internal defaults.

Test

client
  .request({
    path: "*",
    method: "OPTIONS",
  })
  .then((response) => console.log(response))
  .catch((err) => console.log(err));

GET

client
  .request({
    path: "record/v1/customer/",
  })
  .then((response) => response.data)
  .then((data) => console.log(data.links))
  .catch((err) => console.log(err));

Override got options

Use overrides when you need to pass advanced got options (for example timeout/retry).

client.request({
  path: "record/v1/customer/",
  overrides: {
    timeout: { request: 15000 },
    retry: { limit: 0 },
  },
});

query

query(string, (limit = 1000), (offset = 0));

• string - Select query to run
• limit - Limit number of rows, max is 1000
• offset - Rows to start from

This method returns with the promise support, response will be in JSON format

Example

const transactions = await client.query("select id from transaction", 10, 0);

queryAll (Stream)

When working on large number of rows, stream is handy

queryAll(string, (limit = 1000));

• string - Select query to run
• limit - Limit number of rows, max is 1000

Example

const items = [];
const st = client.queryAll(`
        select
            tranid, id from transaction
        where
            rownum <= 30
    `);

st.on("data", (data) => {
  items.push(data);
});

st.on("end", () => {
  console.log("stream ended");
});

st.on("error", (err) => {
  console.log(err);
});

Response

Requests are returned with promise support. HTTP response codes other than 2xx will cause the promise to be rejected.

The Netsuite error will be preserved in the error message, so you don't have to read the got HttpError ! For example:

Invalid search query. Detailed unprocessed description follows. Search error occurred: Unknown identifier 'not_existing_field'. Available identifiers are: {customer=customer}

Metadata

client.request({ path: "record/v1/metadata-catalog/" });

Record is the name of the service we are trying to access, v1 is the service version, and metadata-catalog is the sub-resource, that is, the record metadata. The response informs you through HATEOAS links about the possible mediaType flavor in which the response can be obtained.

HATEOAS

You can navigate to the referenced resources without deeper knowledge of the system. A typical response contains "links" sections for each resource, which can be a sub-resource of a parent resource or any other referenced resource. You can use links to work with those resources.

More Resources

SuiteTalk REST Web Services

Overview and Setup - Official Documentation

Netsuite Rest API Browser

REST API Browser provides a visual overview of the structure and capabilities of the REST web services Record API. The data presented in the REST API Browser is based on OpenAPI 3.0 metadata.

Release a new version to npm

1. Make sure your branch is up to date and tests pass locally.

pnpm install
pnpm build
pnpm test

2. Bump the package version (pick one: patch, minor, or major).

pnpm version patch

3. Push the commit and tag created by pnpm version.

git push
git push --tags

4. Publish to npm.

pnpm publish

prepublishOnly runs pnpm build automatically before publishing.