Fix Customer.id JSDoc: clarify shop-scoping (2025-10)#4327
Fix Customer.id JSDoc: clarify shop-scoping (2025-10)#4327
Conversation
The previous description called customer.id "globally-unique," which misled multi-shop app developers into assuming they could key records on customer.id alone. The value is unique per shop. Ref: shop/issues-learn#1857 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
|
We detected some changes in |
Summary
Clarifies that
customer.idon the checkout UI extensionsCustomerinterface is unique per shop, not globally unique.Why
The previous JSDoc described
customer.idas "A globally-unique identifier for the customer," which misled developers building multi-shop apps to assume they could key records oncustomer.idalone.Change
In
packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts, updates the JSDoc forCustomer.id.Before
After
Context
Feedback from Simon Bolduc during a checkout UI extensions docs review. See shop/issues-learn#1857.
A companion shopify-dev PR updates the Best practices section of the Buyer Identity API docs to prescribe keying records on shop and
customer.idtogether for multi-shop apps.Sibling PRs cover the same change on the
2026-07-rc,2026-04, and2026-01branches.