BigCommerce

Returns a list of *Brands*. Optional filter parameters can be passed in.

Get All Brands

Creates a *Brand*.

**Required Fields**
- name

**Read-Only Fields**
- id

**Limits**
- 30,000 brands per store limit

Create a Brand

To delete brand objects, you must include a filter.

**Required Fields**
 - name

Delete Brands

Returns a single *Brand*. Optional filter parameters can be passed in.

Get a Brand

Updates a *Brand*.

**Required Fields**
- None

**Read-Only Fields**
- id

To update a *Brand Image*, send a request with an `image_url`.

Update a Brand

Delete a Brand

Returns a list of *Brand Metafields*. Optional filter parameters can be passed in. 

Get All Brand Metafields

Creates a *Brand Metafield*.

**Required Fields**
- permission_set
- namespace
- key
- value

**Read-Only Fields**
- id

**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.

Create a Brand Metafield

Returns a *Brand Metafield*. Optional filter parameters can be passed in.

Get a Brand Metafields

Updates a *Brand Metafield*.

**Required Fields**  
* none

**Read-Only Fields**
* id
* These fields can only be modified by the app (API credentials) that created the metafield:
	* namespace
	* key
	* permission_set

**Usage Notes**
* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message.
* The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.

Update a Brand Metafield

Delete a Brand Metafield

Creates a *Brand Image*.

**Required Fields**
- image_file: Form posts are the only accepted upload option.

**Read-Only Fields**
- id

