@useairfoil/producer-shopify

中文文档
0.2.2发布于 2026/11/03TypeScriptES Module构建来源已验证

This connector backfills Shopify products, customers, orders, and refunds. It gets product, cart, customer, order, and refund events at POST /webhooks/shopify.

原始使用文档
文档目录5 节
  1. Config
  2. Setup
  3. Data
  4. Demo data
  5. Local development

Shopify producer

This connector backfills Shopify products, customers, orders, and refunds. It gets product, cart, customer, order, and refund events at POST /webhooks/shopify.

Config

VariableRequiredDefault
SHOPIFY_SHOP_DOMAINyesnone
SHOPIFY_CLIENT_IDyesnone
SHOPIFY_CLIENT_SECRETyesnone
SHOPIFY_WEBHOOK_SECRETyesnone

Use a Shopify app owned by the merchant. The app needs read_products, read_customers, and read_orders. Without read_all_orders, Shopify returns only the last 60 days of orders and their refunds. The webhook secret is not the app client secret.

Setup

Create a Dev Dashboard app in the same Shopify organization as the store. Add the scopes above, install the app, and use its client ID and client secret.

Request protected customer data access for name, email, phone, and address. The config check fails without it.

Create these webhooks in Shopify Admin:

  • products/create
  • products/update
  • products/delete
  • carts/create
  • carts/update
  • customers/create
  • customers/disable
  • customers/enable
  • customers/update
  • customers/delete
  • customers/purchasing_summary
  • customers_email_marketing_consent/update
  • customers_marketing_consent/update
  • customer.tags_added
  • customer.tags_removed
  • orders/create
  • orders/updated
  • orders/delete
  • refunds/create

Point them to /webhooks/shopify and use the webhook signing value as SHOPIFY_WEBHOOK_SECRET. Pick webhook API version 2026-07, the one the connector uses.

Data

  • Customers, orders, and refunds hold protected customer data such as names, emails, phones, addresses, and notes. Treat these tables as customer data.
  • Current order totals include refunds.
  • Order webhooks are mapped without refetching. If Shopify truncates line items on a very large order, the webhook row can miss lines.
  • A refund row does not mean the payment completed. Check its transaction status.
  • Refunds use processedAt for versions. A later settlement can be missed if Shopify keeps the same time.
  • After backfill, updates depend on webhooks. Missed webhook deliveries are not recovered yet.

Demo data

pnpm demo --size 128MiB writes made-up Shopify data without Shopify credentials. See the Connector Kit README for the flags and the variables it needs.

Each customer has orders, refunds, and sometimes an open cart. Orders and carts use a fixed catalog of 10 products, which doesn't grow with the size.

Local development

cd connectors/producer-shopify
pnpm sandbox

A hosted run loads connector config from AIRFOIL_CONFIG_PATH. It also needs the Wings and PostgreSQL variables from the Connector Kit README.

cd connectors/producer-shopify
pnpm start

版本与发布记录

@useairfoil/producer-shopify 共发布 5 个版本,首次发布于 2026/08/14;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.2latest2026/11/03今天
0.2.12026/10/295 天前
0.2.02026/08/252 个月前
0.1.12026/08/142 个月前
0.0.12026/08/142 个月前

关于 @useairfoil/producer-shopify 的常见问题

@useairfoil/producer-shopify 是什么?

此连接器回填Shopify产品、客户、订单和退款。获取产品、购物车、客户、订单和退款事件 POST /webhooks/shopify.

如何安装 @useairfoil/producer-shopify?

在项目目录运行 npm install @useairfoil/producer-shopify,或使用 pnpm add / yarn add / bun add。

@useairfoil/producer-shopify 支持 TypeScript 吗?

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

@useairfoil/producer-shopify 支持 ESM 还是 CommonJS?

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

@useairfoil/producer-shopify 可以商用吗?

@useairfoil/producer-shopify 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@useairfoil/producer-shopify 还在维护吗?

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