List Product Variants

GET

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

GET

/stores/:store_hash/v3/catalog/products/:product_id/variants

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

1 {
2   "data": [
3     {
4       "bin_picking_number": "",
5       "calculated_price": 10,
6       "calculated_weight": 2,
7       "cost_price": 0,
8       "depth": 5,
9       "fixed_cost_shipping_price": 10,
10       "gtin": "",
11       "height": 5,
12       "id": 382,
13       "image_url": "",
14       "inventory_level": 0,
15       "inventory_warning_level": 0,
16       "is_free_shipping": false,
17       "mpn": "",
18       "option_values": [
19         {
20           "id": 174,
21           "label": "Beige",
22           "option_display_name": "Color",
23           "option_id": 220
24         }
25       ],
26       "price": 10,
27       "product_id": 192,
28       "purchasing_disabled": false,
29       "purchasing_disabled_message": "",
30       "retail_price": 10,
31       "sale_price": 8,
32       "sku": "SMIT",
33       "sku_id": 348,
34       "upc": "",
35       "weight": 4,
36       "width": 5,
37       "map_price": {}
38     },
39     {
40       "bin_picking_number": "",
41       "calculated_price": 25,
42       "calculated_weight": 1,
43       "cost_price": 25,
44       "depth": 5,
45       "fixed_cost_shipping_price": 10,
46       "gtin": "",
47       "height": 5,
48       "id": 383,
49       "image_url": "",
50       "inventory_level": 0,
51       "inventory_warning_level": 0,
52       "is_free_shipping": false,
53       "mpn": "",
54       "option_values": [
55         {
56           "id": 175,
57           "label": "Grey",
58           "option_display_name": "Color",
59           "option_id": 220
60         }
61       ],
62       "price": 25,
63       "product_id": 192,
64       "purchasing_disabled": false,
65       "purchasing_disabled_message": "",
66       "retail_price": 25,
67       "sale_price": 20,
68       "sku": "SMIT-1",
69       "sku_id": 349,
70       "upc": "",
71       "weight": 2,
72       "width": 5,
73       "map_price": {}
74     },
75     {
76       "bin_picking_number": "",
77       "calculated_price": 25,
78       "calculated_weight": 1,
79       "cost_price": 25,
80       "depth": 5,
81       "fixed_cost_shipping_price": 10,
82       "gtin": "",
83       "height": 5,
84       "id": 384,
85       "image_url": "",
86       "inventory_level": 0,
87       "inventory_warning_level": 0,
88       "is_free_shipping": false,
89       "mpn": "",
90       "option_values": [
91         {
92           "id": 176,
93           "label": "Black",
94           "option_display_name": "Color",
95           "option_id": 220
96         }
97       ],
98       "price": 25,
99       "product_id": 192,
100       "purchasing_disabled": false,
101       "purchasing_disabled_message": "",
102       "retail_price": 25,
103       "sale_price": 20,
104       "sku": "SMIT-2",
105       "sku_id": 350,
106       "upc": "",
107       "weight": 2,
108       "width": 5,
109       "map_price": {}
110     }
111   ],
112   "meta": {
113     "pagination": {
114       "total": 3,
115       "count": 3,
116       "per_page": 50,
117       "current_page": 1,
118       "total_pages": 1,
119       "links": {
120         "current": "?page=1&limit=50"
121       }
122     }
123   }
124 }

Returns a list of product variants. 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-fundamentals/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-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

product_idintegerRequired

The ID of the Product to which the resource belongs. Product variant metafield endpoints that have the product_id in the request path are successful as long as the parameter is not empty. The product_id segment is there only for path consistency.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

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.

Response

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

Errors

404

Not Found Error

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

Errors

OAuth scopes

Authentication header

Further reading