Skip to content

Remove shopUser from documented AppMetafieldEntryTarget types #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
amertkara wants to merge 1 commit into from
Closed

Remove shopUser from documented AppMetafieldEntryTarget types #4601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-shopuser-metafield-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 0 additions & 2 deletions packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -259,7 +258,6 @@ export interface AppMetafieldEntryTarget {
| 'customer'
| 'product'
| 'shop'
| 'shopUser'
| 'variant'
| 'company'
| 'companyLocation'
Expand Down
Loading