GET /catalog/variants
Returns a list of all variants in your catalog. Optional parameters can be passed in.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | No |
Filter items by variant ID. |
page |
Integer | No |
Specifies the page number in a limited (paginated) list of products. |
exclude_fields[] |
Array | No |
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded. |
product_id:in[] |
Array | No |
A comma-separated list of IDs of products you want to request. For example, |
sku |
String | No |
Filter items by variant SKU. To filter by product / base variant SKU, see Get all products. |
limit |
Integer | No |
Controls the number of items per page in a limited (paginated) list of products. |
upc |
String | No |
Filter items by UPC. |
include_fields[] |
Array | No |
Fields to include, in a comma-separated list. The ID and the specified fields will be returned. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.