dotCMS BigCommerce Connector (prototype)

Self-contained OSGi bundle that mirrors the Shopify connector shape: App YAML, asset install under /application/bigcommerce/, REST proxy, Velocity viewtool $dotbigcommerce, and two content types (dotBigCommerceProduct, dotBigCommerceCollection / category widget).

Build

From repository root:

./mvnw clean package -DskipTests

Install the JAR from target/bigcommerce-25.10.05.jar via dotCMS Plugins (same pattern as other OSGi bundles).

Configure

1. In BigCommerce, create a Storefront GraphQL private token (server-to-server). Do not use a browser storefront token for this plugin.
2. In dotCMS Apps, open BigCommerce Connector and set store hash and private token. Optional channel id maps to X-Bc-Channel-Id on GraphQL requests.

REST (authenticated like other dotCMS APIs)

• GET /api/v1/bigcommerce/product/?id={entityId}
• GET /api/v1/bigcommerce/product/_search?query=...&limit=...&cursor=...
• POST /api/v1/bigcommerce/product/_gql with JSON { "query": "...", "variables": { ... } }
• GET /api/v1/bigcommerce/product/test — smoke test
• GET /api/v1/bigcommerce/category/?id={entityId}
• GET /api/v1/bigcommerce/category/_search?query=... — name/path filter over a shallow categoryTree query (MVP)

Velocity

$dotbigcommerce.getProduct("123"), searchProducts("term", 20), getCategoryById("24"), gql(query, map).

GraphQL queries

Bundled under src/main/resources/application/bigcommerce/gql/. Adjust fields to match your BigCommerce Storefront schema version if queries fail at runtime.

Notes

• This repo is standalone (split out from the dotCMS Shopify connector sample repo).
• Category “collection” in the CMS maps to BigCommerce categories (entity id).
• Pickers and example VTL were adapted from the Shopify plugin; validate against a real store.