Update checkout UI extension API names (2025-07)#4065
Merged
Conversation
rennyG
changed the title
rennyG
added
the
#gsd:49303
rennyG
changed the title
rennyG
changed the title
rennyG
changed the title
rennyG
commented
Mar 11, 2026
Contributor
Author
There was a problem hiding this comment.
@jamesvidler added you as a reviewer because I needed to up this version to get dev up to pass. I assumed dev up would have handled the version bump, so let me know if I shouldn't include this and you'd prefer to handle differently.
sordaz00
approved these changes
Mar 11, 2026
jamesvidler
reviewed
Mar 11, 2026
Comment on lines
+15
to
+16
| category: 'Target APIs', | ||
| subCategory: 'Checkout APIs', |
Contributor
There was a problem hiding this comment.
I think changing these will mean that the URL paths will change in shopify-dev as well. Did you consider adding redirects for these?
Contributor
Author
There was a problem hiding this comment.
Yep, that's the next part of the work, right after this PR ships
jamesvidler
approved these changes
Mar 11, 2026
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
3 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.
Fixes https://github.com/Shopify/shopify-dev/issues/68993
Background
Fixes https://github.com/Shopify/shopify-dev/issues/68993
As part of the Shopify Dev Docs UI Extension Reference Docs Quality & Completeness GSD project, API names in ui-extensions need to match the naming convention approved for the IA.
Solution
Updates the
namefield in 26*.doc.tsfiles underpackages/ui-extensions/docs/surfaces/checkout/reference/apis/.The IA categorization follows the approved structure from: https://docs.google.com/document/d/1pkVbWRGUl6upl0PgvnwHd6LtS8TgQ_UbWG1p5HdRpII/edit?tab=t.0#heading=h.tv19o950t1oy
🎩
Checklist