@amazon-sp-api-release/amazon-sp-api-sdk-js

中文文档
1.14.0发布于 2026/11/03Apache License 2.0ES Module构建来源已验证近 30 天下载 3.3万

这个软件包正在销售合作伙伴API Javascript SDK,用于与LWA图书馆的节点JS.

中文使用文档
文档目录4 节
  1. JavaScript SDK 用于销售合伙人 API
  2. 开始
  3. 使用 SDK
  4. 提供反馈

JavaScript SDK 用于销售合伙人 API

npm version

Video Thumbnail

点击图像观看视频 .

JavaScript的销售伙伴API SDK使您能够轻松地将您的JavaScript/Node.js应用程序连接到亚马逊基于REST的销售伙伴API.

开始

全权证书

在使用SDK之前,需要注册为销售伙伴API开发商. 如果你还没有这样做, 请遵守指示 SP-API 登记概况。 。 。 . 您还需要注册您的申请,才能获得有效的证书来拨打SP-API. 如果你还没有做到这一点, 请遵守指示英寸 正在注册您的申请。 。 。 . 如果您已经成功注册, 您可以找到如何查看您的证书的指令 查看您的应用程序信息和证书。 。 。 .

最低要求

运行SDK需要节点版14或更高.

安装 SDK

  1. 查找最新版本编号 这里。 。 。 .
  2. 将依赖性添加到您的工程中( 请参见指令 无, (中文(简体) ), 线条 财务报告和审定财务报表 添加为包依赖 页:1.
使用 npm :
npm install @amazon-sp-api-release/amazon-sp-api-sdk-js
使用线条 :
yarn add @amazon-sp-api-release/amazon-sp-api-sdk-js
添加为包依赖

添加以下一行到 dependencies 在你身边 package.json 文件 :

"@amazon-sp-api-release/amazon-sp-api-sdk-js": "^1.0.0"

使用 SDK

要调用销售伙伴API中包含的API之一,您需要:

  1. 配置证书( 注: 使用您的个人证书进行 clientId, (中文(简体) ), clientSecret 财务报告和审定财务报表 refreshToken(中文(简体) )
  2. 启用自动 accessToken 使用我们构建的 ApiClient 函数 OR 检索 accessToken 使用我们的 LwaAuthClient 帮助( 注意一些 API, 您需要额外的步骤才能获得) RDT Token(中文(简体) )
  3. 创建特定 API 和 API 客户端的示例,然后应用 accessToken 对它.
  4. 调用 API 操作

例如,参考以下连接到Sellers API的样本代码:

import {
  SellersSpApi
} from '@amazon-sp-api-release/amazon-sp-api-sdk-js';

async function getMarketplaceParticipations() {
  try {
      //Configure Sellers ApiClient
      const sellersApiClient = new SellersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
      sellersApiClient.enableAutoRetrievalAccessToken('<YOUR_CLIENT_ID>','<YOUR_CLIENT_SECRET>', '<YOUR_REFRESH_TOKEN>', null);
      const sellersApi = new SellersSpApi.SellersApi(sellersApiClient);
      
      //Call GetMarkerplaceParticipations API
      const participations = await sellersApi.getMarketplaceParticipations();
      console.log(
        JSON.stringify(participations, null, ' ') + 
          '\n**********************************'
      )
  } catch (error) {
      console.error('Exception when calling getMarketplaceParticipations API', error.message);
  }
}

getMarketplaceParticipations();

或者,你可以去 @amazon-sp-api-release/amazon-sp-api-sdk-js/sample-node-app 复制并修改 index.js 财务报告和审定财务报表 app.config.mjs 让他们试试看 可以看到多个API操作调用样本,并有各种取回符号的方法,以及制作API调用时如何设置速率限制器并重试逻辑. 请注意, 速率限制器是默认打开的, 以保护您的 API 电话不被 429 个错误 .

附加说明:

这个亚马逊销售伙伴API JavaScript SDK完全兼容ECMAScript模块(ESM). 您可以使用现代 ES6+ 导入/导出语法, 如示例代码所示 :

import {
  SellersSpApi,
} from '@amazon-sp-api-release/amazon-sp-api-sdk-js';

提供反馈

我们需要你的帮助 使这个SDK伟大。 请参加社区活动,通过提交问题、参加讨论论坛和通过下列渠道提交拉动请求,为这项工作作出贡献:

提交 问题 - 这是与我们团队互动的首选频道 描述您的特性请求, 或高调已有的 问题 页 次

版本与发布记录

@amazon-sp-api-release/amazon-sp-api-sdk-js 共发布 28 个版本,首次发布于 2025/04/07;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.14.0latest2026/11/032 天前
1.13.02026/10/021 个月前
1.12.02026/08/272 个月前
1.11.02026/08/072 个月前
1.10.12026/08/033 个月前
1.10.02026/07/313 个月前

其他发布通道:alpha → 1.6.1-alpha.0。

关于 @amazon-sp-api-release/amazon-sp-api-sdk-js 的常见问题

@amazon-sp-api-release/amazon-sp-api-sdk-js 是什么?

这个软件包正在销售合作伙伴API Javascript SDK,用于与LWA图书馆的节点JS.

如何安装 @amazon-sp-api-release/amazon-sp-api-sdk-js?

在项目目录运行 npm install @amazon-sp-api-release/amazon-sp-api-sdk-js,或使用 pnpm add / yarn add / bun add。

@amazon-sp-api-release/amazon-sp-api-sdk-js 支持 TypeScript 吗?

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

@amazon-sp-api-release/amazon-sp-api-sdk-js 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@amazon-sp-api-release/amazon-sp-api-sdk-js 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=14.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@amazon-sp-api-release/amazon-sp-api-sdk-js 可以商用吗?

@amazon-sp-api-release/amazon-sp-api-sdk-js 使用 Apache License 2.0 许可。声明的许可为 Apache License 2.0,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@amazon-sp-api-release/amazon-sp-api-sdk-js 的下载量有多少?

根据 npm 官方下载统计,@amazon-sp-api-release/amazon-sp-api-sdk-js 在 2026/10/06 – 2026/11/04 这 30 天内被下载 33,136 次,日均约 1,105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@amazon-sp-api-release/amazon-sp-api-sdk-js 还在维护吗?

最新版本 1.14.0 发布于 2026/11/03(2 天前);至今共发布 28 个版本,其中过去 12 个月发布了 13 个;首次发布于 2025/04/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。