> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Product SKU ## SKUs Stock Keeping Unit identifiers associated with products or product options. > **Note** > > This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the [Catalog API](/developer/docs/admin/catalog-and-inventory). #### SKU Object Properties | Name | Type | Description | | ----------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id | int | | | product\_id | int | | | sku | string | The unique SKU (stock keeping unit). | | price | decimal | This SKU's base price on the storefront. If this value is null, the product's default price (set in the Product resource's `price` field) will be used as the base price. | | adjusted\_price | decimal | The SKU's price on the storefront – after the product's base price is inherited, and/or any option set or any product rules are applied. This property is READ-ONLY. | | cost\_price | decimal | The product's cost price. | | upc | string | The UPC (Universal Product Code) for this product combination. | | inventory\_level | int | The inventory level for the product. | | inventory\_warning\_level | int | The inventory warning level for the product . | | bin\_picking\_number | string | The BIN picking number. | | weight | decimal | This SKU's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight. | | adjusted\_weight | decimal | This SKU's weight on the storefront – after the product's base weight is inherited, and/or any option set or any product rules are applied. This property is READ-ONLY. | | is\_purchasing\_disabled | boolean | if true, this prohibits purchasing of the SKU. | | purchasing\_disabled\_message | string | The message to display if purchasing is disabled on this SKU. | | image\_file | string | The image that will be displayed when this SKU is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. | | options | object\_array | This is an object `{"product_option_id": int, "option_value_id":int}` | #### List Product SKUs Gets the collection of SKUs associated with a product. `GET /stores/{store_hash}/v2/products/{product_id}/skus` **Note** BigCommerce has updated the SKU schema to include additional price, weight, image, and purchasable properties. We will eventually remove the ability to manage these properties via SKU rules. (Merchants are already constrained from creating SKU-only rules in the BigCommerce control panel.) ### Filters Filter parameters can be added to the URL query string to select specific skus in the collection. | Parameter | Type | Example | | ------------------------- | ------- | -------------------------------------------------------------------- | | min\_id | int | `/api/v2/products/{product_id}/skus?min_id={value}` | | max\_id | int | `/api/v2/products/{product_id}/skus?max_id={value}` | | sku | string | `/api/v2/products/{product_id}/skus?sku={value}` | | upc | string | `/api/v2/products/{product_id}/skus?upc={value}` | | inventory\_level | string | `/api/v2/products/{product_id}/skus?inventory_level={value}` | | inventory\_warning\_level | string | `/api/v2/products/{product_id}/skus?inventory_warning_level={value}` | | bin\_picking\_number | string | `/api/v2/products/{product_id}/skus?bin_picking_number={value}` | | min\_inventory\_level | int | `/api/v2/products/{product_id}/skus?min_inventory_level={value}` | | max\_inventory\_level | int | `/api/v2/products/{product_id}/skus?max_inventory_level={value}` | | is\_low\_inventory | boolean | `/api/v2/products/{product_id}/skus?is_low_inventory={value}` | | product\_hash | int | `/api/v2/products/{product_id}/skus?product_hash={value}` | #### Pagination Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn't provided, up to 50 skus are returned by default. | Parameter | Type | Example | | --------- | ---- | -------------------------------------------------- | | page | int | `/api/v2/products/{product_id}/skus?page={number}` | | limit | int | `/api/v2/products/{product_id}/skus?limit={count}` | ### Response Example JSON returned in the response: ```json showLineNumbers={false} [ { "id": 1, "product_id": 5, "sku": "MB-1", "price": null, "adjusted_price": "1.5000", "cost_price": "0.0000", "upc": "", "inventory_level": 0, "inventory_warning_level": 0, "bin_picking_number": "", "weight": null, "adjusted_weight": "0.00", "is_purchasing_disabled": false, "purchasing_disabled_message": "", "image_file": "", "options": [ { "product_option_id": 15, "option_value_id": 17 }, { "product_option_id": 16, "option_value_id": 28 } ] }, { "id": 2, "product_id": 5, "sku": "MB-2", "price": null, "adjusted_price": "2.0000", "cost_price": "0.0000", "upc": "", "inventory_level": 0, "inventory_warning_level": 0, "bin_picking_number": "", "weight": null, "adjusted_weight": "0.00", "is_purchasing_disabled": true, "purchasing_disabled_message": "We're sorry, this is unavailable.", "image_file": "", "options": [ { "product_option_id": 15, "option_value_id": 18 }, { "product_option_id": 16, "option_value_id": 26 } ] } ] ``` #### Get a Product SKU Gets a single product SKU. `GET /stores/{store_hash}/v2/products/{product_id}/skus/{id}` ### Response Example JSON returned in the response: ```json showLineNumbers={false} { "id": 5, "product_id": 7, "sku": "MBA-1atest", "price": null, "adjusted_price": "1.5000", "cost_price": "0.0000", "upc": "", "inventory_level": 0, "inventory_warning_level": 0, "bin_picking_number": "", "weight": null, "adjusted_weight": "0.00", "is_purchasing_disabled": false, "purchasing_disabled_message": "", "image_file": "https://thinglust.com/eyecandy.png", "options": [ { "product_option_id": 20, "option_value_id": 51 } ] } ``` #### Get a Count of Product SKUs Gets a count of the number of product SKUs in the store. * OAuth `GET /stores/{store_hash}/v2/products/skus/count` * Basic Auth `GET /api/v2/products/skus/count` ### Response Example JSON returned in the response: ```json showLineNumbers={false} { "count": 1235 } ``` #### Create a Product SKU Creates a new product SKU. * OAuth `POST /stores/{store_hash}/v2/products/{product_id}/skus` ### Read-only Properties The following properties of the sku are read-only. If one or more of these properties are included in the request, it will be rejected. * id * product\_id * adjusted\_price * adjusted\_weight ### Requirements The following properties of the sku are required. The request won't be fulfilled unless these properties are valid. * sku * options **Note** To maximize system performance, BigCommerce caps the number of SKUs associated with a product at 500. If you attempt to add a SKU to a product that has 500 SKUs, BigCommerce will return a 403 error. BigCommerce has updated the SKU schema to include additional price, weight, image, and purchasable properties. We will eventually remove the ability to manage these properties via SKU rules. (Merchants are already constrained from creating SKU-only rules in the BigCommerce control panel.) ### Response Example JSON returned in the response: ```json showLineNumbers={false} { "id": 5, "product_id": 7, "sku": "MBA-1atest", "price": null, "adjusted_price": "1.5000", "cost_price": "0.0000", "upc": "", "inventory_level": 0, "inventory_warning_level": 0, "bin_picking_number": "", "weight": null, "adjusted_weight": "0.00", "is_purchasing_disabled": false, "purchasing_disabled_message": "", "image_file": "", "options": [ { "product_option_id": 20, "option_value_id": 51 } ] } ``` You may encounter a case where product information was updated successfully, but related inventory data failed to update. In such cases, BigCommerce will return a `207` status along with the object as updated and a descriptive error message. ``` 207 Multi-Status ``` #### Update a Product SKU Updates an existing product SKU. `PUT /stores/{store_hash}/v2/products/{product_id}/skus/{id}` ### Read-only Properties The following properties of the sku are read-only. If one or more of these properties are included in the request, it will be rejected. * id * product\_id * adjusted\_price * adjusted\_weight ### Requirements There are no required properties for updating a product SKU. ### Response Example JSON returned in the response: ```json showLineNumbers={false} { "id": 5, "product_id": 7, "sku": "MBA-1atest", "price": "4.9900", "adjusted_price": "3.9900", "cost_price": "2.9900", "upc": "", "inventory_level": 0, "inventory_warning_level": 0, "bin_picking_number": "", "weight": null, "adjusted_weight": "0.00", "is_purchasing_disabled": true, "purchasing_disabled_message": "We're sorry, this is unavailable.", "image_file": "", "options": [ { "product_option_id": 20, "option_value_id": 51 } ] } ``` You may encounter a case where product information was updated successfully, but related inventory data failed to update. In such cases, BigCommerce will return a `207` status along with the object as updated and a descriptive error message. ``` 207 Multi-Status ``` #### Delete a Product SKU Deletes a product SKU. `DELETE /stores/{store_hash}/v2/products/{product_id}/skus/{id}` #### Delete Multiple Product SKUs Deletes multiple product SKUs. `DELETE /stores/{store_hash}/v2/products/{product_id}/skus` ### Filters Filter parameters can be added to the URL query string to select specific SKUs in the collection. | Parameter | Type | Example | | ------------------------- | ------- | -------------------------------------------------------------------- | | min\_id | int | `/api/v2/products/{product_id}/skus?min_id={value}` | | max\_id | int | `/api/v2/products/{product_id}/skus?max_id={value}` | | sku | string | `/api/v2/products/{product_id}/skus?sku={value}` | | upc | string | `/api/v2/products/{product_id}/skus?upc={value}` | | inventory\_level | string | `/api/v2/products/{product_id}/skus?inventory_level={value}` | | inventory\_warning\_level | string | `/api/v2/products/{product_id}/skus?inventory_warning_level={value}` | | bin\_picking\_number | string | `/api/v2/products/{product_id}/skus?bin_picking_number={value}` | | min\_inventory\_level | int | `/api/v2/products/{product_id}/skus?min_inventory_level={value}` | | max\_inventory\_level | int | `/api/v2/products/{product_id}/skus?max_inventory_level={value}` | | is\_low\_inventory | boolean | `/api/v2/products/{product_id}/skus?is_low_inventory={value}` | | product\_hash | int | `/api/v2/products/{product_id}/skus?product_hash={value}` | ### Pagination Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn't provided, up to 50 skus are returned by default. | Parameter | Type | Example | | --------- | ---- | -------------------------------------------------- | | page | int | `/api/v2/products/{product_id}/skus?page={number}` | | limit | int | `/api/v2/products/{product_id}/skus?limit={count}` |