Files
sim/apps/docs/content/docs/zh/tools/shopify.mdx
Waleed 5d791cd55f feat(i18n): update translations (#2178)
* feat(i18n): update translations

* memory optimizations

---------

Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
2025-12-04 00:18:21 -08:00

445 lines
15 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: Shopify
description: 在您的 Shopify 商店中管理产品、订单、客户和库存
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="shopify"
color="#FFFFFF"
/>
{/* MANUAL-CONTENT-START:intro */}
[Shopify](https://www.shopify.com/) 是一个领先的电子商务平台旨在帮助商家构建、运营和发展他们的在线商店。Shopify 让您可以轻松管理商店的各个方面,从产品和库存到订单和客户。
在 Sim 中使用 Shopify您的代理可以
- **创建和管理产品**:添加新产品、更新产品详情以及从商店中移除产品。
- **列出和检索订单**:获取客户订单信息,包括筛选和订单管理。
- **管理客户**:访问和更新客户详情,或将新客户添加到您的商店。
- **调整库存水平**:以编程方式更改产品库存水平,确保库存准确无误。
使用 Sim 的 Shopify 集成,直接从您的自动化流程中自动化常见的商店管理工作流,例如同步库存、履行订单或管理商品列表。通过简单的编程工具,赋能您的代理访问、更新和组织所有商店数据。
{/* MANUAL-CONTENT-END */}
## 使用说明
将 Shopify 集成到您的工作流程中。管理产品、订单、客户和库存。创建、读取、更新和删除产品。列出和管理订单。处理客户数据并调整库存水平。
## 工具
### `shopify_create_product`
在您的 Shopify 商店中创建一个新产品
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `title` | string | 是 | 产品标题 |
| `descriptionHtml` | string | 否 | 产品描述 \(HTML\) |
| `vendor` | string | 否 | 产品供应商/品牌 |
| `productType` | string | 否 | 产品类型/类别 |
| `tags` | array | 否 | 产品标签 |
| `status` | string | 否 | 产品状态 \(ACTIVE, DRAFT, ARCHIVED\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `product` | object | 创建的产品 |
### `shopify_get_product`
通过 ID 从您的 Shopify 商店获取单个产品
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `productId` | string | 是 | 产品 ID \(gid://shopify/Product/123456789\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `product` | object | 产品详情 |
### `shopify_list_products`
从您的 Shopify 商店列出产品并可选进行筛选
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `first` | number | 否 | 返回的产品数量 \(默认50最大250\) |
| `query` | string | 否 | 用于筛选产品的搜索查询 \(例如:"title:shirt" 或 "vendor:Nike" 或 "status:active"\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `products` | array | 产品列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_update_product`
更新您 Shopify 商店中的现有产品
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `productId` | string | 是 | 要更新的产品 ID \(gid://shopify/Product/123456789\) |
| `title` | string | 否 | 新的产品标题 |
| `descriptionHtml` | string | 否 | 新的产品描述 \(HTML\) |
| `vendor` | string | 否 | 新的产品供应商/品牌 |
| `productType` | string | 否 | 新的产品类型/类别 |
| `tags` | array | 否 | 新的产品标签 |
| `status` | string | 否 | 新的产品状态 \(ACTIVE, DRAFT, ARCHIVED\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `product` | object | 更新后的产品 |
### `shopify_delete_product`
从您的 Shopify 商店中删除产品
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `productId` | string | 是 | 要删除的产品 ID \(gid://shopify/Product/123456789\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `deletedId` | string | 已删除产品的 ID |
### `shopify_get_order`
通过 ID 从您的 Shopify 商店获取单个订单
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `orderId` | string | 是 | 订单 ID \(gid://shopify/Order/123456789\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `order` | object | 订单详情 |
### `shopify_list_orders`
从您的 Shopify 商店列出订单并可选择过滤
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `first` | number | 否 | 要返回的订单数量 \(默认值50最大值250\) |
| `status` | string | 否 | 按订单状态过滤 \(open, closed, cancelled, any\) |
| `query` | string | 否 | 用于过滤订单的搜索查询 \(例如:"financial_status:paid" 或 "fulfillment_status:unfulfilled" 或 "email:customer@example.com"\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `orders` | array | 订单列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_update_order`
更新 Shopify 商店中的现有订单(备注、标签、电子邮件)
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `orderId` | string | 是 | 要更新的订单 ID \(gid://shopify/Order/123456789\) |
| `note` | string | 否 | 新的订单备注 |
| `tags` | array | 否 | 新的订单标签 |
| `email` | string | 否 | 订单的新客户电子邮件 |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `order` | object | 更新后的订单 |
### `shopify_cancel_order`
取消 Shopify 商店中的订单
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `orderId` | string | 是 | 要取消的订单 ID \(gid://shopify/Order/123456789\) |
| `reason` | string | 是 | 取消原因 \(CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER\) |
| `notifyCustomer` | boolean | 否 | 是否通知客户取消订单 |
| `refund` | boolean | 否 | 是否退款 |
| `restock` | boolean | 否 | 是否补充库存 |
| `staffNote` | string | 否 | 关于取消的员工备注 |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `order` | object | 取消结果 |
### `shopify_create_customer`
在您的 Shopify 商店中创建一个新客户
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `email` | string | 否 | 客户电子邮件地址 |
| `firstName` | string | 否 | 客户名字 |
| `lastName` | string | 否 | 客户姓氏 |
| `phone` | string | 否 | 客户电话号码 |
| `note` | string | 否 | 关于客户的备注 |
| `tags` | array | 否 | 客户标签 |
| `addresses` | array | 否 | 客户地址 |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `customer` | object | 创建的客户 |
### `shopify_get_customer`
通过 ID 从您的 Shopify 商店获取单个客户
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `customerId` | string | 是 | 客户 ID \(gid://shopify/Customer/123456789\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `customer` | object | 客户详情 |
### `shopify_list_customers`
列出 Shopify 商店中的客户,并支持可选筛选
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `first` | number | 否 | 要返回的客户数量 \(默认50最大250\) |
| `query` | string | 否 | 用于筛选客户的搜索查询 \(例如:"first_name:John" 或 "last_name:Smith" 或 "email:*@gmail.com" 或 "tag:vip"\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `customers` | array | 客户列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_update_customer`
更新 Shopify 商店中的现有客户
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `customerId` | string | 是 | 要更新的客户 ID \(gid://shopify/Customer/123456789\) |
| `email` | string | 否 | 新的客户电子邮件地址 |
| `firstName` | string | 否 | 新的客户名字 |
| `lastName` | string | 否 | 新的客户姓氏 |
| `phone` | string | 否 | 新的客户电话号码 |
| `note` | string | 否 | 关于客户的新备注 |
| `tags` | array | 否 | 新的客户标签 |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `customer` | object | 更新后的客户 |
### `shopify_delete_customer`
从您的 Shopify 商店中删除客户
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `customerId` | string | 是 | 要删除的客户 ID \(gid://shopify/Customer/123456789\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `deletedId` | string | 已删除客户的 ID |
### `shopify_list_inventory_items`
列出您的 Shopify 商店中的库存商品。使用此功能通过 SKU 查找库存商品 ID。
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `first` | number | 否 | 要返回的库存商品数量 \(默认值50最大值250\) |
| `query` | string | 否 | 用于筛选库存商品的搜索查询 \(例如:"sku:ABC123"\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `inventoryItems` | array | 包含其 ID、SKU 和库存水平的库存商品列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_get_inventory_level`
获取特定位置的产品变体的库存水平
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `inventoryItemId` | string | 是 | 库存商品 ID \(gid://shopify/InventoryItem/123456789\) |
| `locationId` | string | 否 | 用于筛选的地点 ID \(可选\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `inventoryLevel` | object | 库存级别详情 |
### `shopify_adjust_inventory`
调整特定位置的产品变体库存数量
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `inventoryItemId` | string | 是 | 库存项 ID \(gid://shopify/InventoryItem/123456789\) |
| `locationId` | string | 是 | 位置 ID \(gid://shopify/Location/123456789\) |
| `delta` | number | 是 | 调整数量 \(正数表示增加,负数表示减少\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `inventoryLevel` | object | 库存调整结果 |
### `shopify_list_locations`
列出您的 Shopify 商店中的库存位置。使用此功能查找库存操作所需的位置 ID。
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `first` | number | 否 | 返回的位置数量 \(默认值50最大值250\) |
| `includeInactive` | boolean | 否 | 是否包含已停用的位置 \(默认值false\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `locations` | array | 包含位置 ID、名称和地址的位置列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_create_fulfillment`
创建一个履行记录以将订单商品标记为已发货。需要一个履行订单 ID可从订单详情中获取
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名例如mystore.myshopify.com |
| `fulfillmentOrderId` | string | 是 | 履行订单 ID例如gid://shopify/FulfillmentOrder/123456789 |
| `trackingNumber` | string | 否 | 发货的追踪号码 |
| `trackingCompany` | string | 否 | 运输承运商名称例如UPS、FedEx、USPS、DHL |
| `trackingUrl` | string | 否 | 用于追踪发货的 URL |
| `notifyCustomer` | boolean | 否 | 是否向客户发送发货确认邮件默认值true |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `fulfillment` | object | 包含追踪信息和已履行商品的创建履行记录 |
### `shopify_list_collections`
列出 Shopify 商店中的商品集合。可按标题、类型(自定义/智能)或句柄进行筛选。
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名例如mystore.myshopify.com |
| `first` | number | 否 | 要返回的集合数量默认值50最大值250 |
| `query` | string | 否 | 用于筛选集合的搜索查询例如“title:Summer” 或 “collection_type:smart” |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `collections` | array | 包含集合的 ID、标题和商品数量的列表 |
| `pageInfo` | object | 分页信息 |
### `shopify_get_collection`
通过 ID 获取特定集合,包括其产品。使用此功能可以检索集合中的产品。
#### 输入
| 参数 | 类型 | 必需 | 描述 |
| --------- | ---- | -------- | ----------- |
| `shopDomain` | string | 是 | 您的 Shopify 商店域名 \(例如mystore.myshopify.com\) |
| `collectionId` | string | 是 | 集合 ID \(例如gid://shopify/Collection/123456789\) |
| `productsFirst` | number | 否 | 要从此集合返回的产品数量 \(默认50最大250\) |
#### 输出
| 参数 | 类型 | 描述 |
| --------- | ---- | ----------- |
| `collection` | object | 包括其产品的集合详情 |
## 注意
- 类别:`tools`
- 类型:`shopify`