shippo

Shippo

Shippo 是一个物流平台，可帮助企业管理并自动化物流流程。它提供比较运费、打印标签以及跨不同承运商跟踪包裹的工具。电商企业和其他经常寄送商品的公司会使用 Shippo 来简化物流运营。

官方文档：https://goshippo.com/docs/

Shippo 概览

• 地址
  • 创建地址
  • 获取地址
• 批次
  • 创建批次
  • 获取批次
  • 添加批次货件
  • 获取批次货件
  • 获取批次货件列表
  • 购买批次
• 海关物品
  • 创建海关物品
  • 获取海关物品
• 海关申报
  • 创建海关申报
  • 获取海关申报
• 清单
  • 创建清单
  • 获取清单
• 订单
  • 创建订单
  • 获取订单
• 包裹
  • 创建包裹
  • 获取包裹
• 运费
  • 获取运费
• 退款
  • 获取退款
• 货件
  • 创建货件
  • 获取货件
  • 获取货件标签
  • 获取货件跟踪信息
• 交易
  • 获取交易

根据需要使用操作名称和参数。

使用 Shippo

此技能使用 Membrane CLI 与 Shippo 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不必操心身份验证配置。

安装 CLI

安装 Membrane CLI，以便在终端中运行 membrane：

npm install -g @membranehq/cli@latest

身份验证

membrane login --tenant --clientName=<agentType>

根据是否支持交互模式，这会打开浏览器进行身份验证，或在控制台中打印授权 URL。

无头环境： 命令会打印授权 URL。请让用户在浏览器中打开该 URL。用户完成登录并看到验证码后，运行以下命令完成操作：

membrane login complete <code>

在任意命令后添加 --json，即可输出机器可读的 JSON。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。这些类型将用于调整工具，使其更好地适配你的运行环境。

连接到 Shippo

使用 membrane connection ensure 按应用 URL 或域名查找或创建连接：

membrane connection ensure "https://goshippo.com/" --json

用户在浏览器中完成身份验证。输出中包含新的连接 ID。

这是创建连接最快的方式。URL 会被规范化为域名，并与已知应用进行匹配。如果找不到应用，系统会自动创建应用并构建连接器。

如果返回的连接具有 state: "READY"，请跳到步骤 2。

1b. 等待连接就绪

如果连接处于 BUILDING 状态，请持续轮询，直到连接就绪：

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询，最多等待 --timeout 秒（默认值为 30），直到状态发生变化。持续轮询，直到 state 不再是 BUILDING。

结果状态决定了接下来要执行的操作：

• READY — 连接已完全设置完成。跳到步骤 2。

• CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象会说明所需的操作：

  • clientAction.type — 所需操作的类型：
    • "connect" — 用户需要进行身份验证（OAuth、API 密钥等）。这包括初次身份验证，以及已断开连接时重新进行身份验证。
    • "provide-input" — 需要提供更多信息（例如要连接的应用）。
  • clientAction.description — 对所需操作的易读说明。
  • clientAction.uiUrl（可选）— 用户可以通过此预构建 UI 完成操作。存在该字段时，请向用户展示此 URL。
  • clientAction.agentInstructions（可选）— 关于如何以编程方式继续操作的 AI Agent 说明。

  用户完成操作后（例如在浏览器中完成身份验证），再次运行 membrane connection get <id> --json 进行轮询，检查状态是否已变为 READY。

• CONFIGURATION_ERROR 或 SETUP_FAILED — 出现问题。请查看 error 字段了解详情。

搜索操作

使用自然语言描述你想执行的操作来搜索：

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

搜索操作时，始终应指定一个具体连接的上下文。

每个结果都包含 id、name、description、inputSchema（操作接受的参数）和 outputSchema（操作返回的内容）。

常用操作

使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 发现可用操作。

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

要传入 JSON 参数：

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

如果可用操作无法满足你的用例，可以通过 Membrane 的代理直接向 Shippo API 发送请求。Membrane 会自动将基础 URL 附加到你提供的路径，并注入正确的身份验证标头；如果凭据过期，还会透明地刷新凭据。

membrane request CONNECTION_ID /path/to/endpoint

常用选项：

标志	描述
-X, --method	HTTP 方法（GET、POST、PUT、PATCH、DELETE）。默认为 GET
-H, --header	添加请求标头（可重复），例如 -H "Accept: application/json"
-d, --data	请求正文（字符串）
--json	发送 JSON 正文并设置 Content-Type: application/json 的简写
--rawData	原样发送正文，不做任何处理
--query	查询字符串参数（可重复），例如 --query "limit=10"
--pathParam	路径参数（可重复），例如 --pathParam "id=123"

最佳实践

• 始终优先使用 Membrane 与外部应用通信 — Membrane 提供预构建操作，内置身份验证、分页和错误处理。这样可以减少令牌消耗，并让通信更加安全。
• 先发现，再构建 — 在编写自定义 API 调用前，运行 membrane action list --intent=QUERY（将 QUERY 替换为你的意图），查找现有操作。预构建操作可以处理分页、字段映射和原始 API 调用容易遗漏的边缘情况。
• 让 Membrane 管理凭据 — 切勿向用户索要 API 密钥或令牌。改为创建连接；Membrane 会在服务端管理完整的身份验证生命周期，无需在本地保存密钥。