List Variants | BigCommerce Developer Center

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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 objects

metaobject

Data about the response, including pagination and collection totals.

Errors

404

Not Found Error

1	{
2	"data": [
3	{
4	"cost_price": 1.1,
5	"price": 1.1,
6	"sale_price": 1.1,
7	"retail_price": 1.1,
8	"weight": 1.1,
9	"width": 1.1,
10	"height": 1.1,
11	"depth": 1.1,
12	"is_free_shipping": true,
13	"fixed_cost_shipping_price": 1.1,
14	"purchasing_disabled": true,
15	"purchasing_disabled_message": "string",
16	"upc": "string",
17	"inventory_level": 1,
18	"inventory_warning_level": 1,
19	"bin_picking_number": "string",
20	"id": 1,
21	"product_id": 1,
22	"sku": "string",
23	"sku_id": 1,
24	"option_values": [
25	{
26	"option_display_name": "Color",
27	"label": "Beige",
28	"id": 1,
29	"option_id": 1
30	}
31	],
32	"calculated_price": 1.1
33	}
34	],
35	"meta": {
36	"pagination": {
37	"total": 36,
38	"count": 36,
39	"per_page": 50,
40	"current_page": 1,
41	"total_pages": 1,
42	"links": {
43	"previous": "string",
44	"current": "?page=1&limit=50",
45	"next": "string"
46	}
47	}
48	}
49	}

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