RevGlance文档

Shopify

通过 Dev Dashboard 应用连接 Shopify 商店,读取订单、退款、手续费和订阅合约。

RevGlance 通过 Shopify 的 GraphQL Admin API 读取您的商店。它使用您应用的客户端 ID 和密钥登录(client credentials grant),这只适用于与该应用属于同一组织的商店。

连接

  1. 在 Shopify Dev Dashboard 中,在与您的商店相同的组织内创建一个应用。
  2. 为其授予 read_orders、read_all_orders、read_own_subscription_contracts 和 read_customers 权限范围,发布一个版本,并将应用安装到您的商店。
  3. 在应用的 Settings 中,复制 Client ID 和 Client secret(以 shpss_ 开头)。
  4. 填写您商店的 .myshopify.com 地址和这两个值,然后选择 连接 Shopify。

表单需要填写的内容

字段格式示例
商店acme.myshopify.com
客户端 ID1a2b3c4d5e6f…
客户端密钥加密存储shpss_…

添加 webhook

Shopify 使用应用的客户端密钥为其 webhook 签名,而数据源已持有该密钥,因此无需粘贴密钥。

  1. 在 RevGlance 中,打开 设置 › 来源,打开 Shopify 数据源的菜单并选择 Webhook。复制 URL。
  2. 在您应用的配置中,以该 URL 作为端点订阅订单、退款和订阅合约主题,然后发布该更改。

RevGlance 同步哪些数据

  • 已付款订单,按税前金额、以商店币种计算,并包含 Shopify Payments 的手续费。测试订单不计入。read_all_orders 权限范围可让首次同步回溯到超过 Shopify 默认的 60 天。
  • 退款,按与订单相同的比例扣除税费。
  • 来自 Shopify Subscriptions 及基于它构建的应用的 订阅合约,用于计算 MRR。由销售方案创建的订单计为定期收入。

Shopify 不提供取消日期或原因,因此已取消的合约以其最后一次变更的时间作为结束时间。

Shopify 的计算方式

  • 已付款订单按税前计入,以商店货币计,Shopify Payments 的费用计为手续费。测试订单不予计入。
  • 退款含税,因此 RevGlance 会按订单上的相同比例扣除税费。
  • MRR 来自订阅合约(Shopify Subscriptions 及基于它构建的应用),扣除折扣后计算。由销售计划创建的订单计为经常性收入。
  • Shopify 不提供取消日期或原因:已取消、已过期、失败或已暂停的合约以其最后变更的日期结束。
  • 部分付款的订单按目前已收到的金额计入。
  • 价格含税时,MRR 按首笔订单上的税费比例,以税前金额计算。
  • 订阅合约不含试用日期,因此不显示试用。
  • 不读取拒付,因此输掉的拒付仍计为扣款,除非服务商也将其报告为退款。
  • 失败的扣款不会被报告,因此该数字始终为零。