@shopify/ui-extensions 2026.1.3 → 2026.1.4

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

@@ -1,3 +1,8 @@
+/**
+ * The `ActionApi` object provides properties for presenting modal interfaces. Access these properties through `shopify.action` to launch full-screen modal experiences.
+ *
+ * @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.
@@ -5,9 +10,7 @@ export interface ActionApiContent {
   presentModal(): void;
 }
 
-/**
- * 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,7 @@
 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

@@ -44,7 +44,9 @@ export interface CameraMediaResponse {
 }
 
 /**
- * Provides camera capabilities for the POS device.
+ * The `CameraApi` object provides properties for capturing photos using the device camera. Access these properties through `shopify.camera` to take photos and retrieve image data with metadata.
+ *
+ * @publicDocs
  */
 export interface CameraApiContent {
   /**
@@ -60,10 +62,7 @@ export interface CameraApiContent {
   takePhoto: (options?: CameraMediaOptions) => Promise<CameraMediaResponse>;
 }
 
-/**
- * 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

@@ -10,9 +10,7 @@ import type {
   SetLineItemSellingPlanInput,
 } from '../../types/cart';
 
-/**
- * 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;
 }
@@ -27,6 +25,11 @@ export type CartDiscountType = 'Percentage' | 'FixedAmount' | 'Code';
  */
 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

@@ -1,7 +1,9 @@
 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.
+ * The `CartLineItemApi` object provides access to the current line item. Access these properties 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,7 @@
 /**
- * The `CashDrawerApi` object provides methods for controlling cash drawer hardware. Access these methods through `shopify.cashDrawer` to trigger cash drawer operations.
+ * The `CashDrawerApi` object provides properties for controlling cash drawer hardware. Access these properties through `shopify.cashDrawer` to trigger cash drawer operations.
+ *
+ * @publicDocs
  */
 export interface CashDrawerApiContent {
   /**
@@ -10,12 +12,7 @@ export interface CashDrawerApiContent {
   open(): Promise<void>;
 }
 
-/**
- * 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 {
-  /**
-   * The `CashDrawerApi` object provides methods for controlling cash drawer hardware. Access these methods through `shopify.cashDrawer` to trigger cash drawer operations.
-   */
   cashDrawer: CashDrawerApiContent;
 }

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

@@ -12,6 +12,11 @@ export interface ConnectivityState {
   internetConnected: ConnectivityStateSeverity;
 }
 
+/**
+ * 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 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.
@@ -19,9 +24,7 @@ export interface ConnectivityApiContent {
   current: ReadonlySignalLike<ConnectivityState>;
 }
 
-/**
- * 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,13 @@
-/**
- * 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 access to customer data. Access these properties through `shopify.customer` to interact with the current customer 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,8 @@
+/**
+ * The `DeviceApi` object provides access to device information and capabilities. Access these properties through `shopify.device` to retrieve device details and check device characteristics.
+ *
+ * @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.
@@ -18,9 +23,7 @@ export interface DeviceApiContent {
   isTablet(): Promise<boolean>;
 }
 
-/**
- * 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,13 @@
-/**
- * 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 access to draft order data. Access these properties through `api.draftOrder` to interact with the current draft order 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,10 @@
 import type {ReadonlySignalLike} from '../../../../shared';
 
+/**
+ * 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 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.
@@ -7,9 +12,7 @@ export interface LocaleApiContent {
   current: ReadonlySignalLike<string>;
 }
 
-/**
- * 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

@@ -36,6 +36,11 @@ export interface NavigationCurrentEntryChangeEvent {
   from: NavigationHistoryEntry;
 }
 
+/**
+ * The global `navigation` object provides web-standard navigation functionality. Access these properties directly through the global `navigation` object to manage navigation within modal interfaces.
+ *
+ * @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.
@@ -70,17 +75,9 @@ 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.
- */
-export interface Window {
-  /**
-   * Closes the extension screen and dismisses the modal interface. Use to programmatically close the modal after completing a workflow, canceling an operation, or when user action is no longer required. This provides the same behavior as the user dismissing the modal through the UI.
-   */
-  close(): void;
-}
-
-/**
- * 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.
+ * The global `window` object provides control over the extension screen lifecycle. Access these properties directly through the global `window` object to manage the modal interface.
+ *
+ * @publicDocs
  */
 export interface Window {
   /**

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

@@ -1,12 +1,12 @@
-/**
- * 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;
 }
 
 /**
- * The `OrderApi` object provides access to order data. Access this property through `shopify.order` to interact with the current order context.
+ * The `OrderApi` object provides access to order data. Access these properties 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,10 @@
 import {PinPadOptions, PinValidationResult} from '../types/pin-pad';
 
+/**
+ * The `PinPadApi` object provides properties for displaying secure PIN entry interfaces. Access these properties through `shopify.pinPad` to show PIN pad modals and handle PIN validation.
+ *
+ * @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'`.
@@ -18,9 +23,7 @@ export interface PinPadApiContent {
   ): void;
 }
 
-/**
- * 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,7 @@
 /**
- * The `PrintApi` object provides methods for triggering document printing. Access these methods through `shopify.print` to initiate print operations with various document types.
+ * The `PrintApi` object provides properties for triggering document printing. Access these properties through `shopify.print` to initiate print operations with various document types.
+ *
+ * @publicDocs
  */
 export interface PrintApiContent {
   /**
@@ -17,12 +19,7 @@ export interface PrintApiContent {
   print(src: string): Promise<void>;
 }
 
-/**
- * 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 {
-  /**
-   * The `PrintApi` object provides methods for triggering document printing. Access these methods through `shopify.print` to initiate print operations with various document types.
-   */
   print: PrintApiContent;
 }

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

@@ -1,10 +1,13 @@
-/**
- * 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 access to product data. Access these properties through `shopify.product` to interact with the current product 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

@@ -36,6 +36,11 @@ export interface ProductSearchParams extends PaginationParams {
   sortType?: ProductSortType;
 }
 
+/**
+ * The `ProductSearchApi` object provides properties for searching and retrieving product information. Access these properties through `shopify.productSearch` to search products and fetch detailed product data.
+ *
+ * @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.
@@ -100,9 +105,7 @@ export interface ProductSearchApiContent {
   ): Promise<PaginatedResult<ProductVariant>>;
 }
 
-/**
- * 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;
 }

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

@@ -41,6 +41,11 @@ export interface ScannerData {
   current: ReadonlySignalLike<ScannerSubscriptionResult>;
 }
 
+/**
+ * The `ScannerApi` object provides access to scanning functionality and scanner source information. Access these properties through `shopify.scanner` to monitor scan events and available scanner sources.
+ *
+ * @publicDocs
+ */
 export interface ScannerApiContent {
   /**
    * Access current scan data and subscribe to new scan events. Use to receive real-time scan results.
@@ -60,9 +65,7 @@ export interface ScannerApiContent {
   hideCameraScanner: () => void;
 }
 
-/**
- * The `ScannerApi` object provides access to scanning functionality and scanner source information. Access these properties through `shopify.scanner` to monitor scan events and available scanner sources.
- */
+/** @publicDocs */
 export interface ScannerApi {
   scanner: ScannerApiContent;
 }

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

@@ -1,5 +1,10 @@
 import type {Session} from '../../types/session';
 
+/**
+ * The `SessionApi` object provides access to current session information and authentication. Access these properties through `shopify.session` to retrieve shop data and generate secure tokens. These properties enable secure API calls while maintaining user privacy and [app permissions](https://help.shopify.com/manual/your-account/users/roles/permissions/store-permissions#apps-and-channels-permissions).
+ *
+ * @publicDocs
+ */
 export interface SessionApiContent {
   /**
    * Provides comprehensive information about the current POS session including shop details, user authentication, location data, staff member information, currency settings, and POS version. This data is static for the duration of the session and updates when users switch locations or staff members change.
@@ -11,9 +16,7 @@ export interface SessionApiContent {
   getSessionToken: () => Promise<string | undefined>;
 }
 
-/**
- * The `SessionApi` object provides access to current session information and authentication methods. Access these properties and methods through `shopify.session` to retrieve shop data and generate secure tokens. These methods enable secure API calls while maintaining user privacy and [app permissions](https://help.shopify.com/manual/your-account/users/roles/permissions/store-permissions#apps-and-channels-permissions).
- */
+/** @publicDocs */
 export interface SessionApi {
   session: SessionApiContent;
 }

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

@@ -1,8 +1,6 @@
 import {Storage} from '../../types/storage';
 
-/**
- * The `StorageApi` object provides access to persistent local storage methods for your POS UI extension. Access these methods through `shopify.storage` to store, retrieve, and manage data that persists across sessions.
- */
+/** @publicDocs */
 export interface StorageApi {
   storage: Storage;
 }

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

@@ -1,3 +1,8 @@
+/**
+ * The `ToastApi` object provides properties for displaying temporary notification messages. Access these properties through `shopify.toast` to show user feedback and status updates.
+ *
+ * @publicDocs
+ */
 export interface ToastApiContent {
   /**
    * Displays a toast notification with the specified text content. The message appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.
@@ -7,9 +12,7 @@ export interface ToastApiContent {
   show: (content: string) => void;
 }
 
-/**
- * The `ToastApi` object provides methods for displaying temporary notification messages. Access these methods through `shopify.toast` to show user feedback and status updates.
- */
+/** @publicDocs */
 export interface ToastApi {
   toast: ToastApiContent;
 }