canonical: https://jentic.com/apis/bigcommerce.com/bigcommerce-catalog-api

# Bigcommerce Catalog - Products

The BigCommerce Catalog API manages the product side of a store: it adds and updates products individually or in batches, attaches images and videos, and holds the bulk pricing rules and complex rules that drive what a shopper pays. Products carry custom fields and metafields for structured extra data, can be assigned to categories and sales channels, and expose their customer reviews. It is the product source of truth that a storefront and checkout read from.

## For AI agents

Add and update BigCommerce products in batch, attach images and videos, set bulk and complex pricing rules, manage metafields, and assign products to categories and channels.

## Scope

Does not handle orders, checkout, customers, or payment capture. Use for managing the BigCommerce product catalog and its pricing and media only.

## Capabilities

- Add products to the catalog and update them individually or in batches
- Attach images and videos to a product
- Set bulk pricing rules and complex rules that determine a product's price
- Store custom fields and metafields of structured data on products
- Assign products to categories and sales channels
- Read and moderate the reviews left on a product

## Use cases

### Agent-maintained product catalog

An AI agent keeps a BigCommerce catalog current from an external feed: it creates new products, updates prices and descriptions, and uploads images as the source data changes. Because products support batch updates and structured metafields, the agent can push many changes in one pass and attach the extra attributes a storefront needs without a manual spreadsheet import.

Example prompt: Create a product with a title, price, and description, upload its primary image, and assign it to a category

### Tiered and rule-based pricing

Wholesale and promotional stores need prices that change with quantity or shopper context. The Catalog API sets bulk pricing rules and complex rules on a product, so an agent can apply quantity-break pricing or conditional rules across a product range in response to a promotion, rather than editing each listing by hand.

Example prompt: Create a bulk pricing rule on a product that discounts orders of 10 or more units

### Structured product data for search and channels

Selling across marketplaces needs richer product data than the core fields. Metafields and custom fields store structured attributes on each product, and category and channel assignments control where a product appears, so an agent can enrich listings and publish them to the right sales channels from one place.

Example prompt: Attach a metafield with a material attribute to a product and assign the product to a second sales channel

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/catalog/products` | List all products |
| POST | `/catalog/products` | Create a product |
| PUT | `/catalog/products` | Update products in batch |
| GET | `/catalog/products/{product_id}` | Get a single product |
| POST | `/catalog/products/{product_id}/images` | Add a product image |
| POST | `/catalog/products/{product_id}/bulk-pricing-rules` | Create a bulk pricing rule |
| POST | `/catalog/products/{product_id}/metafields` | Create a product metafield |
| GET | `/catalog/products/{product_id}/reviews` | Get a product's reviews |

## Key resources

- **Products** — Create, update, batch-manage, and delete catalog products
- **Pricing rules** — Bulk pricing rules and complex rules that set a product's price
- **Images and videos** — Media attached to a product listing
- **Metafields and custom fields** — Structured extra attributes stored against products
- **Assignments** — Category and sales-channel assignments for products

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 59 / 100
  - Developer Experience & Jentic Compatibility: 66 / 100
  - AI-Readiness & Agent Experience: 71 / 100
  - Agent Usability: 93 / 100
  - Security: 50 / 100
  - AI Discoverability: 62 / 100
- **View full report:** https://jentic.com/apis/bigcommerce.com/bigcommerce-catalog-api/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the BigCommerce Catalog API by hand means creating a store API account, scoping its X-Auth-Token, and substituting your store hash into every request path. Through Jentic you install once, import it from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The product id travels in the URL path (`/catalog/products/{product_id}`), so a rule can pin your agent to one product, or allow a chosen set of operations. You choose the operations it may call, so product deletion is not included unless you add it.
- **Credential handling:** Your BigCommerce store token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a product' or 'set bulk pricing', and Jentic returns the matching Catalog operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Ecwid** — Ecwid is a hosted storefront platform with its own product catalog rather than BigCommerce's.
- **Shopware** — Shopware is a commerce platform whose API manages products for Shopware-hosted stores.
- **Square** — Square handles checkout and payments for the products this catalog defines.

## FAQ

### What authentication does the BigCommerce Catalog API use?

The BigCommerce Catalog API authenticates with a store API account token sent in the X-Auth-Token header, as declared in its OpenAPI spec, and each token carries the OAuth scopes it was granted. Through Jentic the token is stored encrypted by your own Jentic One instance and injected when a call runs, so it never reaches the agent's prompt or logs.

### Can I set quantity-based pricing on a product with this API?

Yes. The Catalog API creates bulk pricing rules on a product for quantity breaks and supports complex rules for conditional pricing, so an agent can apply wholesale or promotional pricing across the catalog.

### What are the rate limits for the BigCommerce Catalog API?

The OpenAPI spec does not state rate limits. BigCommerce enforces per-plan API quotas documented on its developer portal at developer.bigcommerce.com, so check there before running large batch product updates.

### Is there a BigCommerce Catalog MCP server?

You do not need an MCP server to give your agent the BigCommerce Catalog API. Jentic connects it directly from the API Directory: import it, store your store token once, and your agent creates and updates products on demand.

### Can I limit what my agent is allowed to do with the BigCommerce Catalog API?

Yes. The product id travels in the URL path, so a rule can pin the agent to one product, or you can allow only the product read operations so the agent can list and inspect products but cannot delete them or rewrite pricing, with every call logged.

### How do I add a product with this API through Jentic?

Search Jentic for an intent like 'create a BigCommerce product' and it returns the matching operation with its input schema, then your agent calls it with the store token Jentic injects at runtime. To run it on your own infrastructure, install Jentic One from its GitHub repo.
