Catalog Overview

The Catalog refers to a store’s collection of physical and digital products. The Catalog includes all the information about a product such as MPN, warranty, price, and images.

OAuth Scopes

UI Name Permission Parameter
Products modify store_v2_products
Products read-only store_v2_products_read_only

For more information on OAuth Scopes and authentication, see: Authentication.

Products Overview

Products are the primary catalog entity, and the primary function of the eCommerce platform is to sell products on the storefront, and other channels.

Products can be physical or digital:

  • Physical - exist in a physical form, have a weight, and are sold by merchants with intent to ship to customers.
  • Digital - Non-physical products including downloadable files such as computer software, ebooks, music, images, and other media; and services such as haircuts, consulting, or lawn care.

Note

  • Only one Product can be created at a time.

Creating a Product

Below is an example POST request for creating a simple product without options, modifiers, or variants:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "name": "BigCommerce Coffee Mug",
  "price": "10.00",
  "categories": [
    23,
    21
  ],
  "weight": 4,
  "type": "physical"
}

Open in Request Runner

Creating Products with Options

To create a complex product with options selectable by shoppers, include a variants array in the request body:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "name": "BigCommerce Coffee Mug",
  "price": "10.00",
  "categories": [
    23,
    21
  ],
  "weight": 4,
  "type": "physical",
  "variants": [
    {
      "sku": "SKU-BLU",
      "option_values": [
        {
          "option_display_name": "Mug Color",
          "label": "Blue"
        }
      ]
    },
    {
      "sku": "SKU-GRAY",
      "option_values": [
        {
          "option_display_name": "Mug Color",
          "label": "Gray"
        }
      ]
    }
  ]
}

Open in Request Runner

Note

  • When options are created via /products, display_type defaults to radio button (displayed as selectable boxes in some themes)

Creating Digital Products

To create a digital product (like an ebook), set type to digital:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "name": "ebook: A Guide to Coffee",
  "price": "10.00",
  "categories": [
    23,
    21
  ],
  "type": "digital",
  "images": [
    {
      "is_thumbnail": true,
      "image_url": "{{image_url}}"
    }
  ]
}

Open in Request Runner

Note

  • Files can only be added to digital products via Control Panel or WebDav – attaching via the API is not supported. Additional settings such as file description and maximum downloads can also be set in the Control Panel.

Pricing Precision

BigCommerce pricing is precise up to 4 decimal places. For example:

  • "$ 10.99999 rounds up to $ 11
  • "$ 10.99994 rounds down to $ 10.9999

Currency display settings allow for more than four decimal places. When this is the case, the additional decimal places will be displayed as 0s.

Adding Product Images

Add a product image to a product with a POST to /v3/catalog/products/{{product_id}}/images:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/images
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "is_thumbnail": true,
  "sort_order": 1,
  "description": "Yellow Large Bath Towel",
  "image_url": "{{image_url}}"
}

Open in Request Runner

Note

  • If using image_file, set Content-Type header to multipart/form-data – otherwise, subsequent requests will be rejected
  • Set is_thumbmail to true to set image as thumbnail used on product listing pages.
  • Only one image can be the product thumbnail at a time
  • If only one image is on the product, it becomes both the thumbnail and the main product image
  • Images can also be added to variants.

Adding Product Videos

Videos hosted on YouTube can be added as a product video via PUT to /v3/catalog/products/{{product_id}}/videos:

PUT https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/videos
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "title": "BigCommerce Mug Video",
  "description": "Video Describing the Mug",
  "sort_order": 1,
  "type": "youtube",
  "video_id": "R12345677"
}

Open in Request Runner

Note

  • A product can have more than one video
  • Product videos must be hosted on YouTube
  • video_id corresponds to the v parameter in the URL (Ex: https://www.youtube.com/watch?v=R12345677)

Adding Custom Fields

To add custom fields to a product, POST to /v3/catalog/products/{{product_id}}/custom-fields:

POST https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/products/{{product_id}}/custom-fields
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "name": "Release Year",
  "value": "2018"
}

