Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.
Target APIs
When you build an admin UI extension, Shopify automatically provides you with specific APIs based on where your extension runs within the Shopify admin. This system ensures extensions receive exactly the data and functionality they need for their particular use case, while maintaining security and performance.
Your target determines which APIs you receive because different locations in the Shopify admin require different capabilities.
Anchor to Core APIsCore APIs
Core APIs provide fundamental functionality that action, block, and print action extensions need to integrate with the Shopify admin. These APIs handle essential tasks like modal control, resource data access, print interface management, authentication, and localization. They're available to extensions based on their target type and provide the foundation for building admin UI extensions.
| Name | Description |
|---|---|
| Action Extension API | Control modal behavior and manage action extensions that appear in the More actions menu. |
| Block Extension API | Access resource data and build inline block extensions that display on resource pages. |
| Print Action Extension API | Create print actions that appear in the Print menu and control print interfaces. |
| Standard API | Access session tokens, locale information, and layout utilities for authentication and internationalization. |
Anchor to Contextual APIsContextual APIs
Contextual APIs provide access to data and operations specific to your extension's current location within the Shopify admin. These APIs give you the ability to read and modify context-specific information like product details, variant settings, discount configurations, customer segment templates, order routing rules, purchase options, or validation settings based on where your extension is rendered.
| Name | Description |
|---|---|
| Customer Segment Template Extension API | Provide customer segment template data for marketing and analytics extensions. |
| Discount Function Settings API | Build configuration interfaces for discount functions with access to discount settings. |
| Order Routing Rule API | Define order routing rules for fulfillment and location management extensions. |
| Product Details Configuration API | Build configuration interfaces for products with access to product data and settings. |
| Product Variant Details Configuration API | Build configuration interfaces for product variants with access to variant data and settings. |
| Purchase Options Card Configuration API | Configure purchase options cards for subscription and selling plan management. |
| Validation Settings API | Configure validation rules for cart and checkout validation functions. |
Anchor to Utility APIsUtility APIs
Utility APIs provide helper functionality that enhances your extension's capabilities across different targets. These APIs offer reusable tools for resource selection, custom picker interfaces, intent handling, and conditional rendering that extensions can use regardless of their specific location in the Shopify admin.
| Name | Description |
|---|---|
| Picker API | Launch generic picker modals for custom selection workflows and data entry. |
| Resource Picker API | Launch resource picker modals to search and select products, collections, customers, and other Shopify resources. |
| Should Render API | Control whether action and print action extensions appear in menus based on conditional logic. |