---
title: Catalogs
description: >-
Catalog details pages display information about a specific catalog, including
its products, pricing rules, and buyer associations. Extensions on these pages
help merchants manage B2B product offerings and customize catalog workflows.
api_version: 2025-10
api_name: admin-extensions
source_url:
html: 'https://shopify.dev/docs/api/admin-extensions/2025-10/targets/catalogs'
md: 'https://shopify.dev/docs/api/admin-extensions/2025-10/targets/catalogs.md'
---
# Catalogs
Catalog details pages display information about a specific catalog, including its products, pricing rules, and buyer associations. Extensions on these pages help merchants manage B2B product offerings and customize catalog workflows.
### Use cases
* **Export and sync workflows:** Enable merchants to export catalog data to external systems, sync pricing with ERP platforms, or generate product feeds for third-party marketplaces.
* **Pricing insights:** Display analytics and recommendations for catalog pricing strategies, showing profit margins, competitive analysis, or price optimization suggestions.
* **Catalog validation:** Show real-time validation results for catalog configurations, highlighting missing product information, pricing conflicts, or incomplete buyer assignments.
* **Third-party integrations:** Connect catalog data with inventory management systems, accounting platforms, or B2B commerce tools to streamline catalog operations.
* **Custom analytics:** Display specialized metrics such as catalog performance by buyer group, product adoption rates, or pricing effectiveness across different market segments.

