摘要
VTEX 电子商务平台:订单(OMS)处理和跟踪、产品和 SKU 目录、店面搜索、价格、每个仓库的库存、码头和运输政策,以及主数据中的客户档案。应用密钥和应用令牌。
引导式设置
2 分钟将 VTEX 连接到 Microsoft Copilot
开始 AnythingMCP Cloud 免费试用,在引导式设置中连接 VTEX,再把你的 MCP URL 添加到 Microsoft Copilot。无需代码,也无需自行运行服务器。
无需信用卡 · 7 天试用 · 提供自托管方案
试试这样问
VTEX 的示例提示
点击任意提示即可复制,然后粘贴到 Claude、ChatGPT、Cursor、Gemini、Copilot 或 OpenClaw 中,在该连接器上运行。
Claude 是 AI,可能会出错。请核对回答。
💡 没有安装?直接使用 cloud.anythingmcp.com。 登录,点击 Connectors → VTEX,粘贴你的凭据,生成一个 MCP API 密钥,完成。无需 Docker,无需
git clone,无需本地服务器。
VTEX + Microsoft Copilot
VTEX 电子商务平台:订单(OMS)处理和跟踪、产品和 SKU 目录、店面搜索、价格、每个仓库的库存、码头和运输政策,以及主数据中的客户档案。应用密钥和应用令牌。
前提条件
请查看连接器中包含的完整设置说明(在选择连接器时在应用内商店中可见)。此连接器所需的环境变量为:
VTEX_ACCOUNT_NAME, VTEX_ENVIRONMENT, VTEX_APP_KEY, VTEX_APP_TOKEN
第一步 — 获取凭据
设置大约需要 5 分钟。
- 在 VTEX 管理员中打开 账户设置、账户、安全、API 密钥(旧版管理员:账户设置、账户管理、应用密钥),然后点击 生成密钥。给它起个名字。
- 在 角色(许可证管理器)中为密钥分配角色:对于读写操作,使用预定义角色 OMS - 完全访问、物流完全访问、目录、定价 和一个主数据角色,或者一个包含所需资源的自定义角色。只读密钥适用于读取工具。
- 将 应用密钥 复制到
VTEX_APP_KEY,将 应用令牌 复制到VTEX_APP_TOKEN(令牌仅显示一次)。 - 在
VTEX_ACCOUNT_NAME中输入 账户名称(https://<account>.myvtex.com的第一部分),并保持环境为vtexcommercestable。
连接器在每次调用时通过 X-VTEX-API-AppKey 和 X-VTEX-API-AppToken 发送密钥和令牌。
从哪里开始:vtex_list_orders(使用 f_status 过滤,例如 ready-for-handling),然后使用 vtex_get_order 获取项目、地址和付款。对于产品,从 vtex_search_products 或 vtex_get_sku_by_ref_id 开始,然后使用 vtex_get_sku、vtex_get_price 和 vtex_get_sku_inventory。
订单:vtex_list_orders(列表中没有项目;最多 30 页,每页最多 100 条,仅限最近两年),vtex_get_order、vtex_get_order_group、vtex_get_order_conversation、vtex_get_payment_transaction。使用 vtex_start_handling_order 移动已付款订单,使用 vtex_add_order_interaction 记录备注,并使用 vtex_update_tracking_status 发送交付事件。三个工具安装时关闭:vtex_cancel_order(无法撤销,退款已付款订单)、vtex_invoice_order(开票使 VTEX 捕获付款并冻结订单)和 vtex_update_invoice_tracking(更改发票)。订单中的货币值为以分为单位的整数(totalValue 12990 为 129.90)。
目录:vtex_list_product_and_sku_ids、vtex_get_product、vtex_get_product_by_ref_id、vtex_list_product_skus、vtex_get_sku、vtex_get_sku_by_ref_id、vtex_get_sku_by_ean、vtex_search_products(店面搜索,带实时价格和可用数量)、vtex_get_category_tree、vtex_list_brands。产品和 SKU ID 是数字;RefId 是商家的自定义代码。
价格:vtex_get_price、vtex_get_computed_price、vtex_list_price_tables、vtex_update_price。定价值为小数(49.9),与订单值不同。
库存和物流:vtex_get_sku_inventory、vtex_update_sku_inventory(设置一个仓库的总量)、vtex_list_warehouses、vtex_list_docks、vtex_list_shipping_policies。
客户(主数据 v1):vtex_search_customers、vtex_get_customer、vtex_update_customer,以及 vtex_search_documents 用于任何实体(AD 保存地址,通过 userId 与 CL ID 关联)。搜索每次最多返回 100 行,使用 range_start 和 range_end 选择;仅请求所需字段,因为没有字段权限的密钥在使用 _all 时会返回 403。
限制和陷阱:VTEX 每个账户每分钟允许约 6000 次订单读取,当 API 超载时返回 429。过滤器中的日期为 UTC。403 表示密钥的角色缺少调用所需的资源;对于两年以上的订单,404 是预期的。
第二步 — 安装适配器
curl -fsSL https://raw.githubusercontent.com/HelpCode-ai/anythingmcp/main/docker-compose.quickstart.yml -o docker-compose.yml
printf 'JWT_SECRET=%s\nENCRYPTION_KEY=%s\n' "$(openssl rand -hex 32)" "$(openssl rand -hex 32)" > .env
docker compose up -d
第三步 — 在 Microsoft Copilot 中添加连接器
你的服务器 URL: 在 AnythingMCP 中打开 MCP Servers → 此连接器所在的服务器,复制它的 URL(
https://cloud.anythingmcp.com/mcp/…)。本指南中出现YOUR_SERVER_ID的地方都用它替换。
Microsoft Copilot 通过在 Copilot Studio 中构建的智能体使用 MCP 服务器:把 AnythingMCP 作为工具添加到智能体,然后把智能体发布到 Microsoft 365 Copilot 和 Teams。Copilot Studio 从 Microsoft 的云端通过 Streamable HTTP 连接,AnythingMCP 支持这种方式。
- 在 Copilot Studio 中打开你的智能体(或新建一个),进入 Tools,选择 Add a tool → New tool → Model Context Protocol。
- 填写 Server name(例如
AnythingMCP)、说明连接器用途的 Server description,以及 Server URLhttps://cloud.anythingmcp.com/mcp/YOUR_SERVER_ID。Copilot Studio 根据描述决定何时调用该服务器。 - 身份验证选择 API key,把 Type 设为 Header,请求头名称填
X-API-Key,然后选择 Create。 - 在 Add tool 中选择 Create a new connection,粘贴 AnythingMCP 的 MCP API 密钥(MCP Servers → 你的服务器 → API keys),然后选择 Add to agent。
- 在智能体的 Test 窗格中试一试:提出需要用到
VTEX的工具的请求。 - 选择 Publish,然后进入 Channels → Microsoft 365 and Microsoft Teams,保持勾选 Make agent available in Microsoft Copilot,再选择 Add channel。See agent in Teams 会为你安装该智能体;在 Microsoft 365 Copilot 中输入 @ 并选择该智能体。
希望每个用户各自登录?请选择 OAuth 2.0 → Dynamic discovery 代替 API 密钥:每个用户会在智能体首次调用时登录 AnythingMCP。
自托管?请用你实例的公网 HTTPS 地址替换 https://cloud.anythingmcp.com。Copilot Studio 从 Microsoft 的云端连接,因此 localhost 无法使用。
可用工具
| 工具 | 功能 |
|---|---|
vtex_list_orders | 列出最近两年的订单,默认按最新排序:orderId、creationDate、clientName、以分为单位的 totalValue、状态等… |
vtex_get_order | 读取一个订单:状态、以分为单位的值和总额、项目(SKU ID、refId、名称、数量、价格、销售价格)、clientProfileData… |
vtex_get_order_group | 读取一个结账的所有订单(一个订单组拆分为每个卖家的一个订单):每个订单的字段与 vtex_get_order 相同 |
vtex_start_handling_order | 将订单从准备处理状态移动到处理状态,告诉 VTEX 卖家已开始准备。VTEX 返回 204,无正文… |
vtex_add_order_interaction | 在订单的交互日志中写入一行(在管理员的订单历史中显示),例如来自仓库的备注。不会更改… |
vtex_get_order_conversation | 读取订单的电子邮件对话:VTEX 和商店发送给客户的消息(主题、发件人、收件人、日期、正文) |
vtex_get_payment_transaction | 读取订单的支付交易:交易 ID、状态、支付方式、以分为单位的值、分期付款和事件历史… |
vtex_update_tracking_status | 向已经有跟踪号码的发票发送跟踪事件(isDelivered、deliveredDate 和带有城市、州的事件列表… |
vtex_cancel_order | 取消尚未开票的订单,并给出理由。无法撤销;已付款订单由 VTEX 退款。安装时关闭 |
vtex_invoice_order | 发送订单的发票(类型为销售的输出),将其移动到已开票状态并使 VTEX 结算(捕获)付款。invoiceValue… |
vtex_update_invoice_tracking | 向现有订单的发票添加跟踪号码、跟踪链接、承运人和发货日期。更改发票;安装时关闭… |
vtex_list_product_and_sku_ids | 列出产品 ID 及其 SKU ID,按类别可选:数据将每个 productId 映射到其 SKU ID,range.total 给出总数。页面… |
vtex_get_product | 读取一个产品:Id、名称、DepartmentId、CategoryId、BrandId、LinkId(URL slug)、RefId、IsVisible、IsActive、描述、标题… |
vtex_get_product_by_ref_id | 通过其参考代码(RefId)查找产品,并读取与 vtex_get_product 相同的字段 |
vtex_list_product_skus | 列出一个产品的 SKU:Id、ProductId、IsActive、名称、RefId、与 EAN 相关的字段、尺寸、重量和计量单位 |
vtex_get_sku | 读取一个 SKU 及其上下文:Id、ProductId、NameComplete、ProductName、SkuName、AlternateIds(EAN、RefId)、图像、尺寸、卖家… |
vtex_get_sku_by_ref_id | 通过其参考代码(RefId)查找 SKU:Id、ProductId、IsActive、名称、RefId、尺寸和重量 |
vtex_get_sku_by_ean | 通过其 EAN 条形码查找 SKU,并读取与 vtex_get_sku 相同的字段 |
vtex_search_products | 像店面一样搜索已发布的目录:productId、productName、品牌、链接、类别和带有卖家的项目(SKU)… |
vtex_get_category_tree | 读取类别树,直到给定深度:id、名称、hasChildren、url 和每个类别的子类别 |
vtex_list_brands | 列出所有品牌:id、名称、isActive、标题、metaTagDescription 和 imageUrl |
vtex_get_price | 从定价 API 读取 SKU 的价格:itemId、listPrice、costPrice、markup、basePrice 和每个贸易政策的 fixedPrices… |
vtex_get_computed_price | 读取价格表(贸易政策)实际对 SKU 收取的价格,遵循定价规则:tradePolicyId、listPrice、costPrice… |
vtex_list_price_tables | 列出账户的价格表 ID(例如 1 代表主要贸易政策,或名称如 gold) |
vtex_update_price | 创建或更新 SKU 的基础价格:单独给出 base_price(则 markup 和 cost 会被推导),或给出带有百分比的 cost_price 和 markup… |
vtex_get_sku_inventory | 读取每个仓库中 SKU 的库存:warehouseId、warehouseName、totalQuantity、reservedQuantity、hasUnlimitedQuantity、timeToRefill… |
vtex_update_sku_inventory | 设置一个仓库中 SKU 的库存:数量替换总数量(保留预留数量);unlimited_quantity 为 true 保持… |
vtex_list_warehouses | 列出仓库:id、名称、warehouseDocks(带时间和成本的码头 ID)和 isActive |
vtex_list_docks | 列出装卸码头:id、名称、优先级、dockTimeFake、销售渠道、freightTableIds 和提货商店信息 |
vtex_list_shipping_policies | 列出运输政策(承运人和运费表):id、名称、shippingMethod、isActive、deliveryOnWeekends、maxDimension 和 business… |
vtex_search_customers | 搜索客户档案(主数据实体 CL):电子邮件、名、姓、文件、电话、是否为企业、企业名称、创建时间和… |
vtex_get_customer | 通过文件 ID 读取一个客户档案(实体 CL):字段名称在 fields 中 |
vtex_update_customer | 更改客户档案(实体 CL)的字段;仅更改给定的字段,例如电话或 isNewsletterOptIn |
vtex_search_documents | 通过其两个字母的缩写搜索任何主数据 v1 实体,例如 AD 代表客户地址(按 userId 过滤),或自定义实体:… |
示例提示
- "当前哪些 VTEX 订单准备处理?"
- "显示订单 1478920512345-01 及其项目、地址和付款。"
- "SKU ref TSHIRT-BLK-M 的价格和每个仓库的库存是多少?"
- "将 SKU 2001 在仓库 1_1 的库存设置为 80。"
- "哪些运输政策和码头是活动的?"
常见问题
应用密钥和令牌来自哪里? 在 VTEX 管理员的账户设置、账户、安全、API 密钥下:生成一个密钥,分配角色如 OMS、物流、目录和定价,并复制应用密钥和应用令牌(仅显示一次)。
它涵盖了什么? 订单(OMS)处理、交互和跟踪、产品和 SKU 目录、店面搜索、价格和价格表、每个仓库的库存、码头和运输政策,以及主数据中的客户档案。
哪些工具安装时关闭? vtex_cancel_order、vtex_invoice_order 和 vtex_update_invoice_tracking,因为它们会为客户取消或开票订单。仅在 AI 应该使用它们时在连接器页面上打开它们。
这适用于哪个 Copilot? 适用于工作中的 Microsoft 365 Copilot,通过 Copilot Studio 的智能体实现。面向个人账户的 Microsoft Copilot 应用无法添加自己的 MCP 服务器。
我需要什么? 一个可以使用 Copilot Studio 的工作账户(许可证或试用版),用于构建智能体。在 Microsoft 365 Copilot 或 Teams 中使用它的人需要拥有该智能体的访问权限:把它共享给他们,或请管理员为整个组织发布。如果你的组织对 Power Platform 连接器设置了数据策略,这些策略同样适用于 MCP 服务器。
智能体不调用工具。 检查请求头名称是否正好是 X-API-Key,密钥是否属于与 URL 相同的 MCP 服务器,并把 Server description 写得具体:Copilot Studio 根据它决定何时调用服务器。每次修改后重新发布智能体;在已打开的对话中输入 "start over" 即可使用新版本。
下一步
这份指南对你有帮助吗?