Open in Request Runner

Note

  • Custom field values are limited to 250 characters
  • See Custom Fields in the BigCommerce Help Center for additional information on custom fields and their use-cases

Adding Bulk Pricing Rules

Add bulk, quantity-based pricing to products via PUT to /v3/catalog/products/{{product_id}}/bulk-pricing-rules

PUT https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/bulk-pricing-rules
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "bulk_pricing_rules": [
    {
      "quantity_min": 10,
      "quantity_max": 15,
      "type": "price",
      "amount": 3
    },
    {
      "quantity_min": 16,
      "quantity_max": 25,
      "type": "price",
      "amount": 5
    }
  ]
}

Open in Request Runner

For general information and use cases for product bulk pricing, see Bulk Pricing in the BigCommerce Help Center.

Adding Product Metafields

Metafields are key and value pair intended for programmaticly storing data against a product or other entity. Data stored in metafields does not appear in the storefront or the control panel. This is useful for when information needs to be passed back and forth between an app and BigCommerce.

To add metafields to a product, PUT to /v3/catalog/products/{{product_id}}/metafields:

PUT https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/metafields
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "permission_set": "read",
  "namespace": "Location",
  "key": "bin_number",
  "value": "#4456",
  "description": "location of the product",
  "resource_type": "product",
  "resource_id": 131
}

Open in Request Runner

Note

  • Metafields can be added to variants, products, categories, and brands.

Adding Product Reviews

To add product reviews to a product, POST to /v3/catalog/products/{{product_id}}/reviews:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/reviews
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "title": "Great Coffee Mug",
  "text": "This coffee mug kept my liquids hot for several hours.",
  "status": "pending",
  "rating": 5,
  "email": "testing@bigcommerce.com",
  "name": "BigCommerce",
  "date_reviewed": "2018-07-20T17:45:13+00:00"
}

Open in Request Runner

Note

  • Reviews cannot be created in the control panel.

Creating Brands

To create a Brand, POST to /v3/catalog/brands:

POST https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/brands
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "name": "BigCommerce",
  "page_title": "BigCommerce",
  "meta_keywords": [
    "ecommerce",
    "best in class",
    "grow your business"
  ],
  "image_url": "{{image_url}}"
}

Open in Request Runner

For general information on brands and their use cases, see Managing Brands in the BigCommerce Help Center.

Variant Options

Variant options are any choices that the shopper needs to make that will result in the selection of a variant. Color and Size are typical examples of Variant Options. A t-shirt can have different combinations of sizes and colors.

Example:

  • Color is a Variant Option; Red, Orange, and Green are Variant Option Values
  • Size is a Variant Option; Small, Medium, and Large are Variant Option Values

The combination of Small & Red is what is selected on the storefront and correlates to a product variation, also called a SKU.

Variant options:

  • Require the shopper to select a value
  • Only support “multiple choice” option types
  • Rectangle
  • Radio button
  • Color swatch
  • Product pick list
  • Product pick list with images
  • Will automatically generate variants when created in the CP
  • Are auto-generated from variants when a product is created with variants via V3 API Product /POST

Variant Options Example:

If the product is Variant Option
T-Shirt Blue
-
Small
Medium
Large
Backpack Black
Yellow
-
2L
3L
8L

Options created on V2 and V3

  • If a product has options that were created using the V2 API, additional options cannot be added using the V3 API.
  • SKUs in V2 map to variants in V3.
  • Base variants are not SKUs in V2.

Create Variant Option

Creating a variant option does not automatically create SKUs or build out variants. SKUs can be built out later using the variants endpoint.

Create Variant Options

The following request will create options that will show on the storefront as choices that can be selected by the customer. In a separate request, you could build out SKUs based on these variant option values or a combination of variant option values. A request like this could also be used to add new choices to a variant that has already been created.

Example Create Size Variant Option

POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/options
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "product_id": 134,
  "name": "Size Rectangle",
  "display_name": "Size",
  "type": "rectangles",
  "option_values": [
    {
      "label": "S",
      "sort_order": 0,
      "is_default": false
    },
    {
      "label": "M",
      "sort_order": 1,
      "is_default": true
    },
    {
      "label": "L",
      "sort_order": 2,
      "is_default": false
    }
  ]
}

Open in Request Runner

Variant

Variants represent an item as it sits on the shelf in the warehouse or a particular saleable product. A product might be a t-shirt, while the variant would be “a small, red t-shirt”. Variants are selected by shoppers on the storefront via Product Options. In the case where a product is simple, meaning it does not have any options, the product is its own variant - called a base variant. Everything you can buy should be a variant.

  • Options build out variants.
  • Variants are usually what inventory is tracked against
  • Can have their own price, weight, dimensions, image, etc - or they can inherit these values from the product if they have not been specified
  • Must have a SKU code (unless they’re a base variant)
  • In the case of non-base variants, variants will relate to a particular combination of variant option values - such as “small” and “red”

V2 SKU rules will override Variant pricing

Creating SKU rules via the V2 API or via CSV import will alter or override any Variant price or sale price added to a product via the Control Panel, V3 API or Price Lists UI.

Variants:

If the product is Variant Option Variant
T-Shirt Blue
-
Small
Medium
Large
SM-BLU
SM-MED
SM-LARG
Backpack Black
Yellow
-
2L
3L
8L
BLACK-2L
BLACK-3L
BLACK 8L
-
YELLOW-2L
YELLOW-3L
YELLOW-8L

Create a Variant

Variants can be created in two ways:

This will go over using existing variant options to create the variants

To fetch variant information, send a GET request to /v3/catalog/products/{{product_id}}/options:

GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/options
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "data": [
    {
      "id": 193,
      ...
      "option_values": [
        {
          "id": 163,
          "label": "S",
          "sort_order": 0,
          "value_data": null,
          "is_default": false
        },
        ...
      ],
      "config": []
    },
    {
      "id": 194,
      ...
      "option_values": [
        {
          "id": 166,
          "label": "Blue",
          "sort_order": 1,
          "value_data": {
            "colors": [
              "#123C91"
            ]
          },
          ...
      ],
      "config": []
    }
  ],
  "meta": {
    ...
    }
  }
}

Open in Request Runner

In the above response, there are two variant options of size and color with three values each.

To combine the variant option values into variants and build out SKUs use the following endpoint:

https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/products/{{product_id}}/variants

Note

  • Variants need to be created one at a time using this endpoint.
  • Only one variant option at a time can be created; individual variant options will contain an array of multiple values.
  • To use a variant array and create variants in the same call as the base product, use the /catalog/product endpoint during product creation.

The option_values array combines the options Small and Blue to create the SKU SMALL-BLUE. The id in the option_values array is the id from the variant option response option_values > id. The option_id is the id of the option.

{
  "id": 193, //option_id
  "product_id": 134,
  "name": "Size1533313432-134",
  "display_name": "Size",
  "type": "rectangles",
  "sort_order": 0,
  "option_values": [
    {
        "id": 163, //id
        "label": "S",
        "sort_order": 0,
        "value_data": null,
        "is_default": false
    },
    ...
  ]
}

Create a Variant Using the Products Endpoint

The following example creates a base product, variant options, and variants in a single call to the products endpoint. Use this method to create a product and variants in a single call without creating variant options first (option display will default to radio button):

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}


{
  "name": "BigCommerce Coffee Mug",
  "price": "10.00",
  "categories": [
    23,
    21
  ],
  "weight": 4,
  "type": "physical",
  "variants": [
    {
      "sku": "SKU-BLU",
      "option_values": [
        {
          "option_display_name": "Mug Color",
          "label": "Blue"
        }
      ]
    },
    {
      "sku": "SKU-GRAY",
      "option_values": [
        {
          "option_display_name": "Mug Color",
          "label": "Gray"
        }
      ]
    }
  ]
}

Open in Request Runner

Supported Types

Swatch, Radio Buttons, Rectangle, dropdown, Product List and Product List with Images.