***
## Catalogs targets
Use [action and block targets](https://shopify.dev/docs/api/admin-extensions/2025-10#building-your-extension) to extend the catalog details page with workflows and contextual information that help merchants manage their B2B product offerings and pricing strategies.
Action targets open as modal overlays from the **More actions** menu, while block targets display as inline cards. The examples demonstrate fetching data from Shopify's [direct API](https://shopify.dev/docs/api/admin-extensions/2025-10#direct-api-access) or your [app's backend](https://shopify.dev/docs/api/admin-extensions/2025-10#app-authentication).
### Catalog details action target
`admin.catalog-details.action.render`
Renders an admin action extension on the catalog details page. Merchants can access this extension from the **More actions** menu. Use this target to provide workflows that operate on the catalog data, such as exporting product lists, syncing pricing with external systems, or generating catalog reports.
Extensions at this target can access information about the catalog through the `data` property in the [Action Extension API](https://shopify.dev/docs/api/admin-extensions/2025-10/target-apis/core-apis/action-extension-api). The action renders in a modal overlay, providing space for multi-step workflows, forms, and confirmations.
### Support Components (45) APIs (1)
### Supported components
* [Admin action](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/settings-and-templates/admin-action)
* [Avatar](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/avatar)
* [Badge](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/badge)
* [Banner](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/banner)
* [Box](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/box)
* [Button](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/button)
* [Button group](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/button-group)
* [Checkbox](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/checkbox)
* [Chip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/chip)
* [Choice list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/choice-list)
* [Clickable](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/clickable)
* [Clickable chip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/clickable-chip)
* [Color field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/color-field)
* [Color picker](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/color-picker)
* [Date field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/date-field)
* [Date picker](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/date-picker)
* [Divider](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/divider)
* [Drop zone](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/drop-zone)
* [Email field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/email-field)
* [Grid](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/grid)
* [Heading](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/heading)
* [Icon](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/icon)
* [Image](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/image)
* [Link](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/link)
* [Menu](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/menu)
* [Money field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/money-field)
* [Number field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/number-field)
* [Ordered list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/ordered-list)
* [Paragraph](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/paragraph)
* [Password field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/password-field)
* [Query container](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/query-container)
* [Search field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/search-field)
* [Section](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/section)
* [Select](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/select)
* [Spinner](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/spinner)
* [Stack](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/stack)
* [Switch](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/switch)
* [Table](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/table)
* [Text](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/text)
* [Text area](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/text-area)
* [Text field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/text-field)
* [Thumbnail](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/thumbnail)
* [Tooltip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/tooltip)
* [Url field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/url-field)
* [Unordered list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/unordered-list)
### Available APIs
* [Action Extension API](https://shopify.dev/docs/api/admin-extensions/2025-10/target-apis/core-apis/action-extension-api)
Examples
### Examples
* ####
##### Description
Add an action extension that exports catalog products and pricing to a CSV file. This example shows how to create a modal workflow that fetches catalog data and generates a downloadable export file.
##### jsx
```jsx
import {render} from 'preact';
import {useState} from 'preact/hooks';
export default async () => {
render(, document.body);
};
const Extension = () => {
const [loading, setLoading] = useState(false);
const [includeVariants, setIncludeVariants] = useState(true);
const [includePricing, setIncludePricing] = useState(true);
const [success, setSuccess] = useState(false);
const [error, setError] = useState(false);
const handleExport = async () => {
setLoading(true);
setSuccess(false);
setError(false);
const catalogId = shopify.data.selected[0].id;
try {
// Export catalog data through your app's backend
const response = await fetch('https://your-app.com/api/export-catalog', {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
catalogId,
includeVariants,
includePricing,
}),
});
if (response.ok) {
const blob = await response.blob();
const url = window.URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = 'catalog-export.csv';
a.click();
setSuccess(true);
shopify.close();
} else {
setError(true);
}
} catch (err) {
setError(true);
} finally {
setLoading(false);
}
};
return (
{success && (
Catalog exported successfully!
)}
{error && (
Failed to export catalog. Please try again.
)}
setIncludeVariants(event.currentTarget.checked)}
/>
setIncludePricing(event.currentTarget.checked)}
/>
{loading ? 'Exporting...' : 'Export to CSV'}
shopify.close()}>
Cancel
);
};
```
* ####
##### Description
Add an action extension that synchronizes catalog pricing with an external ERP system. This example demonstrates how to use the \[GraphQL Admin API]\(/docs/api/admin-graphql) to fetch catalog details and push updates to an external system.
##### jsx
```jsx
import {render} from 'preact';
import {useState} from 'preact/hooks';
export default async () => {
render(, document.body);
};
const Extension = () => {
const [loading, setLoading] = useState(false);
const [syncDirection, setSyncDirection] = useState('push');
const [success, setSuccess] = useState(false);
const [error, setError] = useState(false);
const handleSync = async () => {
setLoading(true);
setSuccess(false);
setError(false);
const catalogId = shopify.data.selected[0].id;
try {
// Fetch catalog details from GraphQL Admin API
const catalogResponse = await fetch('shopify:admin/api/graphql.json', {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
query: `
query GetCatalog($id: ID!) {
catalog(id: $id) {
id
title
priceList {
id
name
prices(first: 250) {
edges {
node {
variant {
id
}
price {
amount
currencyCode
}
}
}
}
}
}
}
`,
variables: {id: catalogId},
}),
});
const {data: catalogData} = await catalogResponse.json();
// Sync catalog pricing through your app's backend
const response = await fetch('https://your-app.com/api/sync-pricing', {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
catalog: catalogData.catalog,
direction: syncDirection,
}),
});
if (response.ok) {
setSuccess(true);
shopify.close();
} else {
setError(true);
}
} catch (err) {
setError(true);
} finally {
setLoading(false);
}
};
return (
{success && (
Pricing synchronized successfully!
)}
{error && (
Failed to sync pricing. Please try again.
)}
setSyncDirection(event.currentTarget.values[0])}
>
Push to ERP (Shopify → ERP)
Pull from ERP (ERP → Shopify)
{loading ? 'Syncing...' : 'Sync Pricing'}
shopify.close()}>
Cancel
);
};
```
### Catalog details action (should render) target
`admin.catalog-details.action.should-render`
Controls the render state of an admin action extension on the catalog details page. Use this target to conditionally show or hide your action extension based on the catalog's properties, such as publication status, product count, or specific business requirements.
This target returns a boolean value that determines whether the corresponding action extension appears in the **More actions** menu. The extension is evaluated each time the page loads.
### Support Components (0) APIs (1)
### Supported components
\-
### Available APIs
* [Should Render API](https://shopify.dev/docs/api/admin-extensions/2025-10/target-apis/utility-apis/should-render-api)
Examples
### Examples
* ####
##### Description
Conditionally display an export action only for catalogs that are currently published. This example demonstrates how to use the \`should-render\` target to control extension visibility based on catalog status.
##### jsx
```jsx
export default async () => {
const catalogId = shopify.data.selected[0].id;
try {
// Fetch catalog details from GraphQL Admin API
const response = await fetch(
'shopify:admin/api/graphql.json',
{
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
query: `
query GetCatalog($id: ID!) {
catalog(id: $id) {
status
}
}
`,
variables: {id: catalogId},
}),
}
);
const {data} = await response.json();
const status = data.catalog.status;
// Only show action for published catalogs
return {display: status === 'ACTIVE'};
} catch (err) {
console.error('Error fetching catalog:', err);
return {display: false};
}
};
```
* ####
##### Description
Conditionally display the sync action only for catalogs that contain products. This example demonstrates filtering based on catalog content using the \[GraphQL Admin API]\(/docs/api/admin-graphql).
##### jsx
```jsx
export default async () => {
const catalogId = shopify.data.selected[0].id;
try {
// Fetch catalog product count
const {data} = await shopify.query(
`
query GetCatalog($id: ID!) {
catalog(id: $id) {
products(first: 1) {
edges {
node {
id
}
}
}
}
}
`,
{variables: {id: catalogId}}
);
const hasProducts = data.catalog.products.edges.length > 0;
// Only show action for catalogs with products
return {display: hasProducts};
} catch (err) {
console.error('Error fetching catalog:', err);
return {display: false};
}
};
```
### Catalog details block target
`admin.catalog-details.block.render`
Renders an admin block extension inline on the catalog details page. Use this target to display contextual information, analytics, or status updates related to the catalog without requiring merchants to open a modal.
Extensions at this target appear as cards on the page and can show real-time data, insights, or quick actions. Blocks provide persistent visibility and are ideal for displaying information merchants need to see at a glance.
### Support Components (46) APIs (1)
### Supported components
* [Admin block](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/settings-and-templates/admin-block)
* [Avatar](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/avatar)
* [Badge](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/badge)
* [Banner](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/banner)
* [Box](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/box)
* [Button](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/button)
* [Button group](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/button-group)
* [Checkbox](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/checkbox)
* [Chip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/chip)
* [Choice list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/choice-list)
* [Clickable](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/clickable)
* [Clickable chip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/clickable-chip)
* [Color field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/color-field)
* [Color picker](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/color-picker)
* [Date field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/date-field)
* [Date picker](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/date-picker)
* [Divider](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/divider)
* [Drop zone](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/drop-zone)
* [Email field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/email-field)
* [Form](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/form)
* [Grid](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/grid)
* [Heading](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/heading)
* [Icon](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/icon)
* [Image](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/image)
* [Link](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/link)
* [Menu](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/actions/menu)
* [Money field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/money-field)
* [Number field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/number-field)
* [Ordered list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/ordered-list)
* [Paragraph](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/paragraph)
* [Password field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/password-field)
* [Query container](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/query-container)
* [Search field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/search-field)
* [Section](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/section)
* [Select](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/select)
* [Spinner](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/feedback-and-status-indicators/spinner)
* [Stack](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/stack)
* [Switch](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/switch)
* [Table](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/table)
* [Text](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/text)
* [Text area](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/text-area)
* [Text field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/text-field)
* [Thumbnail](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/media-and-visuals/thumbnail)
* [Tooltip](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/typography-and-content/tooltip)
* [Url field](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/forms/url-field)
* [Unordered list](https://shopify.dev/docs/api/admin-extensions/2025-10/web-components/layout-and-structure/unordered-list)
### Available APIs
* [Block Extension API](https://shopify.dev/docs/api/admin-extensions/2025-10/target-apis/core-apis/block-extension-api)
Examples
### Examples
* ####
##### Description
Create a block extension that shows key performance metrics for the catalog, such as product count, total value, and buyer associations. This example demonstrates how to present valuable insights inline on the page.
##### jsx
```jsx
import {render} from 'preact';
import {useState, useEffect} from 'preact/hooks';
export default async () => {
render(, document.body);
};
const Extension = () => {
const [metrics, setMetrics] = useState(null);
const [loading, setLoading] = useState(true);
useEffect(() => {
const fetchMetrics = async () => {
const catalogId = shopify.data.selected[0].id;
try {
// Fetch metrics from your app's backend
const response = await fetch(
`https://your-app.com/api/catalog-metrics?id=${catalogId}`
);
const data = await response.json();
setMetrics(data);
} catch (err) {
console.error('Error fetching metrics:', err);
} finally {
setLoading(false);
}
};
fetchMetrics();
}, []);
if (loading) {
return (
Loading metrics...
);
}
if (!metrics) {
return (
Unable to load metrics
);
}
return (
Product Count
{metrics.productCount}
products
Total Catalog Value
${metrics.totalValue.toLocaleString()}
Buyer Associations
{metrics.companyCount} companies
{metrics.locationCount} locations
Last Sync
{metrics.lastSync}
);
};
```
* ####
##### Description
Create a block extension that shows real-time validation results for catalog pricing rules. This example demonstrates how to highlight pricing issues that need merchant attention.
##### jsx
```jsx
import {render} from 'preact';
import {useState, useEffect} from 'preact/hooks';
export default async () => {
render(, document.body);
};
const Extension = () => {
const [validation, setValidation] = useState(null);
const [loading, setLoading] = useState(true);
useEffect(() => {
const fetchValidation = async () => {
const catalogId = shopify.data.selected[0].id;
try {
// Fetch validation results from your app's backend
const response = await fetch(
`https://your-app.com/api/validate-pricing?catalogId=${catalogId}`
);
const data = await response.json();
setValidation(data);
} catch (err) {
console.error('Error fetching validation:', err);
} finally {
setLoading(false);
}
};
fetchValidation();
}, []);
if (loading) {
return (
);
}
if (!validation) {
return (
Unable to load validation results
);
}
const hasIssues = validation.errors.length > 0 || validation.warnings.length > 0;
return (
{!hasIssues && (
All pricing rules are valid
)}
{validation.errors.length > 0 && (
{validation.errors.length} pricing errors found
{validation.errors.map((error, index) => (
{error.product}
{error.message}
))}
)}
{validation.warnings.length > 0 && (
{validation.warnings.length} pricing warnings
{validation.warnings.map((warning, index) => (
{warning.product}
{warning.message}
))}
)}
shopify.navigation.navigate('extension://validate-pricing-action')}
variant="secondary"
>
View Detailed Report
);
};
```
***
## Best practices
* **Focus on B2B workflows:** [Catalogs](https://shopify.dev/docs/apps/build/b2b) are primarily used for B2B commerce, so design your extensions to support wholesale pricing, bulk operations, and company-specific product offerings that align with B2B merchant needs.
* **Handle large product sets with pagination:** Catalogs can contain thousands of products. When fetching catalog data, use [cursor-based pagination](https://shopify.dev/docs/api/usage/pagination-graphql) to stay within the [GraphQL query cost limits](https://shopify.dev/docs/api/usage/rate-limits). For exports of catalogs with 500+ products, process them as background jobs rather than synchronous operations.
* **Validate pricing rules:** When displaying or manipulating catalog pricing, validate that custom pricing rules don't conflict with base prices.
* **Show buyer context:** Display information about which companies or locations have access to the catalog to help merchants understand the reach and impact of their pricing changes.
* **Consider price list inheritance:** Catalog pricing is generated from [price lists](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) that have context rules (markets, buyer tags, company locations). When displaying prices, show which rule determined the price to help merchants troubleshoot unexpected pricing.
***
## Limitations
* **Single target per module:** Each `[[extensions.targeting]]` entry in your [TOML configuration](https://shopify.dev/docs/api/admin-extensions/2025-10#configuration) maps one target to one module file.
* **Price list pagination:** The catalog price lists query returns a [maximum of 250](https://shopify.dev/docs/api/usage/pagination-graphql) entries per request.
* **Block target visibility:** Block extensions must be manually [added and pinned](https://help.shopify.com/manual/apps/working-with-apps#add-app-blocks-to-your-shopify-admin) by merchants before they appear.
* **Block collapse behavior:** Returning `null` from a block extension collapses the block rather than removing it from the page. Blocks can't be fully hidden at runtime.
***