Skip to content

[unstable] Fix broken shopify.dev links in checkout API JSDoc - #4805

Closed
laurelthorburn wants to merge 1 commit into
unstablefrom
unstable-fix-checkout-api-links
Closed

laurelthorburn wants to merge 1 commit into
unstablefrom
unstable-fix-checkout-api-links

Conversation

@laurelthorburn

@laurelthorburn laurelthorburn commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Old /apis/<name> links (and a couple of other stale URLs) render as 404s on
shopify.dev's checkout UI extensions reference. This repoints them to the current
/target-apis/... URLs. Link targets only, no prose or type changes.

Target branch: unstable (this PR only) Links fixed: 50 Files: ui-extensions-react/src/surfaces/checkout/hooks/api.ts, ui-extensions-react/src/surfaces/customer-account/hooks/api.ts, ui-extensions-react/src/surfaces/point-of-sale/hooks/api.ts, ui-extensions/docs/surfaces/checkout/staticPages/configuration.doc.ts, ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts, ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts, ui-extensions/src/surfaces/checkout/api/standard/standard.ts, ui-extensions/src/surfaces/checkout/components/shared.ts, ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts
Sibling PRs for the other versions: #4797 (2026-10), #4798 (2027-01-rc), #4799 (2026-07), #4800 (2026-04), #4801 (2026-01), #4802 (2025-10), #4803 (2025-07), #4804 (2026-10-rc)
Unresolved: apis/cartlinedetailsapi (2), apis/checkoutapi#properties-propertydetail-applymetafieldchange (1), apis/standardapi#example-settings (2), apis/standardapi#properties-propertydetail-applydiscountcodechange (1), apis/standardapi#properties-propertydetail-appmetafields (1), apis/standardapi#properties-propertydetail-availablepaymentoptions (1), apis/standardapi#properties-propertydetail-buyerjourney (2), apis/standardapi#properties-propertydetail-extension (2), apis/standardapi#properties-propertydetail-i18n (1), apis/standardapi#properties-propertydetail-localization (1). There is no matching page or anchor on shopify.dev: standardapi and checkoutapi redirect to a 404 target page, and the customer-account cartlinedetailsapi is for an order-status target, so the checkout order-summary page is wrong for it. I left these unchanged.

Anchors are rewritten to the new #docsstandard<api>api-propertydetail-<prop> ids, and #examples becomes #use-cases. This branch has no {API_VERSION} placeholder, so links stay versionless (they resolve to /latest/). I checked each new URL on shopify.dev: every page loads, and every fragment exists as an element id on that version's page.

No generated docs are tracked on this branch, and build-docs.sh does not build unstable.

Context: shopify.dev link audit for the checkout and customer account UI extensions
references. The shop/world side (MDX links and redirects) is handled in a separate
shopify-dev PR.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

📝 POS Version Documentation Reminder

We detected changes in packages/*/src/surfaces/point-of-sale, but there are no updates to the POS versions documentation.

If these changes are user-facing and should be documented in the version changelog, please update:
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts

If you are making internal changes that don't affect the public API, you can ignore this reminder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant