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

package/src/surfaces/customer-account/components/shared.ts

@@ -1,10 +1,16 @@
+/**
+ * Provides an `id` property for uniquely identifying elements. This is used across customer account components to enable targeting specific elements for styling, scripting, or accessibility purposes.
+ */
 export interface IdProps {
   /**
-   * A unique identifier for the element.
+   * A unique identifier for the element. Use this to target the element with CSS, JavaScript, or accessibility attributes. The `id` must be unique within the document.
    */
   id?: string;
 }
 
+/**
+ * The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `'small-500'` (smallest) through `'base'` (standard) to `'large-500'` (largest). Not all components support every size — check the component's `size` property type for its available options.
+ */
 export type SizeKeyword =
   | 'small-500'
   | 'small-400'
@@ -20,19 +26,31 @@ export type SizeKeyword =
   | 'large-400'
   | 'large-500';
 
+/**
+ * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management.
+ */
 export interface BaseElementProps<TClass = HTMLElement> {
-  // Assigns a unique key to this element.
+  /**
+   * A unique identifier for this element within its parent. Used by Preact for efficient rendering and reconciliation when lists of elements change by tracking which items have been added, removed, or reordered.
+   */
   key?: preact.Key;
-  // Assigns a ref (generally from `useRef()`) to this element.
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic for imperative operations.
+   */
   ref?: preact.Ref<TClass>;
-  // Assigns this element to a parent's slot.
+  /**
+   * Assigns this element to a named slot in a parent component that uses slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
 
 /**
- * Used when an element has children.
+ * The base properties for elements that have children, extending `BaseElementProps` with children support.
  */
 export interface BaseElementPropsWithChildren<TClass = HTMLElement>
   extends BaseElementProps<TClass> {
+  /**
+   * The child elements to render within this component.
+   */
   children?: preact.ComponentChildren;
 }

package/src/surfaces/customer-account/components.d.ts

@@ -26,8 +26,22 @@ import {
   SectionElementSlots,
 } from './components/Section';
 
+/**
+ * Configure the following properties on the customer account action component.
+ * @publicDocs
+ */
 export type CustomerAccountActionPropsDocs = CustomerAccountActionProps;
+
+/**
+ * The custom element interface for the customer account action component.
+ * @publicDocs
+ */
 export type CustomerAccountActionElementDocs = CustomerAccountActionElement;
+
+/**
+ * The customer account action component supports slots for additional content placement within the modal. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
+ * @publicDocs
+ */
 export type CustomerAccountActionElementSlotsDocs =
   CustomerAccountActionElementSlots;
 
@@ -50,7 +64,16 @@ declare module 'preact' {
   }
 }
 
+/**
+ * Display up to 4 images in a grid or stacked layout. For example, images of products in a wishlist or subscription.
+ * @publicDocs
+ */
 export type ImageGroupPropsDocs = ImageGroupProps;
