# @commercetools/checkout-sdk 中文文档

规范地址：https://npmcn.com/package/%40commercetools/checkout-sdk/

版本：2\.2\.0
npm 元数据更新时间：2026-11-02T10:58:22.995Z
中文译文更新时间：2026-11-10T12:08:40.930Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40commercetools/checkout-sdk
原文对照：https://npmcn.com/package/%40commercetools/checkout-sdk/?lang=original
项目主页：https://github.com/commercetools/commercetools-sdk-typescript/packages/checkout-sdk
源码仓库：https://github.com/commercetools/commercetools-sdk-typescript

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

- 包体积（解压后）：570 kB，90 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2025-10-02T12:54:43.304Z
- 最新版本发布：2026-11-02T10:58:22.642Z
- 近 30 天下载量：10770（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 9 个）

## 中文简介

商务工具的打字机 SDK 检查 API

## 安装

```sh
npm install @commercetools/checkout-sdk
```

也可以使用：`pnpm add @commercetools/checkout-sdk`、`yarn add @commercetools/checkout-sdk`、`bun add @commercetools/checkout-sdk`

## README

# 商务工具检出 API 的打字机 SDK .

## 用法实例

### 浏览器环境

```html
<script src="https://unpkg.com/@commercetools/ts-client@latest/dist/commercetools-sdk-client-v3.umd.js"></script>
<script src="https://unpkg.com/@commercetools/checkout-sdk@latest/dist/commercetools-checkout-sdk.umd.js"></script>
```

```html
<script>
  // global: @commercetools/ts-client
  // global: @commercetools/checkout-sdk
  ;(function () {
    //  We can now access the ts-client and checkout-sdk object as:
    //  const { ClientBuilder } = this['@commercetools/ts-client']
    //  const { createApiBuilderFromCtpClient } = this['@commercetools/checkout-sdk']
    //  or
    //  const { ClientBuilder } = window['@commercetools/ts-client']
    //  const { createApiBuilderFromCtpClient } = window['@commercetools/checkout-sdk']
  })()
</script>
```

### 节点环境

```bash
npm install --save @commercetools/ts-client
npm install --save @commercetools/checkout-sdk
```

```ts
const {
  ClientBuilder,
  createAuthForClientCredentialsFlow,
  createHttpClient,
} = require('@commercetools/ts-client')
const { createApiBuilderFromCtpClient } = require('@commercetools/checkout-sdk')

const projectKey = 'mc-project-key'
const authMiddlewareOptions = {
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'mc-client-id',
    clientSecret: 'mc-client-secrets',
  },
  oauthUri: '/oauth/token', // - optional: custom oauthUri
  scopes: [`manage_project:${projectKey}`],
  fetch,
}

const httpMiddlewareOptions = {
  host: 'https://checkout.europe-west1.gcp.commercetools.com',
  fetch,
}

const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
  .withMiddleware(createHttpClient(httpMiddlewareOptions))
  .withUserAgentMiddleware()
  .build()

// or
const client = new ClientBuilder()
  .withProjectKey(projectKey)
  .withClientCredentialsFlow(authMiddlewareOptions)
  .withHttpMiddleware(httpMiddlewareOptions)
  .withUserAgentMiddleware()
  .build()

const apiRoot = createApiBuilderFromCtpClient(client)

// calling the checkout-sdk functions
// create a new transaction using the checkout sdk
apiRoot
  .withProjectKey({ projectKey })
  .transactions()
  .post({
    body: {
      application: {
        typeId: 'application',
        key: 'checkout-application-key',
      },
      transactionItems: [
        {
          paymentIntegration: {
            typeId: 'payment-integration',
            id: 'payment-integration-id',
          },
          amount: {
            centAmount: 1000,
            currencyCode: 'EUR',
          },
        },
      ],
      cart: {
        typeId: 'cart',
        id: 'cart-id',
      },
    },
  })
  .execute()
  .then(...)
  .catch(...)

-----------------------------------------------------------------------
// The ts-client also has support for the old syntax
import {
  createClient,
  createHttpClient,
  createAuthForClientCredentialsFlow,
} from '@commercetools/ts-client'
import { createApiBuilderFromCtpClient } from '@commercetools/checkout-sdk'

const projectKey = 'some_project_key'

const authMiddleware = createAuthForClientCredentialsFlow({
  host: 'https://auth.europe-west1.gcp.commercetools.com',
  projectKey,
  credentials: {
    clientId: 'some_id',
    clientSecret: 'some_secret',
  },
  httpClient: fetch,
})

const httpMiddleware = createHttpClient({
  host: 'https://checkout.europe-west1.gcp.commercetools.com',
  httpClient: fetch,
})

const ctpClient = createClient({
  middlewares: [authMiddleware, httpMiddleware],
})

const apiRoot = createApiBuilderFromCtpClient(ctpClient)

apiRoot
  .withProjectKey({ projectKey })
  .transactions()
  .post({
    body: {
      application: {
        typeId: 'application',
        key: 'checkout-application-key',
      },
      transactionItems: [
        {
          paymentIntegration: {
            typeId: 'payment-integration',
            id: 'payment-integration-id',
          },
          amount: {
            centAmount: 1000,
            currencyCode: 'EUR',
          },
        },
      ],
      cart: {
        typeId: 'cart',
        id: 'cart-id',
      },
    },
  })
  .execute()
  .then(...)
  .catch(...)
```

## 常见问题

### @commercetools/checkout-sdk 是什么？

商务工具的打字机 SDK 检查 API

### 如何安装 @commercetools/checkout-sdk？

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

### @commercetools/checkout-sdk 支持 TypeScript 吗？

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

### @commercetools/checkout-sdk 支持 ESM 还是 CommonJS？

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

### @commercetools/checkout-sdk 需要什么版本的 Node\.js？

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

### @commercetools/checkout-sdk 可以商用吗？

@commercetools/checkout-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @commercetools/checkout-sdk 的下载量有多少？

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

### @commercetools/checkout-sdk 还在维护吗？

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