Skip to content

[Customer account UI extensions 2026-04-rc]: Account APIs and Order APIs descriptions and examples#4195

Merged
mcvinci merged 3 commits into2026-04-rcfrom
customer-accounts-order-apis-descriptions-2026-04-rc
Mar 24, 2026
Merged

[Customer account UI extensions 2026-04-rc]: Account APIs and Order APIs descriptions and examples#4195
mcvinci merged 3 commits into2026-04-rcfrom
customer-accounts-order-apis-descriptions-2026-04-rc

Conversation

@mcvinci
Copy link
Copy Markdown
Contributor

@mcvinci mcvinci commented Mar 22, 2026 •
edited
Loading

This PR:

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 22, 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! 🙏

@mcvinci mcvinci force-pushed the customer-accounts-order-apis-descriptions-2026-04-rc branch from aba9e35 to e6515de Compare March 22, 2026 01:40
@mcvinci mcvinci self-assigned this Mar 22, 2026
@mcvinci mcvinci added #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness Target APIs Customer account UI extensions labels Mar 22, 2026
@mcvinci mcvinci marked this pull request as ready for review March 22, 2026 01:46
@mcvinci mcvinci requested a review from sordaz00 March 22, 2026 01:46
@mcvinci mcvinci force-pushed the customer-accounts-order-apis-descriptions-2026-04-rc branch 3 times, most recently from 162cb5e to e6ecb01 Compare March 23, 2026 19:36
@mcvinci
Account and Order APIs: description improvements and examples for 202…
3d37b81 
…6-04-rc

Improve property descriptions, add best practices and limitations, create
code examples for all 18 Account and Order APIs, and generate documentation
for the 2026-04-rc version of Customer Account UI extensions.

Made-with: Cursor
@mcvinci mcvinci force-pushed the customer-accounts-order-apis-descriptions-2026-04-rc branch from e6ecb01 to 3d37b81 Compare March 24, 2026 00:03
@mcvinci mcvinci merged commit 8fb307c into 2026-04-rc Mar 24, 2026
7 checks passed
@sordaz00 sordaz00 mentioned this pull request Mar 24, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sordaz00 sordaz00 sordaz00 approved these changes

Assignees

@mcvinci mcvinci

Labels

Customer account UI extensions #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness Target APIs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mcvinci @sordaz00