Home
API Reference
Start typing to search…

List Variants

get https://{subdomain}.myclickfunnels.com/api/v2/products//variants

List variants for a product

Log in to see full request history
Path Params
integer
required
Query Params
string

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

string

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

string

Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

filter
object

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

Responses

Response body
array of objects
object
integer
required

ID

string | null

Variant public ID

integer
required

Product ID

string
required

Name

string | null

The description of the variant. The description of the default variant is the user-facing description of the Product.

string | null

SKU

string
required

Type

array | null

Properties values

properties_value_ids
string | null

Out of stock sales

number | null

Weight

string
required

Weight unit

number | null

Height

number | null

Width

number | null

Length

string | null

Dimensions unit

integer | null

Quantity

array | null

Tags

tag_ids
string | null

Tax category ID

array | null

Assets

asset_ids
string | null

Taxable

boolean | null

Track Quantity

boolean | null

Archived

boolean | null

Is visible

array | null

Price IDs

price_ids
boolean | null

Fulfillment required

string | null

Country of manufacture

array | null

The images for the variant.

image_ids
array | null

The fulfillment locations for the variant.

fulfillments_location_ids
date-time | null

Added

date-time | null

Updated

boolean | null

Identifies if the variant is the default variant for the product.

array of objects | null

The property values of the Variant. e.g. 'Large', 'Red' etc.

properties_values
object
integer | null

The ID of the property

string | null

The value

created_by_platform_application
object

The platform application that created the variant

Headers
object
string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Updated about 1 year ago

Language
Credentials
URL

Updated about 1 year ago