Remove shopUser from documented AppMetafieldEntryTarget types - #4601
Closed
amertkara wants to merge 1 commit into
Closed
Remove shopUser from documented AppMetafieldEntryTarget types#4601amertkara wants to merge 1 commit into
amertkara wants to merge 1 commit into
Conversation
Shop User metafields were never released publicly and there is no intention to release them due to privacy concerns. The value was still present in the public AppMetafieldEntryTarget type union, so the generated API reference on shopify.dev documented it as a supported metafield target, leading partners to attempt using an unsupported capability (repeat incidents). This removes 'shopUser' from the type union and its JSDoc bullet so it no longer appears in the generated reference docs. Runtime behavior is unchanged. Resolves shop/issues-checkout#145 Assisted-By: devx/55c486ec-5add-4a66-8725-1eb7879f69bf
amertkara
marked this pull request as ready for review
July 28, 2026 19:55
amertkara
marked this pull request as draft
July 28, 2026 19:55
Author
|
Closing in favor of fixing this at the source: the checkout-web copy in shop/world is the source of truth for these docs (per https://github.com/shop/issues-checkout/issues/145). The change will land in this repo through the usual ui-extensions docs sync. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Resolves https://github.com/shop/issues-checkout/issues/145
Summary
'shopUser'from theAppMetafieldEntryTarget.typeunion in the checkout surfacestandard.ts, and drops its JSDoc bullet./docs/api/checkout-ui-extensions/2025-07/apis/metafields), which led partners to attempt using an unsupported capability and caused repeat incidents (see issue).configuration#metafields) was already cleaned up separately; this PR covers the remaining generated API reference.Tophat
shopUserreferences in the checkout surface:grep -rn \"shopUser\" packages/ui-extensions/src→ no results.shopUserno longer appears in theAppMetafieldEntryTargettype values.