Modifier Options

Modifier options are any choices that the shopper can make that will change the way the merchant fulfills the product. Examples include:

  • A checkbox to add shipping insurance
  • Text to be engraved on the product
  • A color that an unfinished product is to be painted before it’s shipped

Critically, the modifier will not change the SKU/variant being fulfilled, and you cannot track inventory against combinations of modifier values. Modifiers typically would not change which product is “picked off the shelf” in the warehouse, but they change what happens to that product before it’s sent to the shopper, or how it’s sent.

Modifier options:

  • May be required or non-required
  • Support all option types
  • Cannot be used as part of a variant

An adjuster can be added to a modifier option to change things such as increasing the price, changing the weight, or shipping rules. Adjusters cannot be applied to all modifier types.

Modifier Options Example:

If the product is Variant Option Variant Modifier
T-Shirt Blue
-
Small
Medium
Large
SM-BLU
SM-MED
SM-LARG
Checkbox
Donate to Charity
Backpack Black
Yellow
-
2L
3L
8L
BLACK-2L
BLACK-3L
BLACK 8L
-
YELLOW-2L
YELLOW-3L
YELLOW-8L
Text Field
Add Embroidery

Modifiers that support Adjusters

Swatch, radio buttons, rectangle list, drop-down, product list, product list with images

Add a modifier with price adjuster to an existing product

The following example shows how to add a modifier, a checkbox with a price adjuster, that will increase the product’s price by five dollars.

Creating a checkbox with an adjuster requires two separate calls: one to create the checkbox and a second to add the adjuster. Adjusters are defined within the option_values array, but option_values are not allowed in the request to create a checkbox modifier because creating a checkbox automatically generates two mandatory option values: a Yes and a No. Once the checkbox has been created along with its option values, you can update the modifier to add an adjuster.

Modifiers that require a second step to add an adjuster

swatch, radio buttons, drop-down, rectangle list, product list, product list with images, and checkbox.

First, a POST to create the modifier:

POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/modifiers
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "type": "checkbox",
  "required": false,
  "config": {
    "default_value": "Yes",
    "checked_by_default": false,
    "checkbox_label": "Check for Donation"
  },
  "display_name": "Add a $5 Donation"
}

Open in Request Runner

Response:

{
  "data": [
    {
      "id": 160,
      "product_id": 131,
      "name": "Add-a-$5-Donation1535039590-191",
      "display_name": "Add a $5 Donation",
      "type": "checkbox",
      "required": false,
      "config": {
        "checkbox_label": "Check for Donation",
        "checked_by_default": false
      },
      "option_values": [
        {
          "id": 149,
          "option_id": 160,
          "label": "Yes",
          "sort_order": 0,
          "value_data": {
            "checked_value": true
          },
          "is_default": false,
          "adjusters": {
            "price": {
              "adjuster": null,
              "adjuster_value": null
            },
            "weight": null,
            "image_url": "",
            "purchasing_disabled": {
              "status": false,
              "message": ""
            }
          }
        },
        {
          "id": 150,
          "option_id": 160,
          "label": "No",
          "sort_order": 1,
          "value_data": {
            "checked_value": false
          },
          "is_default": true,
          "adjusters": {
            "price": null,
            "weight": null,
            "image_url": "",
            "purchasing_disabled": {
              "status": false,
              "message": ""
            }
          }
        }
      ]
    }
  ],
  "meta": {...}
}

Since this is a checkbox which has two states, checked/unchecked or yes/no, two option values are created. The default adjuster_value is null:

Next send a PUT request to update the modifier value. This increases the price by $5 when the Yes option value is selected.

PUT https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/products/{{product_id}}/modifiers/{{modifier_id}}/values
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "is_default": false,
  "adjusters": {
    "price": {
      "adjuster": "relative",
      "adjuster_value": 5
    }
  }
}

Open in Request Runner

Troubleshooting: 422 Errors