+
+/**
+ * The custom element interface for the image group component.
+ * @publicDocs
+ */
 export type ImageGroupElementDocs = ImageGroupElement;
 
 declare global {
@@ -71,8 +94,22 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The outer wrapper of the page—including the page title, subtitle, and page-level actions—displayed in a familiar and consistent style.
+ * @publicDocs
+ */
 export type PagePropsDocs = PageProps;
+
+/**
+ * The custom element interface for the page component.
+ * @publicDocs
+ */
 export type PageElementDocs = PageElement;
+
+/**
+ * The page component supports slots for additional content placement within the page. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
+ * @publicDocs
+ */
 export type PageElementSlotsDocs = PageElementSlots;
 
 declare global {
@@ -94,9 +131,28 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The element props interface for the avatar component.
+ * @publicDocs
+ */
 export type AvatarElementPropsDocs = AvatarElementProps;
+
+/**
+ * Avatar is used to show a thumbnail representation of an individual or business in the interface.
+ * @publicDocs
+ */
 export type AvatarPropsDocs = AvatarProps;
+
+/**
+ * The custom element interface for the avatar component.
+ * @publicDocs
+ */
 export type AvatarElementDocs = AvatarElement;
+
+/**
+ * The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
+ * @publicDocs
+ */
 export type AvatarEventsDocs = AvatarEvents;
 
 declare global {
@@ -115,7 +171,16 @@ declare module 'preact' {
   }
 }
 
+/**
+ * Configure the following properties on the menu component.
+ * @publicDocs
+ */
 export type MenuPropsDocs = MenuProps;
+
+/**
+ * The custom element interface for the menu component.
+ * @publicDocs
+ */
 export type MenuElementDocs = MenuElement;
 
 declare global {
@@ -136,8 +201,22 @@ declare module 'preact' {
   }
 }
 
+/**
+ * Configure the following properties on the button group component.
+ * @publicDocs
+ */
 export type ButtonGroupPropsDocs = ButtonGroupProps;
+
+/**
+ * The custom element interface for the button group component.
+ * @publicDocs
+ */
 export type ButtonGroupElementDocs = ButtonGroupElement;
+
+/**
+ * The button group component supports slots for additional content placement within the group. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
+ * @publicDocs
+ */
 export type ButtonGroupElementSlotsDocs = ButtonGroupElementSlots;
 
 declare global {
@@ -159,8 +238,22 @@ declare module 'preact' {
   }
 }
 
+/**
+ * Configure the following properties on the section component.
+ * @publicDocs
+ */
 export type SectionPropsDocs = SectionProps;
+
+/**
+ * The custom element interface for the section component.
+ * @publicDocs
+ */
 export type SectionElementDocs = SectionElement;
+
+/**
+ * The section component supports slots for additional content placement within the section. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
+ * @publicDocs
+ */
 export type SectionElementSlotsDocs = SectionElementSlots;
 
 declare global {

package/src/surfaces/customer-account/extension-targets.ts

@@ -18,6 +18,7 @@ import {
  * and is expected to return a value in a specific shape.
  * The input arguments and the output type are different
  * for each extension target.
+ * @publicDocs
  */
 export interface ExtensionTargets
   extends OrderStatusExtensionTargets,
@@ -190,6 +191,7 @@ export type CustomerAccountExtensionTarget =
  * accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core)
  * and an additional `api` argument, and using those arguments to render
  * UI.
+ * @publicDocs
  */
 export type RenderExtensionTarget = {
   [Target in keyof ExtensionTargets]: ExtensionTargets[Target] extends RenderExtension<
@@ -205,6 +207,7 @@ export type RenderExtensionTarget = {
  * accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core)
  * and an additional `api` argument, and using those arguments to render
  * UI.
+ * @publicDocs
  */
 export type RenderOrderStatusExtensionTarget = {
   [Target in keyof OrderStatusExtensionTargets]: OrderStatusExtensionTargets[Target] extends RenderExtension<
@@ -220,6 +223,7 @@ export type RenderOrderStatusExtensionTarget = {
  * accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core)
  * and an additional `api` argument, and using those arguments to render
  * UI.
+ * @publicDocs
  */
 export type RenderCustomerAccountExtensionTarget = {
   [Target in keyof CustomerAccountExtensionTargets]: CustomerAccountExtensionTargets[Target] extends RenderExtension<
@@ -232,6 +236,7 @@ export type RenderCustomerAccountExtensionTarget = {
 
 /**
  * A mapping of each “render extension” name to its callback type.
+ * @publicDocs
  */
 export type RenderExtensions = {
   [Target in RenderExtensionTarget]: ExtensionTargets[Target];
@@ -252,6 +257,7 @@ type ExtractedAllowedComponentsFromRenderExtension<T> =
  * extension will receive at runtime. This API type is the second argument to
  * the callback for that extension target. The first callback for all of the rendering
  * extension targets each receive a `RemoteRoot` object.
+ * @publicDocs
  */
 export type ApiForRenderExtension<Target extends keyof RenderExtensions> =
   ExtractedApiFromRenderExtension<RenderExtensions[Target]>;
@@ -259,6 +265,7 @@ export type ApiForRenderExtension<Target extends keyof RenderExtensions> =
 /**
  * For a given rendering extension target, returns the UI components that the
  * extension target supports.
+ * @publicDocs
  */
 export type AllowedComponentsForRenderExtension<
   Target extends keyof RenderExtensions,
@@ -271,6 +278,7 @@ export interface ActionExtensionApi {
 /**
  * For a given extension target, returns the type of the API that the
  * extension will receive at runtime.
+ * @publicDocs
  */
 export type ApiForExtension<Target extends keyof ExtensionTargets> =
   ExtractedApiFromExtension<ExtensionTargets[Target]>;

package/src/surfaces/point-of-sale/api/action-api/action-api.ts

@@ -1,3 +1,6 @@
+/**
+ * @publicDocs
+ */
 export interface ActionApiContent {
   /**
    * Presents the corresponding action (modal) target on top of the current view as a full-screen modal. For example, calling this method from `pos.purchase.post.action.menu-item.render` presents `pos.purchase.post.action.render`. Use to launch detailed workflows, complex forms, or multi-step processes that require more screen space than simple components provide.
@@ -7,6 +10,7 @@ export interface ActionApiContent {
 
 /**
  * The `ActionApi` object provides methods for presenting modal interfaces. Access these methods through `shopify.action` to launch full-screen modal experiences.
+ * @publicDocs
  */
 export interface ActionApi {
   action: ActionApiContent;

package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts

@@ -1,6 +1,9 @@
 import {ScannerApi} from '../scanner-api/scanner-api';
 import {StandardApi} from '../standard/standard-api';
 
+/**
+ * @publicDocs
+ */
 export type ActionTargetApi<T> = {[key: string]: any} & {
   extensionPoint: T;
 } & StandardApi<T> &

package/src/surfaces/point-of-sale/api/camera-api/camera-api.ts

@@ -1,5 +1,6 @@
 /**
  * Specifies configuration options for capturing photos using the device camera.
+ * @publicDocs
  */
 export interface CameraMediaOptions {
   /**
@@ -29,6 +30,7 @@ export interface CameraMediaOptions {
 
 /**
  * Represents the captured image and associated metadata returned by `shopify.camera.takePhoto()`.
+ * @publicDocs
  */
 export interface CameraMediaResponse {
   /** The image data as base64 string. */
@@ -45,6 +47,7 @@ export interface CameraMediaResponse {
 
 /**
  * Provides camera capabilities for the POS device.
+ * @publicDocs
  */
 export interface CameraApiContent {
   /**
@@ -63,6 +66,7 @@ export interface CameraApiContent {
 /**
  * The `CameraApi` object provides access to device camera functionality for capturing photos.
  * Access these properties through `shopify.camera`.
+ * @publicDocs
  */
 export interface CameraApi {
   camera: CameraApiContent;

package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts

@@ -12,6 +12,7 @@ import type {
 
 /**
  * The `CartApi` object provides access to cart management functionality and real-time cart state monitoring. Access these properties through `shopify.cart` to interact with the current POS cart.
+ * @publicDocs
  */
 export interface CartApi {
   cart: CartApiContent;
@@ -19,14 +20,20 @@ export interface CartApi {
 
 /**
  * Defines the type of discount applied at the cart level. Specifies whether the discount is percentage-based, fixed amount, or discount code redemption.
+ * @publicDocs
  */
 export type CartDiscountType = 'Percentage' | 'FixedAmount' | 'Code';
 
 /**
  * Defines the type of discount applied to individual line items. Specifies whether the discount is percentage-based or a fixed amount reduction.
+ * @publicDocs
  */
 export type LineItemDiscountType = 'Percentage' | 'FixedAmount';
 
+/**
+ * The `CartApi` object provides access to cart management functionality and real-time cart state monitoring. Access these properties through `shopify.cart` to interact with the current POS cart.
+ * @publicDocs
+ */
 export interface CartApiContent {
   /**
    * Provides read-only access to the current cart state and allows subscribing to cart changes. The `value` property provides the current cart state, and `subscribe` allows listening to changes with improved performance and memory management.

package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts

@@ -2,6 +2,7 @@ import type {LineItem} from '../../types/cart';
 
 /**
  * The `CartLineItemApi` object provides access to the current line item. Access this property through `api.cartLineItem` to interact with the current line item context.
+ * @publicDocs
  */
 export interface CartLineItemApi {
   /**

package/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts

@@ -1,5 +1,6 @@
 /**
  * The `CashDrawerApi` object provides methods for controlling cash drawer hardware. Access these methods through `shopify.cashDrawer` to trigger cash drawer operations.
+ * @publicDocs
  */
 export interface CashDrawerApiContent {
   /**
@@ -12,6 +13,7 @@ export interface CashDrawerApiContent {
 
 /**
  * The `CashDrawerApi` object provides methods for controlling cash drawer hardware. Access these methods through `shopify.cashDrawer` to trigger cash drawer operations.
+ * @publicDocs
  */
 export interface CashDrawerApi {
   /**

package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts

@@ -1,9 +1,13 @@
 import type {ReadonlySignalLike} from '../../../../shared';
 
+/**
+ * @publicDocs
+ */
 export type ConnectivityStateSeverity = 'Connected' | 'Disconnected';
 
 /**
  * Represents the current Internet connectivity status of the device. Indicates whether the device is connected or disconnected from the Internet.
+ * @publicDocs
  */
 export interface ConnectivityState {
   /**
@@ -12,6 +16,10 @@ export interface ConnectivityState {
   internetConnected: ConnectivityStateSeverity;
 }
 
+/**
+ * Provides access to the current connectivity state for the POS device.
+ * @publicDocs
+ */
 export interface ConnectivityApiContent {
   /**
    * Provides read-only access to the current connectivity state and allows subscribing to connectivity changes. Use for implementing connectivity-aware functionality and reactive connectivity handling.
@@ -21,6 +29,7 @@ export interface ConnectivityApiContent {
 
 /**
  * The `ConnectivityApi` object provides access to current connectivity information and change notifications. Access these properties through `shopify.connectivity` to monitor network status.
+ * @publicDocs
  */
 export interface ConnectivityApi {
   connectivity: ConnectivityApiContent;

package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts

@@ -1,10 +1,15 @@
 /**
  * The `CustomerApi` object provides access to customer data in customer-specific extension contexts. Access this property through `shopify.customer` to retrieve information about the customer currently being viewed or interacted with in the POS interface.
+ * @publicDocs
  */
 export interface CustomerApi {
   customer: CustomerApiContent;
 }
 
+/**
+ * The `CustomerApi` object provides customer information for the active context.
+ * @publicDocs
+ */
 export interface CustomerApiContent {
   /**
    * The unique identifier for the customer. Use for customer lookups, applying customer-specific pricing, enabling personalized features, and integrating with external systems.

package/src/surfaces/point-of-sale/api/device-api/device-api.ts

@@ -1,3 +1,7 @@
+/**
+ * The `DeviceApi` object provides device details and capabilities.
+ * @publicDocs
+ */
 export interface DeviceApiContent {
   /**
    * The name of the device as configured by the merchant or system. Use for displaying device information in interfaces, logging, or support contexts where device identification is helpful.
@@ -20,6 +24,7 @@ export interface DeviceApiContent {
 
 /**
  * The `DeviceApi` object provides access to device information and capabilities. Access these properties and methods through `shopify.device` to retrieve device details and check device characteristics.
+ * @publicDocs
  */
 export interface DeviceApi {
   device: DeviceApiContent;

package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts

@@ -1,10 +1,15 @@
 /**
  * The `DraftOrderApi` object provides access to draft order data in draft order-specific extension contexts. Access this property through `shopify.draftOrder` to retrieve information about the draft order currently being viewed or interacted with in the POS interface.
+ * @publicDocs
  */
 export interface DraftOrderApi {
   draftOrder: DraftOrderApiContent;
 }
 
+/**
+ * The `DraftOrderApi` object provides draft order details for the active context.
+ * @publicDocs
+ */
 export interface DraftOrderApiContent {
   /**
    * The unique identifier for the draft order. Use for draft order lookups, implementing order-specific functionality, and integrating with external systems.

package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts

@@ -1,5 +1,9 @@
 import type {ReadonlySignalLike} from '../../../../shared';
 
+/**
+ * The `LocaleApi` object provides the current locale and locale updates.
+ * @publicDocs
+ */
 export interface LocaleApiContent {
   /**
    * Provides read-only access to the current IETF-formatted locale and allows subscribing to locale changes. The `value` property provides the current locale, and `subscribe` allows listening to changes. Use for internationalization, locale-specific formatting, and reactive updates when merchants change language settings.
@@ -9,6 +13,7 @@ export interface LocaleApiContent {
 
 /**
  * The `LocaleApi` object provides access to current locale information and change notifications. Access these properties through `shopify.locale` to retrieve and monitor locale data.
+ * @publicDocs
  */
 export interface LocaleApi {
   locale: LocaleApiContent;

package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts

@@ -1,5 +1,6 @@
 /**
  * Specifies configuration options for navigation operations. Allows passing state data that persists across navigation transitions.
+ * @publicDocs
  */
 export interface NavigationNavigateOptions {
   /**
@@ -10,6 +11,7 @@ export interface NavigationNavigateOptions {
 
 /**
  * Represents a single entry in the navigation history stack. Contains the URL and unique identifier for tracking navigation state and implementing history-based navigation.
+ * @publicDocs
  */
 export interface NavigationHistoryEntry {
   /**
@@ -28,6 +30,7 @@ export interface NavigationHistoryEntry {
 
 /**
  * The event object for the `currententrychange` event, which fires when `Navigation.currentEntry` has changed due to navigation within the extension modal. Use to access information about the previous navigation entry when responding to navigation changes.
+ * @publicDocs
  */
 export interface NavigationCurrentEntryChangeEvent {
   /**
@@ -36,6 +39,10 @@ export interface NavigationCurrentEntryChangeEvent {
   from: NavigationHistoryEntry;
 }
 
+/**
+ * The `Navigation` object provides navigation controls for extension modals.
+ * @publicDocs
+ */
 export interface Navigation {
   /**
    * Navigates to a specific URL, updating any provided state in the history entries list. Returns a promise that resolves when navigation is complete. Use for programmatic navigation between screens, implementing custom navigation controls, or deep-linking to specific modal states.
@@ -71,6 +78,7 @@ export interface Navigation {
 
 /**
  * The global `window` object provides control over the extension modal lifecycle. Access these properties and methods directly through the global `window` object to manage the modal interface programmatically.
+ * @publicDocs
  */
 export interface Window {
   /**
@@ -81,6 +89,7 @@ export interface Window {
 
 /**
  * The global `window` object provides control over the extension modal lifecycle. Access these properties and methods directly through the global `window` object to manage the modal interface programmatically.
+ * @publicDocs
  */
 export interface Window {
   /**

package/src/surfaces/point-of-sale/api/order-api/order-api.ts

@@ -1,5 +1,6 @@
 /**
  * The `OrderApi` object provides access to order data in order-specific extension contexts. Access this property through `shopify.order` to retrieve information about the order currently being viewed or interacted with in the POS interface.
+ * @publicDocs
  */
 export interface OrderApi {
   order: OrderApiContent;
@@ -7,6 +8,7 @@ export interface OrderApi {
 
 /**
  * The `OrderApi` object provides access to order data. Access this property through `shopify.order` to interact with the current order context.
+ * @publicDocs
  */
 export interface OrderApiContent {
   /**

package/src/surfaces/point-of-sale/api/pin-pad-api.ts

@@ -1,5 +1,9 @@
 import {PinPadOptions, PinValidationResult} from '../types/pin-pad';
 
+/**
+ * The `PinPadApi` object provides PIN entry and validation functionality.
+ * @publicDocs
+ */
 export interface PinPadApiContent {
   /**
    * Shows a PIN pad to the user in a modal dialog. The `onSubmit` function is called when the PIN is submitted and should validate the PIN, returning `'accept'` or `'reject'`.
@@ -20,6 +24,7 @@ export interface PinPadApiContent {
 
 /**
  * The `PinPadApi` object provides methods for displaying secure PIN entry interfaces. Access these methods through `shopify.pinPad` to show PIN pad modals and handle PIN validation.
+ * @publicDocs
  */
 export interface PinPadApi {
   pinPad: PinPadApiContent;

package/src/surfaces/point-of-sale/api/print-api/print-api.ts

@@ -1,5 +1,6 @@
 /**
  * The `PrintApi` object provides methods for triggering document printing. Access these methods through `shopify.print` to initiate print operations with various document types.
+ * @publicDocs
  */
 export interface PrintApiContent {
   /**
@@ -19,6 +20,7 @@ export interface PrintApiContent {
 
 /**
  * The `PrintApi` object provides methods for triggering document printing. Access these methods through `shopify.print` to initiate print operations with various document types.
+ * @publicDocs
  */
 export interface PrintApi {
   /**

package/src/surfaces/point-of-sale/api/product-api/product-api.ts

@@ -1,10 +1,15 @@
 /**
  * The `ProductApi` object provides access to product and variant data in product-specific extension contexts. Access this property through `shopify.product` to retrieve information about the product or variant currently being viewed or interacted with in the POS interface.
+ * @publicDocs
  */
 export interface ProductApi {
   product: ProductApiContent;
 }
 
+/**
+ * The `ProductApi` object provides product and variant details for the active context.
+ * @publicDocs
+ */
 export interface ProductApiContent {
   /**
    * The unique identifier for the product. Use for product lookups, implementing product-specific functionality, and integrating with external systems.

package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts

@@ -2,6 +2,9 @@ import type {MultipleResourceResult} from '../../types/multiple-resource-result'
 import type {PaginatedResult} from '../../types/paginated-result';
 import type {Product, ProductVariant} from '../../types/product';
 
+/**
+ * @publicDocs
+ */
 export type ProductSortType =
   | 'RECENTLY_ADDED'
   | 'RECENTLY_ADDED_ASCENDING'
@@ -10,6 +13,7 @@ export type ProductSortType =
 
 /**
  * Specifies parameters for cursor-based pagination. Includes the cursor position and the number of results to retrieve per page.
+ * @publicDocs
  */
 export interface PaginationParams {
   /**
@@ -24,6 +28,7 @@ export interface PaginationParams {
 
 /**
  * Specifies the parameters for searching products. Includes query text, pagination options, and sorting preferences for product search operations.
+ * @publicDocs
  */
 export interface ProductSearchParams extends PaginationParams {
   /**
@@ -36,6 +41,10 @@ export interface ProductSearchParams extends PaginationParams {
   sortType?: ProductSortType;
 }
 
+/**
+ * The `ProductSearchApi` object provides product search and lookup methods.
+ * @publicDocs
+ */
 export interface ProductSearchApiContent {
   /**
    * Searches for products on the POS device using text queries and sorting options. Returns paginated results with up to 50 products per page. When a query string is provided, results are sorted by relevance. Use for implementing custom search interfaces, product discovery features, or filtered product listings.
@@ -102,6 +111,7 @@ export interface ProductSearchApiContent {
 
 /**
  * The `ProductSearchApi` object provides methods for searching and retrieving product information. Access these methods through `shopify.productSearch` to search products and fetch detailed product data.
+ * @publicDocs
  */
 export interface ProductSearchApi {
   productSearch: ProductSearchApiContent;