From d2508b46b7332220c78d50b636cb580710c88118 Mon Sep 17 00:00:00 2001 From: Mert Kara Date: Tue, 28 Jul 2026 15:53:52 -0400 Subject: [PATCH] Remove shopUser from documented AppMetafieldEntryTarget types Shop User metafields were never released publicly and there is no intention to release them due to privacy concerns. The value was still present in the public AppMetafieldEntryTarget type union, so the generated API reference on shopify.dev documented it as a supported metafield target, leading partners to attempt using an unsupported capability (repeat incidents). This removes 'shopUser' from the type union and its JSDoc bullet so it no longer appears in the generated reference docs. Runtime behavior is unchanged. Resolves https://github.com/shop/issues-checkout/issues/145 Assisted-By: devx/55c486ec-5add-4a66-8725-1eb7879f69bf --- .changeset/remove-shopuser-metafield-docs.md | 5 +++++ .../src/surfaces/checkout/api/standard/standard.ts | 2 -- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .changeset/remove-shopuser-metafield-docs.md diff --git a/.changeset/remove-shopuser-metafield-docs.md b/.changeset/remove-shopuser-metafield-docs.md new file mode 100644 index 0000000000..c44126df8d --- /dev/null +++ b/.changeset/remove-shopuser-metafield-docs.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Remove `shopUser` from the documented `AppMetafieldEntryTarget` resource types for checkout UI extensions. Shop User metafields were never released publicly and are not a supported metafield target for partner extensions; keeping the value in the public API reference caused partners to attempt using an unsupported capability. diff --git a/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts b/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts index bf4875aefd..157f307a50 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts @@ -247,7 +247,6 @@ export interface AppMetafieldEntryTarget { * - `'customer'`: The customer who placed the order. * - `'product'`: A product in the merchant's catalog. * - `'shop'`: The merchant's shop. - * - `'shopUser'`: A staff member or collaborator account on the shop. * - `'variant'`: A specific variant of a product. * - `'company'`: A [B2B](https://shopify.dev/docs/apps/build/b2b) company associated with the order. * - `'companyLocation'`: A location belonging to a [B2B](https://shopify.dev/docs/apps/build/b2b) company. @@ -259,7 +258,6 @@ export interface AppMetafieldEntryTarget { | 'customer' | 'product' | 'shop' - | 'shopUser' | 'variant' | 'company' | 'companyLocation'