From 8aac0e1b585279161aee849805739983bbd32b87 Mon Sep 17 00:00:00 2001 From: Kristina Pototska Date: Thu, 18 Dec 2025 16:03:36 +0000 Subject: [PATCH 1/4] docs: Add CATEGORIES support to App Extensions documentation - Add CATEGORIES model to glossary with both View Categories and Edit Category page support - Update limits callout to include categories - Add View Categories and Edit Category use case section - Add CATEGORIES example to query response in guide JIRA: CATALOG-11279 --- docs/integrations/apps/app-extensions/glossary.mdx | 3 ++- docs/integrations/apps/app-extensions/guide.mdx | 7 +++++++ docs/integrations/apps/app-extensions/index.mdx | 11 ++++++++++- 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/integrations/apps/app-extensions/glossary.mdx b/docs/integrations/apps/app-extensions/glossary.mdx index 1e660b625..b604383f3 100644 --- a/docs/integrations/apps/app-extensions/glossary.mdx +++ b/docs/integrations/apps/app-extensions/glossary.mdx @@ -13,7 +13,7 @@ An App Extension's **context** describes the control panel location where the Ex ## Model -An App Extension's **model** describes the control panel view it extends. Currently, App Extensions apply to the **View All** page of an API entity. There are currently three possible models: +An App Extension's **model** describes the control panel view it extends. Currently, App Extensions apply to the **View All** page of an API entity. There are currently multiple possible models: | Enum | Description | |:-----|:------------| @@ -21,6 +21,7 @@ An App Extension's **model** describes the control panel view it extends. Curren | `PRODUCT_DESCRIPTION` | App Extension menu items render in the **Action** menu within Description section on the **[Edit a Product](https://login.bigcommerce.com/deep-links/manage/products/edit)** page. | | `ORDERS` | App Extension menu items render in the **Action** menu for each order on the **[View Orders](https://login.bigcommerce.com/deep-links/manage/orders)** page. | | `CUSTOMERS` | App Extension menu items render in the **Action** menu for each customer on the **[View Customers](https://login.bigcommerce.com/deep-links/manage/customers)** page. | +| `CATEGORIES` | App Extension menu items render in the **Action** menu for each category on the **[View Categories](https://login.bigcommerce.com/deep-links/manage/catalog/categories)** page and on the **[Edit Category](https://login.bigcommerce.com/deep-links/manage/catalog/categories/edit)** page. | ## Label diff --git a/docs/integrations/apps/app-extensions/guide.mdx b/docs/integrations/apps/app-extensions/guide.mdx index f1c8cd19f..3214399cc 100644 --- a/docs/integrations/apps/app-extensions/guide.mdx +++ b/docs/integrations/apps/app-extensions/guide.mdx @@ -315,6 +315,13 @@ The [Store appExtensions](/graphql-admin/reference#query-store) query returns a "url": "/customers/${id}/interactions", "model": "CUSTOMERS" } + }, + { + "node": { + "id": "bc/store/appExtension/3", + "url": "/categories/${id}/analytics", + "model": "CATEGORIES" + } } ] } diff --git a/docs/integrations/apps/app-extensions/index.mdx b/docs/integrations/apps/app-extensions/index.mdx index d468883d3..c1afe601c 100644 --- a/docs/integrations/apps/app-extensions/index.mdx +++ b/docs/integrations/apps/app-extensions/index.mdx @@ -216,7 +216,7 @@ Each App Extension is associated with one control panel page, which you define u For supported models, see the [App Extensions Glossary](/docs/integrations/apps/app-extensions/glossary) and the [GraphQL Admin API Reference](/graphql-admin/reference). - There is a **limit** of two App Extensions per app, per [model](/docs/integrations/apps/app-extensions/glossary#model). Your app can register up to two App Extensions for the orders model, two for the products model, and two for customers. If these limits are detrimental to your use case or user experience, please reach out through our [Developer Community](/community). + There is a **limit** of two App Extensions per app, per [model](/docs/integrations/apps/app-extensions/glossary#model). Your app can register up to two App Extensions for the orders model, two for the products model, two for customers, and two for categories. If these limits are detrimental to your use case or user experience, please reach out through our [Developer Community](/community). @@ -253,6 +253,15 @@ The App Extensions feature unlocks new use cases. The following sections organiz * Expose the whole product object, including metafields, for control panel users to view and edit. * Expose a third-party product configurator that uses an ERP or PIM system as the source of truth, then use the Catalog API to sync with BigCommerce and resolve any errors. +### View Categories and Edit Category + +* Manage category hierarchy and relationships in a custom interface. +* Expose the whole category object, including metafields, for control panel users to view and edit. +* Sync category data with a third-party PIM or CMS system, then use the Catalog API to sync with BigCommerce and resolve any errors. +* Provide category-specific analytics or insights from external systems. +* Add bulk operations to category rows on the list page. +* Extend category editing workflows with custom tools on the edit page. + ## Using App Extensions in public apps Public apps that use App Extensions have the following additional requirements for approval: From 6ae48c9e4c3f9fe0c0a3ed110c38a411133ee111 Mon Sep 17 00:00:00 2001 From: Kristina Pototska Date: Thu, 18 Dec 2025 16:08:50 +0000 Subject: [PATCH 2/4] fix: Update CATEGORIES deep link and remove Edit Category link - Change View Categories deep link from /manage/catalog/categories to /manage/products/categories - Remove Edit Category deep link as it requires dynamic category and tree IDs --- docs/integrations/apps/app-extensions/glossary.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/apps/app-extensions/glossary.mdx b/docs/integrations/apps/app-extensions/glossary.mdx index b604383f3..9f2914bc0 100644 --- a/docs/integrations/apps/app-extensions/glossary.mdx +++ b/docs/integrations/apps/app-extensions/glossary.mdx @@ -21,7 +21,7 @@ An App Extension's **model** describes the control panel view it extends. Curren | `PRODUCT_DESCRIPTION` | App Extension menu items render in the **Action** menu within Description section on the **[Edit a Product](https://login.bigcommerce.com/deep-links/manage/products/edit)** page. | | `ORDERS` | App Extension menu items render in the **Action** menu for each order on the **[View Orders](https://login.bigcommerce.com/deep-links/manage/orders)** page. | | `CUSTOMERS` | App Extension menu items render in the **Action** menu for each customer on the **[View Customers](https://login.bigcommerce.com/deep-links/manage/customers)** page. | -| `CATEGORIES` | App Extension menu items render in the **Action** menu for each category on the **[View Categories](https://login.bigcommerce.com/deep-links/manage/catalog/categories)** page and on the **[Edit Category](https://login.bigcommerce.com/deep-links/manage/catalog/categories/edit)** page. | +| `CATEGORIES` | App Extension menu items render in the **Action** menu for each category on the **[View Categories](https://login.bigcommerce.com/deep-links/manage/products/categories)** page and on the Edit Category page. | ## Label From 69412822620b73d9f7cc4918964a2536169a1e7d Mon Sep 17 00:00:00 2001 From: Kristina Pototska Date: Thu, 18 Dec 2025 16:10:59 +0000 Subject: [PATCH 3/4] fix: Update CATEGORIES example URL to match PR implementation - Change URL from /categories/${id}/analytics to /categories/${id} to match examples in implementation PRs --- docs/integrations/apps/app-extensions/guide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/apps/app-extensions/guide.mdx b/docs/integrations/apps/app-extensions/guide.mdx index 3214399cc..00bfa7515 100644 --- a/docs/integrations/apps/app-extensions/guide.mdx +++ b/docs/integrations/apps/app-extensions/guide.mdx @@ -319,7 +319,7 @@ The [Store appExtensions](/graphql-admin/reference#query-store) query returns a { "node": { "id": "bc/store/appExtension/3", - "url": "/categories/${id}/analytics", + "url": "/categories/${id}", "model": "CATEGORIES" } } From fb3dc3402205f8536cbae7dc488c67c4f3f3d77e Mon Sep 17 00:00:00 2001 From: Kristina Pototska Date: Thu, 18 Dec 2025 16:15:06 +0000 Subject: [PATCH 4/4] fix: Use correct appExtension ID (4) for CATEGORIES example Based on test data from api-proxy-java PR 3742 which uses appExtension4 with ID 4 for CATEGORIES model --- docs/integrations/apps/app-extensions/guide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/apps/app-extensions/guide.mdx b/docs/integrations/apps/app-extensions/guide.mdx index 00bfa7515..e02885d5a 100644 --- a/docs/integrations/apps/app-extensions/guide.mdx +++ b/docs/integrations/apps/app-extensions/guide.mdx @@ -318,7 +318,7 @@ The [Store appExtensions](/graphql-admin/reference#query-store) query returns a }, { "node": { - "id": "bc/store/appExtension/3", + "id": "bc/store/appExtension/4", "url": "/categories/${id}", "model": "CATEGORIES" }