Skip to content
Esc
↑↓navigate↵open⌘Jpreview

VariantGroup

Variant group belonging to a flexible product

OBJECTVariantGroup
Fields
idString!
nameString!
descriptionString!
slugString!
priorityInt!
hasActiveVariantsBoolean!
thirdPartyLinks[ThirdPartyLink!]!
variants[Variant!]!
images[Image!]!
videos[Video!]!
attributes[Attribute!]!
Example JSON
{
  "id": "string",
  "name": "string",
  "description": "string",
  "slug": "string",
  "priority": 0,
  "hasActiveVariants": true,
  "thirdPartyLinks": [
    {
      "id": "string",
      "type": "string",
      "title": "string",
      "url": "string",
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "variants": [
    {
      "id": "string",
      "productId": "string",
      "sku": "string",
      "name": "string",
      "status": "ACTIVE",
      "shippingAttributes": [
        "string"
      ],
      "validateStock": true,
      "createdAt": "string",
      "updatedAt": null,
      "variantGroupId": "string"
    }
  ],
  "images": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "altText": "string",
      "copyright": "string",
      "sort": 0,
      "status": "ACTIVE",
      "blurhash": "string",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "videos": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "description": "string",
      "sort": 0,
      "status": "ACTIVE",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "attributes": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "templateKey": "string",
      "filterable": true,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "tags": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "filterable": true,
      "status": "string",
      "createdAt": null,
      "updatedAt": null
    }
  ]
}
Used by