@fye/netsuite-rest-api

中文文档
2.3.1发布于 2023/06/27ISCCommonJS近 30 天下载 3255

NetSuite Rest API Client

原始使用文档
文档目录5 节
  1. Notable Changes
  2. Required Config values
  3. Other gotchas
  4. Available convenience values
  5. Examples

Nestuite Rest API v2

A wrapper to make REST API request to Netsuite.

Notable Changes

  • Netsuite configuration paramaters are no longer pulled from process.env. They need to be passed in.
  • Body will now returned as parsed object rather than a JSON string

Required Config values

{
  netsuiteApiHost: 'netsuite host',
  consumerKey: 'netsuite consumer key',
  consumerSecret: 'nesuite consumer secret',
  netsuiteAccountId: 'netsuite account id',
  netsuiteTokenKey: 'netsuite token key',
  netsuiteTokenSecret: 'netsuite token secret',
}

Other gotchas

  • Query parameters must be passed in with path. This may be changed at a future time just not now.
  • requestType must be either suiteql, workbook or record

Available convenience values

  • suitesqlPath = services/rest/query/v1/suiteql
  • workbookPath = services/rest/query/v1/workbook
  • salesOrderPath = services/rest/record/v1/salesOrder
  • purchaseOrderPath = services/rest/record/v1/purchaseOrder
  • cashSalePath = services/rest/record/v1/cashSale
  • expandAbleSubResourcesQueryParam = expandSubResources=true

Examples

Get Request

const { makeRequest, expandAbleSubResourcesQueryParam, suitesqlPath } = require('@fye/netsuite-rest-api');

async () => {
  const config = {
    netsuiteApiHost: 'netsuite host',
    consumerKey: 'netsuite consumer key',
    consumerSecret: 'nesuite consumer secret',
    netsuiteAccountId: 'netsuite account id',
    netsuiteTokenKey: 'netsuite token key',
    netsuiteTokenSecret: 'netsuite token secret',
  };
  const requestData = {
    method: 'GET',
    requestType: 'record',
    path: `${s}/1234?${expandAbleSubResourcesQueryParam}`,
  };
  const response = await makeRequest(config, requestData);
};

Update/Patch Request

const { makeRequest } = require('@fye/netsuite-rest-api');

( async () => {
  const config = {...};
  const requestData = {
    method: 'PATCH',
    requestType: 'record',
    path: 'salesorder/1234',
    query: { foo: 'bar' },
  }
  const response = await makeRequest(config, requestData)
})

Suitesql Request

const { makeRequest } = require('@fye/netsuite-rest-api');

( async () => {
  const config = {...};
  const requestData = {
    method: 'POST',
    requestType: 'suitesql',
    query: 'select foo from bar;',
  }
  const response = await makeRequest(config, requestData)
})

Suitesql Request with next URL

const { makeRequest } = require('@fye/netsuite-rest-api');

( async () => {
  const config = {...};
  const requestData = {
    method: 'POST',
    requestType: 'suitesql',
    query: 'select foo from bar;',
    nextUrl: 'https://endpoint.com/services/rest/query/v1/suiteql?limit=10&offset=10'
  }
  const response = await makeRequest(config, requestData)
})

Workbook Request with next URL

const { makeRequest } = require('@fye/netsuite-rest-api');

( async () => {
  const config = {...};
  const requestData = {
    method: 'POST',
    requestType: 'workbook',
    query: 'workbook999',
    nextUrl: 'https://endpoint.com/services/rest/query/v1/workbook/workbook999/result?limit=10&offset=10'
  }
  const response = await makeRequest(config, requestData)
})

版本与发布记录

@fye/netsuite-rest-api 共发布 8 个版本,首次发布于 2020/08/24;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.3.1latest2023/06/273 年前
2.3.02022/11/183 年前
2.2.02022/05/134 年前
2.1.02022/05/114 年前
2.0.02021/01/285 年前
2.0.0-beta-12020/12/295 年前

关于 @fye/netsuite-rest-api 的常见问题

@fye/netsuite-rest-api 是什么?

NetSuite Rest API Client

如何安装 @fye/netsuite-rest-api?

在项目目录运行 npm install @fye/netsuite-rest-api,或使用 pnpm add / yarn add / bun add。

@fye/netsuite-rest-api 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/fye__netsuite-rest-api 是否存在。

@fye/netsuite-rest-api 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@fye/netsuite-rest-api 可以商用吗?

@fye/netsuite-rest-api 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fye/netsuite-rest-api 的下载量有多少?

根据 npm 官方下载统计,@fye/netsuite-rest-api 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,255 次,日均约 109 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fye/netsuite-rest-api 还在维护吗?

最新版本 2.3.1 发布于 2023/06/27(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/08/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。