我们 不鼓励 使用 OrderTransaction.receiptJson。您应停止在生产应用中依赖 receipt Json。 receiptJson 在生产应用中。
receiptJson是由网关定义的、形状不一致的,且可能在未经通知的情况下发生变化。由于其结构不稳定且未进行类型定义,这些变化可能导致应用出现意外故障。
变更内容
- OrderTransaction.receiptJson应被视为不稳定的、特定于网关的数据。
- 该字段仍然可用,但Shopify不保证其内容具有一致的架构或长期兼容性。
- receiptJson内部形状或键的变化可能会发生,且不被视为破坏性API变更。
变更原因
receiptJson 不是一个可靠的集成接口:
- 不同的支付网关对其格式化处理方式不同。
- 同一网关在不同版本或配置下可能会更改其结构。
- 解析该数据的意外中断会影响商户。
我们希望减少因将receiptJson视为稳定契约而引发的生产事故。
您需要采取的措施
我们建议尽快移除对receiptJson的依赖:
- 不要新增对receiptJson的依赖。
- 迁移现有逻辑至OrderTransaction及相关对象上稳定且已定义类型的字段(如可行)。
- 如果您需要获取作为类型化字段不可用的特定提供商详情,请直接从支付提供商处获取(如适用),并仅存储您的系统所需的最小数据量。
文档
- OrderTransaction 对象:https://shopify.dev/api/admin-graphql/latest/objects/OrderTransaction https://shopify.dev/api/admin-graphql/latest/objects/OrderTransaction
- API 版本控制与兼容性:https://shopify.dev/docs/api/usage/versioning https://shopify.dev/docs/api/usage/versioning

