# @fye/netsuite-rest-api 中文文档

规范地址：https://npmcn.com/package/%40fye/netsuite-rest-api/

版本：2\.3\.1
npm 元数据更新时间：2023-06-27T13:49:25.370Z
中文译文更新时间：2026-11-15T19:59:23.050Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fye/netsuite-rest-api
原文对照：https://npmcn.com/package/%40fye/netsuite-rest-api/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：16.6 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2020-08-24T14:01:56.992Z
- 最新版本发布：2023-06-27T13:49:25.237Z
- 近 30 天下载量：3255（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

NetSuite 休息 API 客户端

## 安装

```sh
npm install @fye/netsuite-rest-api
```

也可以使用：`pnpm add @fye/netsuite-rest-api`、`yarn add @fye/netsuite-rest-api`、`bun add @fye/netsuite-rest-api`

## README

# Nestite Rest API v2 (英语)

将 REST API 请求到 Netsite 的包装器 .

### 显著变化

-   网络套接字配置参数不再从 `process.env`他们需要通过.
-   身体现在将作为解析对象而不是 JSON 字符串返回

## 需要的配置值

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

## 其他杂技

-   查询参数必须随路径相传 。 这一点可能在不久的将来改变.
-   `requestType` 肯定就是那个 `suiteql`, (中文(简体) ), `workbook` 或者说 `record`

## 可用的便利值

-   `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`

## 实例

#### 获取请求

```js
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);
};
```

#### 更新/批次请求

```js
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)
})
```

#### 申请

```js
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)
})
```

#### 下一个 URL 请求

```js
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)
})
```

#### 工作簿请求与下一个 URL

```js
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 是什么？

NetSuite 休息 API 客户端

### 如何安装 @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 和提交记录判断。