{
    "status": 422,
    "title": "The product is currently associated with an option set, please remove it before editing an option or modifier.",
    "type": "https://developer.bigcommerce.com/api#api-status-codes",
    "errors": {
        "product_id": "The product is currently associated with an option set, please remove it before editing an option or modifier."
    }
}

To fix this error:

  • Modify the products using the V2 API
  • Remove the option set using the V2 API or the Control Panel, then remake the variants and modifiers using V3

Complex Rules

Complex rules allow merchants to set up conditions and actions based on shopper option selections on the storefront. You can use them to vary the following based on option selections made by the shopper:

  • Price
  • Weight
  • Image
  • Purchasability

Adjustments made by complex rules are displayed to shoppers in real-time on the storefront.

For the majority of merchant use cases, best practice will be to either assign values (such as a price) directly to a variant or use adjusters on the modifier option itself. However complex rules exist for rare cases where a rule condition is too complex to express in those forms easily.

Use complex rules when an adjustment should be triggered by:

  • The selection of values across multiple modifier options
  • The combination of a particular variant/SKU and a modifier option value.

Complex Rules Example:

If the product is Variant Option Variant Modifier Complex Rule
T-Shirt Blue
-
Small
Medium
Large
SM-BLU
SM-MED
SM-LARG
Checkbox
Donate to Charity
Checkox
Donate to Charity.
Add $5
Backpack Black
Yellow
-
2L
3L
8L
BLACK-2L
BLACK-3L
BLACK 8L
-
YELLOW-2L
YELLOW-3L
YELLOW-8L
Text Field
Add Embroidery
N/A

Creating Complex Rules Based On Modifiers

Complex rules must be based on a combination of two or more modifiers, such as two checkboxes. The following example will add $10 to the product price when both boxes are checked.

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "product_id": 1200,
  "enabled": true,
  "price_adjuster": {
    "adjuster_value": 10
  },
  "conditions": [
    {
      "modifier_id": 506,
      "modifier_value_id": 852
    },
    {
      "modifier_id": 507,
      "modifier_value_id": 854
    }
  ]
}

Open in Request Runner

Troubleshooting

Complex rules must consist of multiple conditions that trigger the rule adjustment. If multiple conditions are not specified, the request will return a 422 Unprocessable Entity.

{
    "status": 422,
    "title": "The rule must contain multiple modifier conditions with unique modifier ids or a variant condition and modifier condition",
    "type": "https://developer.bigcommerce.com/api#api-status-codes"
}

Categories

Categories are a hierarchy of products available on the store, presented in a tree structure. A store’s category structure determines the primary menu structure of most storefront themes, which are directly tied to it.

All products must be associated with at least one Category, although a Category does not need to contain any products. Unlike some e-commerce platforms, products on BigCommerce can be associated with more than one Category.

A product associated with categories does not currently have any priority or weighted order (there’s no “primary category”), which can make it difficult to integrate with some external systems which might wish to use a product’s categories to map to a category structure in that external system.

POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories

Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

{
  "parent_id": 18,
  "name": "Shoes",
  "description": "Shoes Available for purchase",
  "sort_order": 1,
  "page_title": "Shoes",
  "is_visible": true
}

Open in Request Runner

Category Tree

Category Tree returns a simple view of the parent > child relationship of all categories in the store. This endpoint can be used to fetch the categories if building out a custom navigation for a store.

GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/catalog/summary
Accept: application/json
Content-Type: application/json
X-Auth-Token: {{ACCESS_TOKEN}}
X-Auth-Client: {{CLIENT_ID}}

Response::

{
  "data": [
    {
      "id": 25,
      "parent_id": 0,
      "name": "Towels",
      "is_visible": true,
      "url": "/towels/",
      "children": [
        {
          "id": 26,
          "parent_id": 25,
          "name": "Bath Towels",
          "is_visible": true,
          "url": "/towels/bath-towels/",
          "children": [
            {
              ...
              "children": [
                ...
                ]
            },
            ...
          ]
        },
        ..
      ]
    },
    ...
  ],
  "meta": {...}
}

Resources

Webhooks

Related Endpoints