Skip to content

[Checkout UI Ext 2026-01] Checkout data API examples + descriptions#4207

Closed
SteveSill wants to merge 1 commit into2026-01from
2026-01-checkout-data-examples
Closed

[Checkout UI Ext 2026-01] Checkout data API examples + descriptions#4207
SteveSill wants to merge 1 commit into2026-01from
2026-01-checkout-data-examples

Conversation

@SteveSill
Copy link
Copy Markdown
Contributor

@SteveSill SteveSill commented Mar 26, 2026 •
edited
Loading

Backport of #4173 (targeting 2026-04-rc) to the 2026-01 version branch.

Summary

Adds 17 new Preact examples and 10 title updates for checkout data APIs. Cherry-picked from 2026-04-checkout-data-examples.

Closes part of https://github.com/shop/issues-learn/issues/1044

@SteveSill
[Checkout UI Ext] Checkout data API examples + descriptions
b0550f3 
Add 17 new Preact code examples for checkout data APIs that previously
had no examples or fewer than two.

New examples (2 per API):
- Addresses: read shipping address, read billing address
- Buyer Identity: display customer info, display B2B company
- Checkout Token: access token, display support reference
- Cost: order cost summary, free shipping progress
- Discounts: display codes, apply/remove codes
- Gift Cards: display applied cards, apply a card
- Note: display note, add/update note

Additional examples (1 each):
- Cart Lines, Customer Privacy, Order

Also updates 10 existing example titles to imperative verbs.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 26, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@SteveSill SteveSill self-assigned this Mar 26, 2026
@SteveSill SteveSill added Checkout UI Extensions #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness labels Mar 26, 2026
@SteveSill
Copy link
Copy Markdown
Contributor Author

SteveSill commented Mar 26, 2026

Closing: examples are now managed directly in the shopify-dev MDX repo after the migration to MDX. The ui-extensions .doc.ts example pipeline is no longer needed for these.

@SteveSill SteveSill closed this Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@SteveSill SteveSill

Labels

Checkout UI Extensions #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@SteveSill