List Variants

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/variants

GET

/stores/:store_hash/v3/catalog/variants

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/variants \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "cost_price": 1.1,
      "price": 1.1,
      "sale_price": 1.1,
      "retail_price": 1.1,
      "weight": 1.1,
      "width": 1.1,
      "height": 1.1,
      "depth": 1.1,
      "is_free_shipping": true,
      "fixed_cost_shipping_price": 1.1,
      "purchasing_disabled": true,
      "purchasing_disabled_message": "string",
      "upc": "string",
      "inventory_level": 1,
      "inventory_warning_level": 1,
      "bin_picking_number": "string",
      "id": 1,
      "product_id": 1,
      "sku": "string",
      "sku_id": 1,
      "option_values": [
        {
          "option_display_name": "Color",
          "label": "Beige",
          "id": 1,
          "option_id": 1
        }
      ],
      "calculated_price": 1.1
    }
  ],
  "meta": {
    "pagination": {
      "total": 36,
      "count": 36,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "?page=1&limit=50",
        "next": "string"
      }
    }
  }
}

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

Authentication

X-Auth-Tokenstring

OAuth scopes

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

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

idintegerOptional

Filter items by variant ID.

skustringOptional

Filter items by variant SKU. To filter by product / base variant SKU, see Get all products.

upcstringOptional

Filter items by UPC.

include_fieldslist of stringsOptional

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldslist of stringsOptional

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

product_id:inlist of integersOptional

A comma-separated list of IDs of products you want to request. For example, ?product_id:in=77,80,81.

Response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

404

Not Found Error