@shopify/ui-extensions 2026.1.0-rc.3 → 2026.1.0-rc.5

package/src/surfaces/point-of-sale/event/data/BaseApi.ts

@@ -1,3 +1,6 @@
 import {StorageApi} from '../../api/storage-api/storage-api';
 
+/**
+ * Base API access provided to extension targets, currently providing access to persistent storage for saving and retrieving extension data across sessions.
+ */
 export type BaseApi = StorageApi;

package/src/surfaces/point-of-sale/event/data/BaseData.ts

@@ -1,8 +1,23 @@
 import type {ConnectivityState, Device, Session} from '../../../point-of-sale';
 
+/**
+ * Base data object provided to all extension targets containing device information, session context, and connectivity state. This data is available at extension initialization and provides essential context about the runtime environment.
+ */
 export interface BaseData {
+  /**
+   * The current Internet connectivity state of the POS device. Indicates whether the device is connected to or disconnected from the Internet. This state updates in real-time as connectivity changes, allowing extensions to adapt behavior for offline scenarios, show connectivity warnings, or queue operations for when connectivity is restored.
+   */
   connectivity: ConnectivityState;
+  /**
+   * Comprehensive information about the physical POS device where the extension is currently running. Includes the device name, unique device ID, and form factor information (tablet vs other). This data is static for the session and helps extensions adapt to different device types, log device-specific information, or implement device-based configurations.
+   */
   device: Device;
+  /**
+   * The [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) locale string for the current POS session (for example, `"en-US"`, `"fr-CA"`, `"de-DE"`). This indicates the merchant's language and regional preferences. Commonly used for internationalization (i18n), locale-specific date/time/number formatting, translating UI text, and providing localized content. The locale remains constant for the session and reflects the language selected in POS settings.
+   */
   locale: string;
+  /**
+   * Comprehensive information about the current POS session including shop ID and domain, authenticated user, pinned staff member, active location, currency settings, and POS version. This session data remains constant for the session duration and provides critical context for business logic, permissions, API authentication, and transaction processing. Session data updates when users switch locations or change pinned staff members.
+   */
   session: Session;
 }

package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts

@@ -2,6 +2,12 @@ import {BaseData} from './BaseData';
 import {Cart} from '../../api';
 import {BaseApi} from './BaseApi';
 
+/**
+ * The data object provided to cart update extension targets. Contains the current cart state along with device, session, and connectivity information. This data is passed to extensions whenever the cart changes, enabling real-time cart monitoring and cart-based business logic.
+ */
 export interface CartUpdateEventData extends BaseData, BaseApi {
+  /**
+   * The complete current `Cart` object containing all cart data including line items with products and quantities, pricing totals (subtotal, tax, grand total), associated customer information, applied discounts, custom properties, and editability state. This represents the cart's state at the moment the extension is triggered, reflecting all recent changes. The cart object is read-only in this context—modifications should be made through the Cart API methods.
+   */
   cart: Cart;
 }

package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts

@@ -1,17 +1,44 @@
 import {BaseData} from './BaseData';
 import {BaseApi} from './BaseApi';
 
+/**
+ * The data object provided to cash tracking session start extension targets. Contains information about a newly opened cash tracking session along with device and session context.
+ */
 export interface CashTrackingSessionStartData extends BaseData, BaseApi {
+  /**
+   * The cash tracking session start data containing the session identifier and the time when the session began. Cash tracking sessions represent the period during which a cash drawer is open and being used for transactions, typically corresponding to a staff member's shift.
+   */
   cashTrackingSessionStart: {
+    /**
+     * The unique numeric identifier for this cash tracking session. This ID distinguishes this session from other cash tracking sessions and can be used for session-specific operations, reporting, or linking transactions to sessions. The ID is assigned when the session opens and remains constant until the session closes.
+     */
     id: number;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and cash drawer operations began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the staff member's shift or cash handling period. Commonly used for calculating session duration, shift reporting, or determining which transactions belong to which session.
+     */
     openingTime: string;
   };
 }
 
