Correct payment_failed_url docs to reflect the deployed fallback behavior

未关闭
#62 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
openapi
领域
api, documentation

调研方向

Start with the Campaign Cart API guide and campaigns/v1.yaml, checking the create-order example, payment-failure callout, decline-flow explanation, and generated reference. Confirm the event-source fallback semantics with the implementation owner, then reconcile the guide and schema while keeping payment_failed_url optional; done means all public descriptions match the verified fallback order.

由索引模型根据 Issue 内容生成。

描述

The Campaign Cart API guide says an omitted payment_failed_url is accepted only when the request includes HTTP Referer, and otherwise order creation fails. That describes superseded behavior. Engineering confirmed deployment of additional fallbacks on 2026-06-25; a read-only check of the current implementation on 2026-09-21 confirms the fallback resolver remains present.

Affected public surfaces:

  • Campaign Cart API guide: the create-order example comment, “Send a Payment Failure URL” callout, and decline-flow explanation.
  • Campaigns OpenAPI specification: CreateOrder.payment_failed_url has only a generic redirect description and does not explain fallback behavior.

Please reconcile the guide and schema with the current API behavior:

  • Keep explicitly sending a suitable failure URL as the recommended integration practice.
  • Remove the claim that omission of both the field and Referer necessarily rejects the order.
  • Document the verified fallback order: explicit payment_failed_url, then Referer, then the campaign page URL header / available event-source fallback, then the origin of success_url. Confirm the precise event-source semantics with the implementation owner rather than describing it loosely as the shopper’s last page view.
  • Keep the field optional in the OpenAPI schema; do not add the obsolete conditional requirement or make it unconditionally required.
  • Check the example, callouts, and generated reference agree.

This is a documentation correction request, not a request to change API behavior. Historical documentation work: #44. This issue intentionally contains no merchant records or internal implementation excerpts.

主要语言
MDX
星标
2
派生
0
平均合并
6 小时 4 分钟
30 天内合并 PR
13

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

NextCommerceCo/developer-docs 的其他 Issue

查看 NextCommerceCo/developer-docs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。