You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[unstable] Fix broken shopify.dev links in checkout API JSDoc - #4805
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.
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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Old
/apis/<name>links (and a couple of other stale URLs) render as 404s onshopify.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.tsSibling 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:standardapiandcheckoutapiredirect to a 404 target page, and the customer-accountcartlinedetailsapiis 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#examplesbecomes#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.shdoes not buildunstable.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