# @adobe/aio-commerce-sdk 中文文档

规范地址：https://npmcn.com/package/%40adobe/aio-commerce-sdk/

版本：2\.1\.0
npm 元数据更新时间：2026-11-13T10:56:28.002Z
中文译文更新时间：2026-11-13T11:19:52.917Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40adobe/aio-commerce-sdk
原文对照：https://npmcn.com/package/%40adobe/aio-commerce-sdk/?lang=original
源码仓库：https://github.com/adobe/aio-commerce-sdk

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

- 包体积（解压后）：118 kB，88 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22 \<=26
- 运行依赖：6 个
- peer 依赖：react ^19\.2\.7，react-dom ^19\.2\.7，@react-spectrum/s2 ^1\.5\.1
- 首次发布：2025-07-07T11:48:39.686Z
- 最新版本发布：2026-11-13T10:56:27.779Z
- 近 30 天下载量：4956（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：77（近 12 个月 67 个）

## 中文简介

Meta-package 重新将 Adobe Commerce SDK 库输出给 Adobe App Builder 应用程序.

## 安装

```sh
npm install @adobe/aio-commerce-sdk
```

也可以使用：`pnpm add @adobe/aio-commerce-sdk`、`yarn add @adobe/aio-commerce-sdk`、`bun add @adobe/aio-commerce-sdk`

## README

# `@adobe/aio-commerce-sdk`

用于Adobe App Builder应用程序的Meta-package再出Adobe Commerce SDK库.

这个软件包充当App Builder项目中访问常用的 Adobe Commercial 图书馆的方便切入点,类似于如何 [`@adobe/aio-sdk`](https://github.com/adobe/aio-sdk) 用于一般 App 构建器开发的工作.

## 安装

```shell
npm install @adobe/aio-commerce-sdk
```

## 概览

这个 `@adobe/aio-commerce-sdk` 是一个元包,用于集成和再出口Adobe Commercial 库,用于App Builder应用程序。 与其安装和导入多个单个软件包,不如使用这个单个软件包来访问所有必要的商务功能.

### 当前图书馆

目前SDK包括:

-   **[@adobe/aio-commerce-lib-auth (英语)](https://github.com/adobe/aio-commerce-sdk/tree/main/packages/aio-commerce-lib-auth)**: Adobe Commerce apps的认证公用事业,支持IMS和Commerce的集成认证.
    
-   **[@adobe/aio-commerce-lib-core (中文(简体) )](https://github.com/adobe/aio-commerce-sdk/tree/main/packages/aio-commerce-lib-core)**: Adobe Commerce SDK的核心公用事业.
    
-   **[@adobe/aio-commercial-lib-api (英语)](https://github.com/adobe/aio-commerce-sdk/tree/main/packages/aio-commerce-lib-api)**:用于为I/O事件和Adobe商业建设HTTP/API客户端的一套公用事业.
    
-   **[@adobe/aio-commerce-lib-events (英语)](https://github.com/adobe/aio-commerce-sdk/tree/main/packages/aio-commerce-lib-events)**: 事件管理公用设施与Adobe I/O和商务活动API互动.
    
-   **[@adobe/aio-commerce-lib-webhooks (中文(简体) )](https://github.com/adobe/aio-commerce-sdk/tree/main/packages/aio-commerce-lib-webhooks)**:Webhook管理公用设施与Adobe Commerce Webhooks API互动.
    

## 使用量

直接从特定的库子路径导入 :

```typescript
import {
  assertImsAuthParams,
  getImsAuthProvider,
  assertIntegrationAuthParams,
  getIntegrationAuthProvider,
} from "@adobe/aio-commerce-sdk/auth"; // <-- This is like @adobe/aio-commerce-lib-auth

import { AdobeCommerceHttpClient } from "@adobe/aio-commerce-sdk/api"; // <-- This is like @adobe/aio-commerce-lib-api
import {
  createCommerceEventsApiClient,
  updateEventingConfiguration,
} from "@adobe/aio-commerce-sdk/events/commerce"; // <-- This is like @adobe/aio-commerce-lib-events/commerce
import {
  createCommerceWebhooksApiClient,
  subscribeWebhook,
} from "@adobe/aio-commerce-sdk/webhooks/api"; // <-- This is like @adobe/aio-commerce-lib-webhooks/api

// Validate and create IMS auth provider
assertImsAuthParams(params);
const imsAuth = getImsAuthProvider(params);

const commerceHttpClientConfig = {
  auth: imsAuth,
  config: {
    baseUrl: "https://na1-sandbox.api.commerce.adobe.com/{tenantId}/",
    flavor: "saas",
  },
};

const updateEventingConfigurationParams = {
  enabled: true,
  environmentId: "my-environment-id",
  instanceId: "my-instance-id",
  merchantId: "my-merchant-id",
  providerId: "my-provider-id",
  workspaceConfiguration: {
    // ...
  },
};

// Use the raw HTTP client
const commerceClient = new AdobeCommerceHttpClient(commerceHttpClientConfig);
await updateEventingConfiguration(
  commerceClient,
  updateEventingConfigurationParams,
);

// Or create an API client with a pre-bound HTTP client.
const commerceEventsClient = createCommerceEventsApiClient(
  commerceHttpClientConfig,
);

await commerceEventsClient.updateEventingConfiguration(
  updateEventingConfigurationParams,
);

// Create a webhooks API client
const commerceWebhooksClient = createCommerceWebhooksApiClient(
  commerceHttpClientConfig,
);

// Subscribe to a webhook
await commerceWebhooksClient.subscribeWebhook({
  webhook_method: "plugin.order.api.order_created",
  webhook_type: "after",
  batch_name: "default",
  hook_name: "order_created",
  url: "https://example.com/webhook",
  method: "POST",
});
```

发票视图按钮帮助器来自 `@adobe/aio-commerce-sdk/admin-ui/invoice-view-buttons`匹配 `useInvoiceViewButtonContext` 钩子可用自 `@adobe/aio-commerce-sdk/admin-ui/web`见 [管理用户界面使用指南](https://npmcn.com/package/%40adobe/aio-commerce-lib-admin-ui/docs/usage.md#invoice-view-button-wire-contract) iframe( iframe) (`view`)和运行时间动作(`worker`) 实例.

信用备忘录视图按钮帮助器可用自 `@adobe/aio-commerce-sdk/admin-ui/credit-memo-view-buttons`。 。 。 . 匹配 `useCreditMemoViewButtonContext` 钩子可用自 `@adobe/aio-commerce-sdk/admin-ui/web`见 [管理用户界面使用指南](https://npmcn.com/package/%40adobe/aio-commerce-lib-admin-ui/docs/usage.md#credit-memo-view-button-wire-contract) iframe( iframe) (`view`)和运行时间动作(`worker`) 实例.

返回( RMA) 视图按钮帮助工具可用自 `@adobe/aio-commerce-sdk/admin-ui/rma-view-buttons`匹配 `useRmaViewButtonContext` 钩子可用自 `@adobe/aio-commerce-sdk/admin-ui/web`见 [管理用户界面使用指南](https://npmcn.com/package/%40adobe/aio-commerce-lib-admin-ui/docs/usage.md#return-view-button-wire-contract) iframe( iframe) (`view`)和运行时间动作(`worker`) 实例.

## 福利

-   **简化扶养管理**: 安装一个软件包而不是多个单个库
-   **统一版本**:所有包含的库一起测试兼容性
-   **更好的开发者经验**: 通用商务功能的单一进口来源
-   **树摇动支持**: 两种导入模式都支持去除已死代码
-   **类型安全**: 包含类型定义的完整类型脚本支持

## 捐款

这个包裹是Adobe Commerce SDK monorepo的一部分. 见 [贡献指南](https://github.com/adobe/aio-commerce-sdk/blob/main/.github/CONTRIBUTING.md) 财务报告和审定财务报表 [发展指南](https://github.com/adobe/aio-commerce-sdk/blob/main/.github/DEVELOPMENT.md) (c) 发展结构和准则.

如果您想要将您的库添加到 SDK 中, 请参考开发指南的这一部分 : [添加到 SDK( 可选)](https://github.com/adobe/aio-commerce-sdk/blob/main/.github/DEVELOPMENT.md#add-it-to-the-sdk-optional)

## 常见问题

### @adobe/aio-commerce-sdk 是什么？

Meta-package 重新将 Adobe Commerce SDK 库输出给 Adobe App Builder 应用程序\.

### 如何安装 @adobe/aio-commerce-sdk？

在项目目录运行 npm install @adobe/aio-commerce-sdk，或使用 pnpm add / yarn add / bun add。

### @adobe/aio-commerce-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @adobe/aio-commerce-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @adobe/aio-commerce-sdk 需要什么版本的 Node\.js？

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

### @adobe/aio-commerce-sdk 可以商用吗？

@adobe/aio-commerce-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @adobe/aio-commerce-sdk 的下载量有多少？

根据 npm 官方下载统计，@adobe/aio-commerce-sdk 在 2026/10/05 – 2026/11/03 这 30 天内被下载 4,956 次，日均约 165 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @adobe/aio-commerce-sdk 还在维护吗？

最新版本 2\.1\.0 发布于 2026/11/13（今天）；至今共发布 77 个版本，其中过去 12 个月发布了 67 个；首次发布于 2025/07/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。