@shopify/ui-extensions 2026.4.0-rc.2 → 2026.4.0

package/src/surfaces/admin/api/discount-function-settings/launch-options.ts

@@ -5,8 +5,9 @@ import type {
 
 /**
  * A [metafield](/docs/apps/build/metafields) that stores discount function configuration data. Use metafields to persist settings that control how your discount function behaves, such as discount thresholds, eligibility rules, or custom discount logic parameters.
+ * @publicDocs
  */
-interface Metafield {
+export interface Metafield {
   /** A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers. */
   description?: string;
   /** The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates. */
@@ -23,16 +24,19 @@ interface Metafield {
 
 /**
  * The discount class that determines where the discount applies in the purchase flow. Use this to understand what type of discount the merchant is configuring (product-level, order-level, or shipping).
+ * @publicDocs
  */
 export type DiscountClass = 'product' | 'order' | 'shipping';
 
 /**
  * The method used to apply a discount. Use `'automatic'` for discounts that apply automatically at checkout, or `'code'` for discounts that require a code entered by the customer.
+ * @publicDocs
  */
-type DiscountMethod = 'automatic' | 'code';
+export type DiscountMethod = 'automatic' | 'code';
 
 /**
  * The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.
+ * @publicDocs
  */
 export interface DiscountFunctionSettingsData {
   /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */
@@ -43,6 +47,7 @@ export interface DiscountFunctionSettingsData {
 
 /**
  * The `DiscountsApi` object provides reactive access to discount configuration. Use the signals to read discount classes and method, and the update function to change which parts of the purchase (products, order, or shipping) the discount affects.
+ * @publicDocs
  */
 export interface DiscountsApi {
   /**

package/src/surfaces/admin/api/discount-function-settings/metafields.ts

@@ -2,8 +2,9 @@ import {SupportedDefinitionType} from '../shared';
 
 /**
  * A metafield update or creation operation. Use this to set or modify metafield values that store discount function configuration data.
+ * @publicDocs
  */
-interface MetafieldUpdateChange {
+export interface MetafieldUpdateChange {
   /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */
   type: 'updateMetafield';
   /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */
@@ -18,8 +19,9 @@ interface MetafieldUpdateChange {
 
 /**
  * A metafield removal operation. Use this to delete metafields that are no longer needed for your discount configuration.
+ * @publicDocs
  */
-interface MetafieldRemoveChange {
+export interface MetafieldRemoveChange {
   /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */
   type: 'removeMetafield';
   /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */
@@ -30,13 +32,15 @@ interface MetafieldRemoveChange {
 
 /**
  * A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify discount settings stored in metafields.
+ * @publicDocs
  */
-type MetafieldChange = MetafieldUpdateChange | MetafieldRemoveChange;
+export type MetafieldChange = MetafieldUpdateChange | MetafieldRemoveChange;
 
 /**
  * A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.
+ * @publicDocs
  */
-interface MetafieldChangeResultError {
+export interface MetafieldChangeResultError {
   /** Indicates the operation failed. Check this value to determine if you need to handle an error. */
   type: 'error';
   /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */
@@ -45,21 +49,24 @@ interface MetafieldChangeResultError {
 
 /**
  * A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.
+ * @publicDocs
  */
-interface MetafieldChangeSuccess {
+export interface MetafieldChangeSuccess {
   /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */
   type: 'success';
 }
 
 /**
  * The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.
+ * @publicDocs
  */
-type MetafieldChangeResult =
+export type MetafieldChangeResult =
   | MetafieldChangeSuccess
   | MetafieldChangeResultError;
 
 /**
  * A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.
+ * @publicDocs
  */
 export type ApplyMetafieldChange = (
   change: MetafieldChange,

package/src/surfaces/admin/api/intents/intent-render.ts

@@ -0,0 +1,26 @@
+import type {StandardRenderingExtensionApi} from '../standard/standard-rendering';
+import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
+import type {IntentResponseApi} from './intents';
+
+/**
+ * The intents API available to intent render extensions. Unlike other targets where `response` is optional, intent render extensions always run inside an intent workflow so `response` is guaranteed.
+ * @publicDocs
+ */
+export interface IntentRenderIntents {
+  /**
+   * Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled.
+   */
+  response: IntentResponseApi;
+}
+
+/**
+ * The `IntentRenderApi` object provides methods for extensions that render in response to an app intent. Access the intent data to determine what action the merchant requested and use `intents.response` to resolve the intent when complete.
+ * @publicDocs
+ */
+export interface IntentRenderApi<ExtensionTarget extends AnyExtensionTarget>
+  extends StandardRenderingExtensionApi<ExtensionTarget> {
+  /**
+   * Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow.
+   */
+  intents: IntentRenderIntents;
+}

package/src/surfaces/admin/api/intents/intents.ts

@@ -1,5 +1,6 @@
 /**
  * The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.
+ * @publicDocs
  */
 export interface ClosedIntentResponse {
   /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */
@@ -8,6 +9,7 @@ export interface ClosedIntentResponse {
 
 /**
  * The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.
+ * @publicDocs
  */
 export interface SuccessIntentResponse {
   /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */
@@ -18,6 +20,7 @@ export interface SuccessIntentResponse {
 
 /**
  * The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.
+ * @publicDocs
  */
 export interface ErrorIntentResponse {
   /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */
@@ -25,18 +28,24 @@ export interface ErrorIntentResponse {
   /** A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available. */
   message?: string;
   /** Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages. */
-  issues?: {
-    /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */
-    path?: string[];
-    /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */
-    message?: string;
-    /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */
-    code?: string;
-  }[];
+  issues?: Issue[];
+}
+
+/**
+ * A structured issue describing a validation or workflow error.
+ */
+export interface Issue {
+  /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */
+  path?: string[];
+  /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */
+  message?: string;
+  /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */
+  code?: string;
 }
 
 /**
  * The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.
+ * @publicDocs
  */
 export type IntentResponse =
   | SuccessIntentResponse
@@ -45,6 +54,7 @@ export type IntentResponse =
 
 /**
  * A handle for tracking an in-progress intent workflow.
+ * @publicDocs
  */
 export interface IntentActivity {
   /**
@@ -53,13 +63,35 @@ export interface IntentActivity {
   complete?: Promise<IntentResponse>;
 }
 
+/**
+ * The `IntentResponseApi` object provides methods for resolving the current intent from within an invoked extension. This API is only present when your extension is running inside an intent workflow.
+ */
+export interface IntentResponseApi {
+  /**
+   * Resolves the current intent successfully. Pass output data when your intent defines a response schema.
+   */
+  ok(data?: SuccessIntentResponse['data']): Promise<void>;
+
+  /**
+   * Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available.
+   */
+  error(message: string, issues?: Issue[]): Promise<void>;
+
+  /**
+   * Resolves the current intent as closed without completing the workflow.
+   */
+  closed(): Promise<void>;
+}
+
 /**
  * The type of operation to perform: creating a new resource or editing an existing one.
+ * @publicDocs
  */
 export type IntentAction = 'create' | 'edit';
 
 /**
  * The types of Shopify resources that support intent-based creation and editing workflows.
+ * @publicDocs
  */
 export type IntentType =
   | 'shopify/Article'
@@ -79,6 +111,7 @@ export type IntentType =
 
 /**
  * Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.
+ * @publicDocs
  */
 export interface IntentQueryOptions {
   /**
@@ -93,6 +126,7 @@ export interface IntentQueryOptions {
 
 /**
  * A structured intent specification defining what workflow to launch. Use this format when you prefer object syntax over string query format.
+ * @publicDocs
  */
 export interface IntentQuery extends IntentQueryOptions {
   /**
@@ -128,6 +162,7 @@ export interface IntentQuery extends IntentQueryOptions {
  * });
  * const response = await activity.complete;
  * ```
+ * @publicDocs
  */
 export interface IntentInvokeApi {
   (query: IntentQuery): Promise<IntentActivity>;
@@ -136,8 +171,14 @@ export interface IntentInvokeApi {
 
 /**
  * The `Intents` object provides methods for launching standardized Shopify workflows to create or edit resources. Intents enable your extension to trigger native admin interfaces for products, customers, discounts, and other resources, then receive the results when merchants complete the workflow.
+ * @publicDocs
  */
 export interface Intents {
+  /**
+   * Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.
+   */
+  response?: IntentResponseApi;
+
   /**
    * The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.
    */

package/src/surfaces/admin/api/order-routing-rule/data.ts

@@ -2,8 +2,9 @@ import type {SupportedDefinitionType} from './metafields';
 
 /**
  * A [metafield](/docs/apps/build/metafields) associated with an order routing rule. Use metafields to persist settings that control how your order routing function behaves, such as location preferences, routing criteria, or custom fulfillment rules.
+ * @publicDocs
  */
-interface Metafield {
+export interface Metafield {
   /** The unique global identifier (GID) for this metafield. Present for existing metafields, absent for new ones. Use this ID to reference the metafield in GraphQL operations. */
   id?: string | null;
   /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'preferred_location'` or `'routing_priority'`). */
@@ -18,8 +19,9 @@ interface Metafield {
 
 /**
  * An order routing rule configuration that determines how orders are routed to fulfillment locations. Use this to access the rule's current settings and populate your configuration interface.
+ * @publicDocs
  */
-interface OrderRoutingRule {
+export interface OrderRoutingRule {
   /** The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages. */
   label: string;
   /** A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does. */
@@ -34,6 +36,7 @@ interface OrderRoutingRule {
 
 /**
  * The `data` object exposed to order routing rule extensions in the `admin.settings.order-routing-rule.render` target. Use this to access the current rule configuration and build your settings interface.
+ * @publicDocs
  */
 export interface Data {
   /** The order routing rule being configured by the merchant. Use this to access the rule's properties and populate your settings UI with existing configuration values. */

package/src/surfaces/admin/api/order-routing-rule/metafields.ts

@@ -45,8 +45,9 @@ const supportedDefinitionTypes = [
 
 /**
  * A metafield update or creation operation. Use this to set or modify metafield values that store order routing rule configuration data.
+ * @publicDocs
  */
-interface MetafieldUpdateChange {
+export interface MetafieldUpdateChange {
   /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */
   type: 'updateMetafield';
   /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'preferred_location'` or `'routing_priority'`). */
@@ -61,8 +62,9 @@ interface MetafieldUpdateChange {
 
 /**
  * A metafield removal operation. Use this to delete metafields that are no longer needed for your order routing rule configuration.
+ * @publicDocs
  */
-interface MetafieldRemoveChange {
+export interface MetafieldRemoveChange {
   /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */
   type: 'removeMetafield';
   /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */
@@ -73,8 +75,9 @@ interface MetafieldRemoveChange {
 
 /**
  * One or more metafield change operations to apply to order routing rule settings. Can be a single change or an array of changes for batch operations. Use arrays to apply multiple changes at once.
+ * @publicDocs
  */
-type MetafieldsChange =
+export type MetafieldsChange =
   | MetafieldUpdateChange
   | MetafieldRemoveChange
   | MetafieldUpdateChange[]
@@ -82,10 +85,12 @@ type MetafieldsChange =
 
 /**
  * The supported [metafield definition types](/docs/apps/build/metafields/list-of-data-types) for storing order routing rule configuration data. Use these types to specify how metafield values should be formatted, validated, and displayed. Types prefixed with `list.` store arrays of values, while other types store single values.
+ * @publicDocs
  */
 export type SupportedDefinitionType = (typeof supportedDefinitionTypes)[number];
 
 /**
  * A function that applies metafield changes to order routing rule settings. Call this function with one or more change operations to update or remove metafields in batch. Use batch operations to apply multiple configuration changes efficiently.
+ * @publicDocs
  */
 export type ApplyMetafieldsChange = (changes: MetafieldsChange[]) => void;

package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts

@@ -6,6 +6,7 @@ import {Data} from './data';
 
 /**
  * The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.
+ * @publicDocs
  */
 export interface OrderRoutingRuleApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardRenderingExtensionApi<ExtensionTarget> {

package/src/surfaces/admin/api/picker/picker.ts

@@ -1,7 +1,8 @@
 /**
  * A handle returned when opening a picker dialog. Use this to access the merchant's selection after they confirm or cancel the picker.
+ * @publicDocs
  */
-interface Picker {
+export interface Picker {
   /**
    * A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result.
    */
@@ -10,8 +11,9 @@ interface Picker {
 
 /**
  * The configuration for a table column header in the picker. Each header creates a labeled column that displays corresponding data from items.
+ * @publicDocs
  */
-interface Header {
+export interface Header {
   /**
    * The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, "Price", "Status", "Last Updated").
    */
@@ -25,8 +27,9 @@ interface Header {
 
 /**
  * The configuration options for the custom picker dialog. Define the picker's appearance, selection behavior, and data structure.
+ * @publicDocs
  */
-interface PickerOptions {
+export interface PickerOptions {
   /**
    * The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting.
    */
@@ -47,22 +50,26 @@ interface PickerOptions {
 
 /**
  * The visual tone for picker badges indicating status or importance. Use different tones to communicate urgency or state: `'info'` for neutral information, `'success'` for positive states, `'warning'` for caution, or `'critical'` for urgent issues.
+ * @publicDocs
  */
 export type Tone = 'info' | 'success' | 'warning' | 'critical';
 
 /**
  * The progress state for picker badges showing completion status. Use this to indicate how complete an item is: `'incomplete'` for not started, `'partiallyComplete'` for in progress, or `'complete'` for finished.
+ * @publicDocs
  */
 export type Progress = 'incomplete' | 'partiallyComplete' | 'complete';
 
 /**
  * A single data point that can appear in a picker table cell. Can be text, a number, or undefined if the cell should be empty.
+ * @publicDocs
  */
-type DataPoint = string | number | undefined;
+export type DataPoint = string | number | undefined;
 /**
  * A badge displayed next to an item in the picker to show status or progress. Use badges to highlight important item attributes or states that affect selection decisions.
+ * @publicDocs
  */
-interface PickerBadge {
+export interface PickerBadge {
   /** The text content of the badge. Keep this short and descriptive (for example, "Draft", "Active", "Incomplete"). */
   content: string;
   /** The visual tone indicating status or importance. Choose a tone that matches the badge's meaning. */
@@ -73,8 +80,9 @@ interface PickerBadge {
 
 /**
  * An individual item that merchants can select in the picker. Each item appears as a row in the picker table.
+ * @publicDocs
  */
-interface Item {
+export interface Item {
   /**
    * The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys).
    */
@@ -108,5 +116,6 @@ interface Item {
 
 /**
  * The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.
+ * @publicDocs
  */
 export type PickerApi = (options: PickerOptions) => Promise<Picker>;

package/src/surfaces/admin/api/print-action/print-action.ts

@@ -4,6 +4,7 @@ import type {Data} from '../shared';
 
 /**
  * The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.
+ * @publicDocs
  */
 export interface PrintActionExtensionApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts

@@ -5,8 +5,9 @@ import type {Data} from '../shared';
 /**
  * A product configuration.
  * @deprecated
+ * @publicDocs
  */
-interface Product {
+export interface Product {
   /** The product's unique global identifier (GID). */
   id: string;
   /** The product's display name shown to merchants and customers. */
@@ -41,6 +42,7 @@ interface Product {
 /**
  * A component product that is part of a bundle. Represents an individual product included in a bundle configuration.
  * @deprecated
+ * @publicDocs
  */
 export interface ProductComponent {
   /** The component product's unique global identifier (GID). */
@@ -65,6 +67,7 @@ export interface ProductComponent {
 
 /**
  * The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.
+ * @publicDocs
  */
 export interface ProductDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts

@@ -5,8 +5,9 @@ import type {Data} from '../shared';
 /**
  * A product variant configuration.
  * @deprecated
+ * @publicDocs
  */
-interface ProductVariant {
+export interface ProductVariant {
   /** The variant's unique global identifier (GID). */
   id: string;
   /** The Stock Keeping Unit (SKU) identifier for inventory tracking. */
@@ -39,6 +40,7 @@ interface ProductVariant {
 /**
  * A component variant that is part of a product bundle. Represents an individual product variant included in a bundle configuration.
  * @deprecated
+ * @publicDocs
  */
 export interface ProductVariantComponent {
   /** The component variant's unique global identifier (GID). */
@@ -66,6 +68,7 @@ export interface ProductVariantComponent {
 
 /**
  * The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.
+ * @publicDocs
  */
 export interface ProductVariantDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/purchase-options-card-action.ts

@@ -3,6 +3,7 @@ import type {ExtensionTarget as AnyExtensionTarget} from '../extension-targets';
 
 /**
  * The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.
+ * @publicDocs
  */
 export interface PurchaseOptionsCardConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,