Only one image at a time can be created. To update a *Brand Image*, use the [Update a brand](/docs/rest-catalog/brands#update-a-brand) endpoint and an `image_url`.

Create a Brand Image

Delete a Brand Image

When possible, use the [Catalog Trees - Get all categories](/docs/rest-catalog/category-trees/categories#get-all-categories) endpoint instead.

Returns a list of *Categories*. Optional filter parameters can be passed in.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.

Get All Categories

When possible, use the [Category Trees - Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint instead.

Creates a *Category*.

Use this endpoint when an API only works with categories of a default BigCommerce storefront (`channel_id=1`). 

Use the [Create categories](/docs/rest-catalog/category-trees/categories#create-categories) endpoint when an API works with categories across different category trees that belong to different storefront channels.

**Required Fields**:
- `parent_id`: 
	- To create a child category, set the `parent_id` to the parent category.
	- To create a top level category, set the `parent_id` to `0`.
- `name`

**Read-Only Fields**:
- `id`

**Limits**:
- 16,000 categories per store limit.
- 1,000 categories per product limit.
- 50 characters category name length.
- 8 levels of category depth limit.
- 65,642 characters category description length limit.

 **Note:**
 The default rate limit for this endpoint is 40 concurrent requests.


Create a Category

When possible, use the [Category Trees - Delete categories](/docs/rest-catalog/category-trees/categories#delete-categories) endpoint instead.

Deletes *Category* objects. At least one filter parameter is required to perform the `DELETE` operation.

**Usage Notes**

- Sending a `DELETE`request without specifying a filter parameter will result in a `422` error. 
- Sending a `DELETE` request for a category that contains products will result in a `422` error. Move products to a new category by sending a `PUT` request to the `/catalog/products/{product_id}` endpoint before deleting a category.

Delete Categories

When possible, use the [Catalog Trees - Get all categories](/docs/rest-catalog/category-trees/categories#get-all-categories) endpoint instead. You can provide a category identifier using query parameters to retrieve a single category.

Returns a single *Category*. Optional parameters can be passed in.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.

Get a Category

When possible, use the [Catalog Trees - Update categories](/docs/rest-catalog/category-trees/categories#update-categories) endpoint instead.

Updates a *Category*.

**Required Fields**
* none

**Read-Only Fields**
- id

**Note:** 
The default rate limit for this endpoint is 40 concurrent requests.

Update a Category

When possible, use the [Category Trees - Delete categories](/docs/rest-catalog/category-trees/categories#delete-categories) endpoint instead. You can provide a category identifier using query parameters to delete a single category.

Deletes a *Category*.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.

Delete a Category

Returns a list of *Metafields* on a *Category*. Optional filter parameters can be passed in.

Create a Category Metafield

Returns a single *Category Metafield*. Optional parameters can be passed in.

Update a Category Metafield

Delete a Category Metafield

Create a *Category Image*.

 **Required Fields**
- image_file: Form posts are the only accepted upload option.

Only one image at a time can be created.
Limit image size to 1MB.
To update a *Category Image*, use the [Update categories](/docs/rest-catalog/category-trees/categories#update-categories) endpoint and an `image_url`.

Create a Category Image

Delete a Category Image

Returns a list of products and their sort order for a specific category.

**Usage Notes**
* Data pairs are displayed in ascending order based on products' `sort_order` values.
* `null` values are allowed for products without specified `sort_order` values.
* Products with `sort_order` value of `null` will be displayed after products with valid numerical values.
* The priorities for determining product sort order on a storefront are the following:
  - Priority 1: Manually specified sort order on Category Level (API).
  - Priority 2: Manually specified sort order on Product (Global) Level (UI/API).
  - Priority 3: Default sorting by Product ID (newly added products go first) (UI/API).

Get Product Sort Order

Updates sort order of products within a specific category.

Update Product Sort Order

Returns a list of all *Product Modifiers*. Optional parameters can be passed in.

Get All Product Modifiers

Creates a *Product Modifier*.

**Required Fields**
* `required`
* `display_name`
* `type`

**Read-Only Fields**
* `id`

**Notes**
It takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values.

Create a Product Modifier

Returns a single *Product Modifier*. Optional parameters can be passed in.

Get a Product Modifier

Update a Product Modifier

Delete a Product Modifier

Returns a list of all product *Modifier Values*. Optional parameters can be passed in.

Get All Product Modifier Values

Creates a *Modifier Value*.

**Required Fields**
* label
* sort_order

**Read-Only Fields**
* id

Create Product Modifier Value

Returns a single *Modifier Value*. Optional parameters can be passed in.

Get a Product Modifier Value

Updates a *Modifier Value*.

**Required Fields**
* none

**Read-Only Fields**
* id

Update a Product Modifier Value

Delete Product Modifier Value

Creates a *Modifier Image*.

The image will show on the storefront when the value is selected.

 **Required Fields**
- image_file: Form posts are the only accepted upload option.

Create Product Modifier Image

Returns a list of product *Variant Options*. Optional parameters can be passed in. 

Get All Product Variant Options

Creates a *Variant Option*.

**Required Fields**
* display_name
* type
* option_values

**Read-Only Fields**
* id

**Limits**
* 255 characters option name length.

**Notes**

* Only one variant option at a time can be created; individual variant options will contain an array of multiple values.
* There are several examples listed below that create options, but the SKUs are not updated and they are not a variant on the product. Variant SKUs must be created with a separate request.
* Variant options will show on the storefront as an option that can be selected by the customer. A request like this could be used to add new choices to a variant that has already been created.
* If more than one variant needs to be created, use the [Create a Product](/docs/rest-catalog/products#create-a-product) endpoint.

Create a Product Variant Option

Returns a single *Variant Option*. Optional parameters can be passed in.

Get a Product Variant Option

Updates a *Variant Option*.

**Read-Only Fields**
* id

Update a Product Variant Option

Delete a Product Variant Option

Returns a list of all *Variant Option Values*. Optional parameters can be passed in.

Get All Product Variant Option Values

Creates a *Variant Option Value*.

**Required Fields**
* label
* sort_order

**Read-Only Fields**
* id

**Limits**
* 250 option values per option limit.

Create a Product Variant Option Value

Returns a single *Variant Option Value*. Optional parameters can be passed in.

Get a Product Variant Option Value

Updates a *Variant Option Value*.

**Read-Only Fields**
* id

Update a Product Variant Option Value

Delete a Product Variant Option Value

Returns a list of product *Variants*. Optional parameters can be passed in.

Get All Product Variants

Creates a *Product Variant*.

**Required Fields**
* sku
* option_values

**Read-Only Fields**
* id

**Limits**
* 600 SKUs per product limit.
* 255 characters SKU length limit.

Variants need to be created one at a time using this endpoint. To use a variant array and create products and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) during the initial product creation.

Create a Product Variant

Returns a single product *Variant*. Optional parameters can be passed in.

Get a Product Variant

Update a Product Variant

Delete a Product Variant

Returns a list of product variant *Metafields*. Optional parameters can be passed in.

Get All Product Variant Metafields

Creates a product variant *Metafield*.

**Required Fields:**
* permission_set
* namespace
* key
* value

**Read-Only Fields**
* id

**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.

Create a Product Variant Metafield

Returns a single product variant *Metafield*. Optional parameters can be passed in.

Get a Product Variant Metafields

Updates a product variant *Metafield*.

**Required Fields:**
* none

**Read-Only Fields**
* id
* These fields can only be modified by the app (API credentials) that created the metafield:
	* namespace
	* key
	* permission_set

**Usage Notes**
* Attempting to modify `namespace`, `key`, and `permission_set` fields using a client ID different from the one used to create those metafields will result in a 403 error message. 

Update Product Variant Metafields

Delete a Product Variant Metafield

Creates a *Variant Image*.

Only one image can be explicitly associated with a Variant. If the Variant already has an associated image, overwrites the existing Variant Image.

The image displays on the storefront when the Variant is selected.

 **Required Fields**
- image_file: Form posts. Files larger than 1 MB are not accepted
- image_url: Any publicly available URL

Create a Product Variant Image

Returns a list of all variants in your catalog. Optional parameters can be passed in.

Get All Variants

Updates a batch of `variant` objects. Currently the limit is 50 variants however this is subject to change.

**Required Fields**

To update an existing variant:
* id (variant id)

To create a new variant:
* product_id
* sku
* option_values
  - id (option_value ID - Example: 146)
  - option_id (Option ID - Example: 151)

Update Variants (Batch)

Returns a list of **Products**. Optional filter parameters can be passed in.

Get All Products

Updates products in batches. Batches are limited to 10 products.

**Required Fields**
* `id` - product `id` is required for batch updates to products.

**Read-Only Fields**
- `id`
- `date_created`
- `date_modified`
- `calculated_price`
- `base_variant_id`

Update Products (Batch)

Creates a *Product*. Only one product can be created at a time; however, you can create multiple product variants using the `variants` array.

**Required Fields:**
- `name`
- `type`
- `weight`
- `price`

**Read-Only Fields**
- `id`
- `date_created`
- `date_modified`
- `calculated_price`
- `base_variant_id`

**Limits**
- 250 characters product name length.
- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.

**Usage Notes**
* You can create multiple product variants using the `variants` array.
* This endpoint accepts a `video` array. To create a product video that accepts a `video` object, see [Create a Product Video](/docs/rest-catalog/products/videos#create-a-product-video) for information.

Create a Product

To delete *Product* objects, you must include a filter. This prevents inadvertently deleting all *Product* objects in a store.

> #### Note
> The maximum number of products you can delete at one time is 250.

**Example**:
To delete products with the id's of 1,2 and 3, use `DELETE /v3/catalog/products?id:in=1,2,3`.

Delete Products

Returns a single *Product*. Optional parameters can be passed in.

Get a Product

Updates a *Product*.

**Limits**
- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.

**Read-Only Fields**
- id
- date_created
- date_modified
- calculated_price
- base_variant_id


Update a Product

Delete a Product

Returns a list of *Product Images*. Optional parameters can be passed in.

Get All Product Images

Creates a *Product Image*.

 **Required Fields**
- `image_file`, or
- `image_url`

**Usage Notes**
- `image_url` - `255` character limit
- For file uploads, use the `multipart/form-data` media type.
- You can create only one image at a time. A product can have up to 1000 images.
- Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP.
- Each image file or image uploaded by URL can be up to 8 MB.

Create a Product Image

Returns a single *Product Image*. Optional parameters can be passed in.

Get a Product Image

Updates a *Product Image*.

**Usage Notes**
- `image_url` - `255` character limit
- Each image file or image uploaded by URL can be up to 8 MB.
- For file uploads, send a POST request using the `multipart/form-data` media type

Update a Product Image

Delete a Product Image

Returns a list of *Product Videos*. Optional parameters can be passed in.

Get All Product Videos

Creates a *Product Video*.

**Required Fields**
* video_id

**Read-Only Fields**
* id

Publicly accessible URLs are valid parameters.
Videos must be loaded through YouTube at this time.

Create a Product Video

Returns a single *Product Video*. Optional parameters can be passed in.

Get a Product Video

Updates a *Product Video.

**Required Fields**
* none

**Read-Only Fields**
* id

Update a Product Video

Delete a Product Video

Returns a list of all product *Complex Rules*. Optional parameters may be passed in.

Get Complex Rules

Creates a product *Complex Rule*.

**Required Fields**
- modifier_id
- modifier_value_id
- variant_id

**Read-Only Fields**
- complex_rule_id
- conditions_id
- rule_id
- combination_id
- id

Create a Complex Rule

Returns a single *Complex Rule*. Optional parameters can be passed in.

Get a Product Complex Rule

Updates a *Complex Rule*.

**Required Fields**:
- none

**Read-Only Fields**:
- complex_rule_id
- conditions_id
- rule_id
- combination_id
- id

Update a Product Complex Rule

Delete a Product Complex Rule

Returns a list of product *Custom Fields*. Optional parameters can be passed in.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.

Get Product Custom Fields

Creates a *Custom Field*.

**Required Fields:**
- name
- value

**Read-Only:**
- id

**Limits**
- 200 custom fields per product limit.
- 255 characters per custom field limit.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests. 

Create a Product Custom Field

Returns a single *Custom Field*. Optional parameters can be passed in.

Get a Product Custom Field

Updates a *Custom Field*.

**Required Fields**
- none

**Read-Only**
- id

Update a Product Custom Field

Deletes a product *Custom Field*.

**Note:**
The default rate limit for this endpoint is 40 concurrent requests.

Delete a Product Custom Field

Returns a list of *Bulk Pricing Rules*. Optional parameters can be passed in.

Get All Bulk Pricing Rules

Creates a *Bulk Pricing Rule*.

**Required Fields**
- quantity_min
- quantity_max
- type
- amount

**Read-Only Fields**
- id

**Limits**
- 50 bulk pricing rule per product limit.

Create a Bulk Pricing Rule

Returns a single *Bulk Pricing Rule*. Optional parameters can be passed in.

Get a Bulk Pricing Rule

Updates a *Bulk Pricing Rule*.

**Required Fields**
* none

**Read-Only Fields**
- id

Update a Bulk Pricing Rule

Delete a Bulk Pricing Rule

Returns a list of *Product Metafields*. Optional parameters can be passed in.

Get All Product Metafields

Creates a *Product Metafield*.

**Required Fields:**
* permission_set
* namespace
* key
* value

**Note:** The maxiumum number of metafields allowed on each order, product, category, variant, or brand is 250 per client ID. For more information, see [Platform Limits](https://support.bigcommerce.com/s/article/Platform-Limits) in the Help Center.

Create a Product Metafield

Returns a single *Product Metafield*. Optional parameters can be passed in.

Get a Product Metafield

Updates a *Product Metafield*.

**Required Fields**
* none

**Read-Only Fields**
* id
* These fields can only be modified using the API account that created the metafield:
	* `namespace`
	* `key`
	* `permission_set`
	* `value`

**Usage Notes**
* Attempting to modify the `namespace`, `key`, `permission_set`, or `value` field using an API account different from the one used to create those metafields will result in a `403` error message. 

Update a Product Metafield

Delete a Product Metafield

Returns a list of all *Product Reviews*. Optional parameters can be passed in.

Get Product Reviews

Salesforce

Zoho CRM

Pipedrive

Quickbooks

Xero

Sage Accounting

Shopify

Zoho Books

Stripe

Freshdesk

Woocommerce

Exact Online

Chargebee

PayPal

Ontraport

Lightspeed R-Series

# Continuous Import of Products to Your App

This scenario enables your application to continuously sync Products from any external application to your app's API. It handles the initial import of Products and keeps them synchronized when a Product is created, updated, or deleted in the external application.

When receiving Products data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Products to my App

Import Products and receive created/updated or deleted events

BigCommerce API Integration Profile

Configuration

Create and set up the BigCommerce App

Configure the app parameters in the integration.app platform

Testing

Build every single integration your customers need with AI