Deprecate useBuyerJourneyIntercept and buyerJourney.intercept#4534
Open
gil-- wants to merge 2 commits into
Open
Deprecate useBuyerJourneyIntercept and buyerJourney.intercept#4534gil-- wants to merge 2 commits into
gil-- wants to merge 2 commits into
Conversation
jamesvidler
approved these changes
Jun 29, 2026
Mark the buyer journey intercept hook and the underlying intercept API as deprecated, mirroring the existing localization.market deprecation. Adds an @deprecated JSDoc tag (which drives the shopify.dev deprecation callout) and regenerates the checkout docs data (yarn docs:checkout 2026-07-rc), plus a changeset. Co-authored-by: River <shopify.river@shopify.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
gil--
force-pushed
the
deprecate-buyer-journey-intercept-2026-07-rc
branch
from
9139ace to
5465dca
Compare
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
2 participants
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.
What
Marks the buyer journey intercept hook and the underlying intercept API as deprecated, mirroring the existing
localization.marketdeprecation.@deprecatedJSDoc tag touseBuyerJourneyInterceptinpackages/ui-extensions/src/surfaces/checkout/preact/buyer-journey.tsbuyerJourney.interceptmethod on theBuyerJourneyinterface inpackages/ui-extensions/src/surfaces/checkout/api/standard/standard.tsyarn docs:checkout 2026-07-rc), which feeds the shopify.dev "Deprecated" calloutDeprecation message:
Why
The buyer journey intercept is being phased out in favor of cart and checkout validation functions. Surfacing the deprecation in the reference docs (and via the
@deprecatedTS tag in editors) guides developers to the supported approach ahead of removal.Notes
2026-07-rc, which carries the livemarketdeprecation.unstableis stale (lacks the preact hooks and themarketdeprecation), so this is the realistic target. Please confirm with the UI Extension Stewards which version branch(es) this should land on.yarn docs:checkout 2026-07-rcrather than hand-editing. The generator emits adeprecationMessagefor theinterceptmethod; it does not emit one at the top-level hook (UseBuyerJourneyInterceptGeneratedType) — noexport functiontype in the generated data carries adeprecationMessage— so the committed output reflects exactly what the generator produces. The@deprecatedtag on the hook source still drives editor/TS deprecation warnings.🤖 Generated with Claude Code
Co-authored-by: River shopify.river@shopify.com