Stock Keeping Unit identifiers associated with products or product options.
This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the Catalog API.
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.)
Filter parameters can be added to the URL query string to select specific skus in the collection.
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.
Example JSON returned in the response:
Gets a single product SKU.
GET /stores/{store_hash}/v2/products/{product_id}/skus/{id}
Example JSON returned in the response:
Gets a count of the number of product SKUs in the store.
GET /stores/{store_hash}/v2/products/skus/countGET /api/v2/products/skus/countExample JSON returned in the response:
Creates a new product SKU.
POST /stores/{store_hash}/v2/products/{product_id}/skusThe following properties of the sku are read-only. If one or more of these properties are included in the request, it will be rejected.
The following properties of the sku are required. The request won’t be fulfilled unless these properties are valid.
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.)
Example JSON returned in the response:
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.
Updates an existing product SKU.
PUT /stores/{store_hash}/v2/products/{product_id}/skus/{id}
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.
There are no required properties for updating a product SKU.
Example JSON returned in the response:
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.
Deletes a product SKU.
DELETE /stores/{store_hash}/v2/products/{product_id}/skus/{id}
Deletes multiple product SKUs.
DELETE /stores/{store_hash}/v2/products/{product_id}/skus
Filter parameters can be added to the URL query string to select specific SKUs in the collection.
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.