+/**
+ * The data object provided to cash tracking session complete extension targets. Contains information about a completed cash tracking session including when it opened and closed, along with device and session context.
+ */
 export interface CashTrackingSessionCompleteData extends BaseData, BaseApi {
+  /**
+   * The cash tracking session complete data containing the session identifier, opening time, and closing time. This represents the full lifecycle of a cash drawer session from opening to closing.
+   */
   cashTrackingSessionComplete: {
+    /**
+     * The unique numeric identifier for this cash tracking session. This ID matches the ID from when the session was opened and can be used to correlate session start and end events, retrieve session-specific data, or link all transactions that occurred during this session.
+     */
     id: number;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the session and can be compared with `closingTime` to calculate the total session duration or shift length.
+     */
     openingTime: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was closed and ended (for example, `"2024-05-15T17:30:00Z"`). This marks when the staff member completed their shift, closed out the cash drawer, and finalized the session. The time between `openingTime` and `closingTime` represents the active session duration. Commonly used for shift reporting, calculating hours worked, or determining the timeframe for session-specific transactions.
+     */
     closingTime: string;
   };
 }

package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts

@@ -1,10 +1,28 @@
 import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
+/**
+ * Defines the data structure for completed exchange transactions.
+ */
 export interface ExchangeTransactionData extends BaseTransactionComplete {
+  /**
+   * The transaction type identifier, always 'Sale' for sale transactions.
+   */
   transactionType: 'Exchange';
+  /**
+   * The return ID for the completed return transaction.
+   */
   returnId?: number;
+  /**
+   * The exchange ID if the return is part of an exchange transaction.
+   */
   exchangeId?: number;
+  /**
+   * An array of line items added to the customer in the exchange.
+   */
   lineItemsAdded: LineItem[];
+  /**
+   * An array of line items removed from the customer in the exchange.
+   */
   lineItemsRemoved: LineItem[];
 }

package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts

@@ -1,7 +1,16 @@
 import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {OrderLineItem} from '../../types/order';
 
+/**
+ * Defines the data structure for receipt reprint requests.
+ */
 export interface ReprintReceiptData extends BaseTransactionComplete {
+  /**
+   * The transaction type identifier, always 'Sale' for sale transactions.
+   */
   transactionType: 'Reprint';
+  /**
+   * An array of line items included in the sale transaction.
+   */
   lineItems: OrderLineItem[];
 }

package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts

@@ -1,10 +1,28 @@
 import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
+/**
+ * Defines the data structure for completed return transactions.
+ */
 export interface ReturnTransactionData extends BaseTransactionComplete {
+  /**
+   * The transaction type identifier, always 'Sale' for sale transactions.
+   */
   transactionType: 'Return';
+  /**
+   * The refund ID if a refund was issued for the return.
+   */
   refundId?: number;
+  /**
+   * The return ID for the completed return transaction.
+   */
   returnId?: number;
+  /**
+   * The exchange ID if the return is part of an exchange transaction.
+   */
   exchangeId?: number;
+  /**
+   * An array of line items included in the sale transaction.
+   */
   lineItems: LineItem[];
 }

package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts

@@ -1,8 +1,20 @@
 import {BaseTransactionComplete} from '../../types/base-transaction-complete';
 import {LineItem} from '../../types/cart';
 
+/**
+ * Defines the data structure for completed sale transactions.
+ */
 export interface SaleTransactionData extends BaseTransactionComplete {
+  /**
+   * The transaction type identifier, always 'Sale' for sale transactions.
+   */
   transactionType: 'Sale';
+  /**
+   * The UUID of the draft checkout if the sale originated from a draft order.
+   */
   draftCheckoutUuid?: string;
+  /**
+   * An array of line items included in the sale transaction.
+   */
   lineItems: LineItem[];
 }

package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts

