v1
latestSwagger 2.02026-07-13137761.0 MBFamily variant
Get list of family variants
This endpoint allows you to get a list of family variants. Family variants are paginated and sorted by code.
get/api/rest/v1/families/{family_code}/variants
Path parameters
family_codestring required
Code of the family
Query parameters
pageinteger
Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section
limitinteger
Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section
with_countboolean
Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
Response
Return family variants paginated
Example response
{
"_embedded": {
"items": [
{
"code": "shoesVariant",
"labels": {
"en_US": "Shoes variant",
"fr_FR": "Variante de chaussures"
},
"common_attributes": [
"name",
"description"
],
"variant_attribute_sets": [
{
"level": 1,
"attributes": [
"color",
"material"
],
"axes": [
"color"
]
},
{
"level": 2,
"attributes": [
"sku",
"size"
],
"axes": [
"size"
]
}
]
}
]
}
}