@@ -5,14 +5,41 @@ import type {ReturnTransactionData} from './ReturnTransactionData';
 import type {ReprintReceiptData} from './ReprintReceiptData';
 import {BaseApi} from './BaseApi';
 
+/**
+ * The data object provided to receipt targets containing transaction details.
+ */
 export interface TransactionCompleteData extends BaseData, BaseApi {
+  /**
+   * Provides access to persistent local storage methods for your POS UI extension. Use this to store, retrieve, and manage data that persists across sessions.
+   */
+  storage: BaseApi['storage'];
+  /**
+   * The transaction data, which can be one of the following types:
+   * - `SaleTransactionData`: Defines the data structure for completed sale transactions.
+   * - `ReturnTransactionData`: Defines the data structure for completed return transactions.
+   * - `ExchangeTransactionData`: Defines the data structure for completed exchange transactions.
+   */
   transaction:
     | SaleTransactionData
     | ReturnTransactionData
     | ExchangeTransactionData;
 }
 
+/**
+ * The data object provided to receipt targets containing transaction details and reprint information.
+ */
 export interface TransactionCompleteWithReprintData extends BaseData, BaseApi {
+  /**
+   * Provides access to persistent local storage methods for your POS UI extension. Use this to store, retrieve, and manage data that persists across sessions.
+   */
+  storage: BaseApi['storage'];
+  /**
+   * The transaction data, which can be one of the following types:
+   * - `SaleTransactionData`: Defines the data structure for completed sale transactions.
+   * - `ReturnTransactionData`: Defines the data structure for completed return transactions.
+   * - `ExchangeTransactionData`: Defines the data structure for completed exchange transactions.
+   * - `ReprintReceiptData`: Defines the data structure for receipt reprint requests.
+   */
   transaction:
     | SaleTransactionData
     | ReturnTransactionData

package/src/surfaces/point-of-sale/event/output/BaseOutput.ts

@@ -1,8 +1,25 @@
+/**
+ * Represents an error or warning generated during extension execution. Extends the standard JavaScript Error interface with severity level classification.
+ */
 interface ExtensionError extends Error {
+  /**
+   * The severity level of this error:
+   * - `'error'`: A critical error that prevents the extension from completing successfully. Errors typically block the user workflow and require resolution before proceeding.
+   * - `'warning'`: A non-critical issue that doesn't prevent extension execution but indicates a problem or unexpected condition. Warnings allow the workflow to continue but should be logged or displayed to users.
+   */
   level: 'error' | 'warning';
+  /**
+   * The human-readable error message describing what went wrong. This message should be clear and actionable, helping merchants understand the issue and how to resolve it (for example, "Product not found", "Invalid discount code", "Insufficient inventory"). The message may be displayed to users in the POS interface depending on the error severity and context.
+   */
   message: string;
 }
 
+/**
+ * Base output structure that extensions can return to communicate errors and warnings back to the POS system. Extensions populate this interface when they encounter issues during execution.
+ */
 export interface BaseOutput {
+  /**
+   * An array of errors or warnings encountered during extension execution. Each error includes a severity level (`'error'` or `'warning'`) and a descriptive message. Multiple errors can be reported simultaneously. Returns `undefined` or empty array when the extension executes successfully without issues. Critical errors may prevent transaction completion, while warnings allow the transaction to proceed but indicate issues that should be addressed.
+   */
   errors?: ExtensionError[];
 }

package/src/surfaces/point-of-sale/extension-targets.ts

@@ -44,56 +44,116 @@ export interface EventExtensionTargets {
 }
 
 export interface RenderExtensionTargets {
+  /**
+   * Renders a single interactive tile component on the POS home screen's smart grid. The tile appears once during home screen initialization and remains persistent until navigation occurs. Use this target for high-frequency actions, status displays, or entry points to workflows that merchants need daily.
+   *
+   * Extensions at this target can dynamically update properties like enabled state and badge values in response to cart changes or device conditions. Tiles typically invoke `shopify.action.presentModal()` to launch the companion modal for complete workflows.
+   */
   'pos.home.tile.render': RenderExtension<
     StandardApi<'pos.home.tile.render'> & ActionApi & CartApi,
     SmartGridComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from smart grid tiles. The modal appears when users tap a companion tile. Use this target for complete workflow experiences that require more space and functionality than the tile interface provides, such as multi-step processes, detailed information displays, or complex user interactions.
+   *
+   * Extensions at this target support full navigation hierarchies with multiple screens, scroll views, and interactive components to handle sophisticated workflows.
+   */
   'pos.home.modal.render': RenderExtension<
     ActionTargetApi<'pos.home.modal.render'> & CartApi,
     BasicComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the post-return action menu. Use this target for post-return operations like generating return receipts, processing restocking workflows, or collecting return feedback.
+   *
+   * Extensions at this target can access the order identifier through the Order API to perform return-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete post-return workflows.
+   */
   'pos.return.post.action.menu-item.render': RenderExtension<
     StandardApi<'pos.return.post.action.menu-item.render'> &
       ActionApi &
       OrderApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from post-return menu items. Use this target for complex post-return workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.return.post.action.render': RenderExtension<
     ActionTargetApi<'pos.return.post.action.render'> & OrderApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the post-return screen. Use this target for displaying supplementary return data like completion status, refund confirmations, or follow-up workflows alongside standard return details.
+   *
+   * Extensions at this target appear as persistent blocks within the post-return interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex post-return operations.
+   */
   'pos.return.post.block.render': RenderExtension<
     StandardApi<'pos.return.post.block.render'> & OrderApi & ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the post-exchange action menu. Use this target for post-exchange operations like generating exchange receipts, processing restocking workflows, or collecting exchange feedback.
+   *
+   * Extensions at this target can access the order identifier through the Order API to perform exchange-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete post-exchange workflows.
+   */
   'pos.exchange.post.action.menu-item.render': RenderExtension<
     StandardApi<'pos.exchange.post.action.menu-item.render'> &
       ActionApi &
       OrderApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from post-exchange menu items. Use this target for complex post-exchange workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.exchange.post.action.render': RenderExtension<
     ActionTargetApi<'pos.exchange.post.action.render'> & OrderApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the post-exchange screen. Use this target for displaying supplementary exchange data like completion status, payment adjustments, or follow-up workflows alongside standard exchange details.
+   *
+   * Extensions at this target appear as persistent blocks within the post-exchange interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex post-exchange operations.
+   */
   'pos.exchange.post.block.render': RenderExtension<
     StandardApi<'pos.exchange.post.block.render'> & OrderApi & ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the post-purchase action menu. Use this target for post-purchase operations like sending receipts, collecting customer feedback, or launching follow-up workflows after completing a sale.
+   *
+   * Extensions at this target can access the order identifier through the Order API to perform purchase-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete post-purchase workflows.
+   */
   'pos.purchase.post.action.menu-item.render': RenderExtension<
     StandardApi<'pos.purchase.post.action.menu-item.render'> &
       ActionApi &
       OrderApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from post-purchase menu items. Use this target for complex post-purchase workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.purchase.post.action.render': RenderExtension<
     ActionTargetApi<'pos.purchase.post.action.render'> & OrderApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the post-purchase screen. Use this target for displaying supplementary purchase data like completion status, customer feedback prompts, or next-step workflows alongside standard purchase details.
+   *
+   * Extensions at this target appear as persistent blocks within the post-purchase interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex post-purchase operations.
+   */
   'pos.purchase.post.block.render': RenderExtension<
     StandardApi<'pos.purchase.post.block.render'> & OrderApi & ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the product details action menu. Use this target for product-specific operations like inventory adjustments, product analytics, or integration with external product management systems.
+   *
+   * Extensions at this target can access the product identifier through the Product API to perform product-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete product workflows.
+   */
   'pos.product-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.product-details.action.menu-item.render'> &
       ActionApi &
@@ -101,10 +161,20 @@ export interface RenderExtensionTargets {
       ProductApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from product details menu items. Use this target for complex product workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to product and cart data through the Product API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.product-details.action.render': RenderExtension<
     ActionTargetApi<'pos.product-details.action.render'> & CartApi & ProductApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the product details screen. Use this target for displaying supplementary product data like detailed specifications, inventory status, or related product recommendations alongside standard product details.
+   *
+   * Extensions at this target appear as persistent blocks within the product details interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex product operations.
+   */
   'pos.product-details.block.render': RenderExtension<
     StandardApi<'pos.product-details.block.render'> &
       CartApi &
@@ -112,6 +182,11 @@ export interface RenderExtensionTargets {
       ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the order details action menu. Use this target for order-specific operations like reprints, refunds, exchanges, or launching fulfillment workflows.
+   *
+   * Extensions at this target can access the order identifier through the Order API to perform order-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete order workflows.
+   */
   'pos.order-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.order-details.action.menu-item.render'> &
       ActionApi &
@@ -119,10 +194,20 @@ export interface RenderExtensionTargets {
       OrderApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from order details menu items. Use this target for complex order workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.order-details.action.render': RenderExtension<
     ActionTargetApi<'pos.order-details.action.render'> & CartApi & OrderApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the order details screen. Use this target for displaying supplementary order data like fulfillment status, tracking numbers, or custom order analytics alongside standard order details.
+   *
+   * Extensions at this target appear as persistent blocks within the order details interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex order operations.
+   */
   'pos.order-details.block.render': RenderExtension<
     StandardApi<'pos.order-details.block.render'> &
       CartApi &
@@ -130,6 +215,11 @@ export interface RenderExtensionTargets {
       ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the draft order details action menu. Use this target for draft order-specific operations like sending invoices, updating payment status, or launching custom workflow processes for pending orders.
+   *
+   * Extensions at this target can access draft order information including order ID, name, and associated customer through the Draft Order API. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete draft order workflows.
+   */
   'pos.draft-order-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.draft-order-details.action.menu-item.render'> &
       ActionApi &
@@ -137,12 +227,22 @@ export interface RenderExtensionTargets {
       DraftOrderApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from draft order details menu items. Use this target for complex draft order workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to draft order data through the Draft Order API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.draft-order-details.action.render': RenderExtension<
     ActionTargetApi<'pos.draft-order-details.action.render'> &
       DraftOrderApi &
       CartApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the draft order details screen. Use this target for displaying supplementary order information like processing status, payment status, or workflow indicators alongside standard draft order details.
+   *
+   * Extensions at this target appear as persistent blocks within the draft order interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex draft order operations.
+   */
   'pos.draft-order-details.block.render': RenderExtension<
     StandardApi<'pos.draft-order-details.block.render'> &
       ActionApi &
@@ -150,6 +250,11 @@ export interface RenderExtensionTargets {
       DraftOrderApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the customer details action menu. Use this target for customer-specific operations like applying customer discounts, processing loyalty redemptions, or launching profile update workflows.
+   *
+   * Extensions at this target can access the customer identifier through the Customer API to perform customer-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete customer workflows.
+   */
   'pos.customer-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.customer-details.action.menu-item.render'> &
       ActionApi &
@@ -157,12 +262,22 @@ export interface RenderExtensionTargets {
       CustomerApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from customer details menu items. Use this target for complex customer workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to customer data through the Customer API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.customer-details.action.render': RenderExtension<
     ActionTargetApi<'pos.customer-details.action.render'> &
       CartApi &
       CustomerApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the customer details screen. Use this target for displaying supplementary customer data like loyalty status, points balance, or personalized information alongside standard customer details.
+   *
+   * Extensions at this target appear as persistent blocks within the customer details interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex customer operations.
+   */
   'pos.customer-details.block.render': RenderExtension<
     StandardApi<'pos.customer-details.block.render'> &
       CartApi &
@@ -170,6 +285,11 @@ export interface RenderExtensionTargets {
       ActionApi,
     BlockExtensionComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the cart line item action menu. Use this target for item-specific operations like applying discounts, adding custom properties, or launching verification workflows for individual cart items.
+   *
+   * Extensions at this target can access detailed line item information including title, quantity, price, discounts, properties, and product metadata through the Cart Line Item API. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete workflows.
+   */
   'pos.cart.line-item-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.cart.line-item-details.action.menu-item.render'> &
       ActionApi &
@@ -177,6 +297,11 @@ export interface RenderExtensionTargets {
       CartLineItemApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from cart line item menu items. Use this target for complex line item workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to detailed line item data through the Cart Line Item API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.cart.line-item-details.action.render': RenderExtension<
     ActionTargetApi<'pos.cart.line-item-details.action.render'> &
       ActionApi &
@@ -184,24 +309,49 @@ export interface RenderExtensionTargets {
       CartLineItemApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom section in the footer of printed receipts. Use this target for adding contact details, return policies, social media links, or customer engagement elements like survey links or marketing campaigns at the bottom of receipts.
+   *
+   * Extensions at this target appear in the receipt footer area and support limited components optimized for print formatting, including text content for information display.
+   */
   'pos.receipt-footer.block.render': RenderExtension<
     {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
     ReceiptComponents
   >;
+  /**
+   * Renders a custom section in the header of printed receipts. Use this target for adding custom branding, logos, promotional messages, or store-specific information at the top of receipts.
+   *
+   * Extensions at this target appear in the receipt header area and support limited components optimized for print formatting, including text content for information display.
+   */
   'pos.receipt-header.block.render': RenderExtension<
     {[key: string]: any} & StorageApi & TransactionCompleteWithReprintData,
     ReceiptComponents
   >;
+  /**
+   * Renders a single interactive button component as a menu item in the register details action menu. Use this target for register-specific operations like cash drawer management, shift reports, or launching cash reconciliation workflows.
+   *
+   * Extensions at this target can access cash drawer functionality through the Cash Drawer API to perform register-specific operations. Menu items typically invoke `shopify.action.presentModal()` to launch the companion modal for complete register workflows.
+   */
   'pos.register-details.action.menu-item.render': RenderExtension<
     StandardApi<'pos.register-details.action.menu-item.render'> &
       ActionApi &
       CashDrawerApi,
     ActionExtensionComponents
   >;
+  /**
+   * Renders a full-screen modal interface launched from register details menu items. Use this target for complex register workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.
+   *
+   * Extensions at this target have access to cash drawer functionality through the Cash Drawer API and support workflows with multiple screens, navigation, and interactive components.
+   */
   'pos.register-details.action.render': RenderExtension<
     ActionTargetApi<'pos.register-details.action.render'> & CashDrawerApi,
     BasicComponents
   >;
+  /**
+   * Renders a custom information section within the register details screen. Use this target for displaying supplementary register data like cash drawer status, transaction summaries, or shift analytics alongside standard register details.
+   *
+   * Extensions at this target appear as persistent blocks within the register details interface and support interactive elements that can launch modal workflows using `shopify.action.presentModal()` for more complex register operations.
+   */
   'pos.register-details.block.render': RenderExtension<
     StandardApi<'pos.register-details.block.render'> &
       ActionApi &

package/src/surfaces/point-of-sale/types/base-transaction-complete.ts

@@ -5,18 +5,60 @@ import type {ShippingLine} from './shipping-line';
 import type {TaxLine} from './tax-line';
 import type {TransactionType} from './transaction-type';
 
+/**
+ * Base interface for completed transaction data shared across all transaction types.
+ */
 export interface BaseTransactionComplete {
+  /**
+   * The transaction type identifier indicating which kind of transaction was completed (for example, `'Sale'` for new purchases, `'Return'` for refunds, `'Exchange'` for item swaps, `'Reprint'` for receipt reprints). This determines the transaction's business logic, receipt format, and inventory impact.
+   */
   transactionType: TransactionType;
+  /**
+   * The unique numeric identifier for the Shopify order created by this transaction. This ID links the POS transaction to the order record in Shopify's system and can be used for order lookups, tracking, and API operations. Returns `undefined` for transactions that don't create orders (for example, reprints) or when order creation is pending.
+   */
   orderId?: number;
+  /**
+   * The customer information if this transaction is associated with a customer account. Contains the customer ID for linking to customer records. Returns `undefined` for guest transactions where no customer was selected or when the transaction doesn't support customer association.
+   */
   customer?: Customer;
+  /**
+   * An array of all discounts applied to this transaction, including cart-level discounts, automatic discounts, and discount codes. Each discount entry contains the discount amount, type, and description. Returns `undefined` or empty array when no discounts were applied. The sum of discount amounts reduces the final transaction total.
+   */
   discounts?: Discount[];
+  /**
+   * The total tax amount charged on this transaction as a `Money` object. This is the sum of all tax lines and represents the combined tax from all applicable tax jurisdictions and rules. Tax calculations are based on the location, products, customer, and tax settings configured in Shopify.
+   */
   taxTotal: Money;
+  /**
+   * The subtotal amount before taxes and after discounts are applied, as a `Money` object. This represents the sum of all line item prices (quantity × unit price) minus any discounts, but before tax is added. This is the taxable base amount for most tax calculations.
+   */
   subtotal: Money;
+  /**
+   * The final total amount the customer pays for this transaction as a `Money` object. This includes all line items, shipping charges, taxes, and accounts for all discounts. This is the amount that must be tendered through payment methods. Calculated as: subtotal + taxTotal + shipping - discounts.
+   */
   grandTotal: Money;
+  /**
+   * An array of all payment methods used to complete this transaction. Each payment entry specifies the payment type (for example, cash, credit card), amount tendered, and currency. Multiple entries indicate split payments where the customer paid using multiple methods (for example, part cash, part credit card). The sum of all payment amounts should equal or exceed the `grandTotal`.
+   */
   paymentMethods: Payment[];
+  /**
+   * The remaining balance still owed on this transaction as a `Money` object. Typically `{amount: 0, currency: "USD"}` for fully paid transactions. A positive balance indicates partial payment or layaway scenarios. A negative balance indicates overpayment, where change should be returned to the customer. Calculated as: grandTotal minus sum of all payment amounts.
+   */
   balanceDue: Money;
+  /**
+   * An array of shipping charges applied to this transaction. Each shipping line represents a shipping method with its price and associated taxes. Multiple entries can exist when different shipping methods apply to different items or when combining shipping with pickup. Returns `undefined` or empty array for transactions with no shipping charges (for example, in-store purchases, digital products).
+   */
   shippingLines?: ShippingLine[];
+  /**
+   * An array of individual tax lines showing the detailed tax breakdown by jurisdiction and tax type. Each tax line represents a specific tax (for example, state tax, federal tax, VAT, GST) with its rate and calculated amount. Multiple tax lines can apply to a single transaction based on location, product taxability, and tax rules. Returns `undefined` or empty array for tax-exempt transactions or when detailed tax breakdown isn't available.
+   */
   taxLines?: TaxLine[];
-  tipAmount?: Money;
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the transaction was executed and completed (for example, `"2024-05-15T14:30:00Z"`). This marks the exact moment the transaction was finalized, payment was processed, and the order was created. Commonly used for transaction history, chronological sorting, reporting, audit trails, and synchronization with external systems.
+   */
   executedAt: string;
+  /**
+   * The tip amount added to this transaction as a `Money` object. This represents the gratuity the customer chose to add on top of the grand total, typically for service-based businesses or hospitality transactions. Tipping can be enabled through POS settings and may be added as a percentage or fixed amount. Returns `undefined` when no tip was added or when tipping is not enabled for the transaction.
+   */
+  tipAmount?: Money;
 }