Create a variant group

Creates a variant group for a product. Attributes are optional and can be set later.

POST/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups

Path parameters

team_slugstringrequired

Team slug

app_slugstringrequired

App slug

product_idstringrequired

Product ID

Request body

requiredapplication/json

Variant group

attribute_idsstring[]

descriptionstring

namestringrequired

priorityinteger

Will be set to the highest priority for the product if not provided

min 0

slugstringrequired

Responses

201

Variant group created

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGrouprequired

Show properties

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupAttribute[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupAttribute

attribute_idstring

attribute_keystring

attribute_namestring

template_keystring

template_namestring

channel_statusesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupChannelStatus[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupChannelStatus

channel_idstring

channel_slugstring

statusstring

created_atstring

descriptionstring

idstring

imagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority

altstring | null

app_idstring | null

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute

created_atstring

descriptionstring | null

filterableboolean | null

idstring

keystring

namestring | null

template_keystring

template_namestring

translatableboolean | null

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

updated_atstring | null

valuesobject | null

blurhashstring

copyrightstring | null

customobject | null

folder_idstring

idstring

parent_idstring | null

priorityinteger

publicboolean

statusstring

titlestring | null

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageTranslation

Show properties

altgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

copyrightgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

urlstring

namestring

priorityinteger

product_idstring

slugstring

tagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTag[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductTag

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

created_atstring

filterableboolean

idstring

keystring

marketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Market

activeboolean

country_codesstring[] | null

created_atstring

currency_codestring

idstring

localestring

namestring

slugstring

updated_atstring | null

namestring

orderinteger

schedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Job

add_category_namesstring[]

add_collection_namesstring[]

add_tag_namesstring[]

execute_atstring

Date when the job should run

finished_atstring | null

If a job is finished will this timestamp be filled

group_idstring

idstring

item_idstring

item_namestring

item_typestring

remove_category_namesstring[]

remove_collection_namesstring[]

remove_tag_namesstring[]

to_amount_cents_with_taxinteger | null

to_market_idstring

to_market_statusstring

to_on_saleboolean | null

to_sale_amount_cents_with_taxinteger | null

to_start_sale_timestampstring

to_statusstring | null

to_stop_sale_timestampstring

to_store_group_idstring

statusstring

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslations

Show properties

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

updated_atstring | null

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

sluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

updated_atstring | null

variantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupVariant[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantGroupVariant

idstring

statusstring

variant_namestring

variant_numberstring

videosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Video

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

descriptionstring

folder_idstring

idstring

pathstring

publicboolean

statusstring

titlestring

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null

variantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant

formatstring

heightinteger

urlstring

widthinteger

detailsstring[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

successbooleanrequired

400

Invalid request or mismatched attributes

detailsstring[]

messagestring

successbooleanrequired

401

Unauthorized access

detailsstring[]

messagestring

successbooleanrequired

404

Attribute not found

detailsstring[]

messagestring

successbooleanrequired

500

Internal server error

detailsstring[]

messagestring

successbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

team_slugpath*Team slugapp_slugpath*App slugproduct_idpath*Product ID

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.enad.io/api/v1/string/string/products/string/variant-groups' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "attribute_ids": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "priority": 0,
  "slug": "string"
}'

const response = await fetch("https://api.enad.io/api/v1/string/string/products/string/variant-groups", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"attribute_ids\": [\n    \"string\"\n  ],\n  \"description\": \"string\",\n  \"name\": \"string\",\n  \"priority\": 0,\n  \"slug\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.enad.io/api/v1/string/string/products/string/variant-groups",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"attribute_ids\": [\n    \"string\"\n  ],\n  \"description\": \"string\",\n  \"name\": \"string\",\n  \"priority\": 0,\n  \"slug\": \"string\"\n}",
)

Response

{
  "data": {
    "attributes": [
      {
        "attribute_id": "string",
        "attribute_key": "string",
        "attribute_name": "string",
        "template_key": "string",
        "template_name": "string"
      }
    ],
    "channel_statuses": [
      {
        "channel_id": "string",
        "channel_slug": "string",
        "status": "string"
      }
    ],
    "created_at": "string",
    "description": "string",
    "id": "string",
    "images": [
      {
        "alt": "string",
        "app_id": "string",
        "attributes": [
          {
            "created_at": "string",
            "description": "string",
            "filterable": true,
            "id": "string",
            "key": "string",
            "name": "string",
            "template_key": "string",
            "template_name": "string",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ],
              "name": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "updated_at": "string",
            "values": {
              "property1": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              },
              "property2": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              }
            }
          }
        ],
        "blurhash": "string",
        "copyright": "string",
        "custom": {
          "property1": "string",
          "property2": "string"
        },
        "folder_id": "string",
        "id": "string",
        "parent_id": "string",
        "priority": 0,
        "public": true,
        "status": "string",
        "title": "string",
        "translations": {
          "alt": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "copyright": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "title": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "url": "string"
      }
    ],
    "name": "string",
    "priority": 0,
    "product_id": "string",
    "slug": "string",
    "tags": [
      {
        "attributes": [
          {
            "created_at": "string",
            "description": "string",
            "filterable": true,
            "id": "string",
            "key": "string",
            "name": "string",
            "template_key": "string",
            "template_name": "string",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ],
              "name": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "updated_at": "string",
            "values": {
              "property1": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              },
              "property2": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              }
            }
          }
        ],
        "created_at": "string",
        "filterable": true,
        "id": "string",
        "key": "string",
        "markets": [
          {
            "active": true,
            "country_codes": [
              "string"
            ],
            "created_at": "string",
            "currency_code": "string",
            "id": "string",
            "locale": "string",
            "name": "string",
            "slug": "string",
            "updated_at": "string"
          }
        ],
        "name": "string",
        "order": 0,
        "schedules": [
          {
            "add_category_names": [
              "string"
            ],
            "add_collection_names": [
              "string"
            ],
            "add_tag_names": [
              "string"
            ],
            "execute_at": "string",
            "finished_at": "string",
            "group_id": "string",
            "id": "string",
            "item_id": "string",
            "item_name": "string",
            "item_type": "string",
            "remove_category_names": [
              "string"
            ],
            "remove_collection_names": [
              "string"
            ],
            "remove_tag_names": [
              "string"
            ],
            "to_amount_cents_with_tax": 0,
            "to_market_id": "string",
            "to_market_status": "string",
            "to_on_sale": true,
            "to_sale_amount_cents_with_tax": 0,
            "to_start_sale_timestamp": "string",
            "to_status": "string",
            "to_stop_sale_timestamp": "string",
            "to_store_group_id": "string"
          }
        ],
        "status": "string",
        "translations": {
          "name": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "updated_at": "string"
      }
    ],
    "translations": {
      "description": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "name": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "slug": [
        {
          "id": "string",
          "locale": "string",
          "value": "string"
        }
      ]
    },
    "updated_at": "string",
    "variants": [
      {
        "id": "string",
        "status": "string",
        "variant_name": "string",
        "variant_number": "string"
      }
    ],
    "videos": [
      {
        "attributes": [
          {
            "created_at": "string",
            "description": "string",
            "filterable": true,
            "id": "string",
            "key": "string",
            "name": "string",
            "template_key": "string",
            "template_name": "string",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ],
              "name": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "updated_at": "string",
            "values": {
              "property1": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              },
              "property2": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              }
            }
          }
        ],
        "description": "string",
        "folder_id": "string",
        "id": "string",
        "path": "string",
        "public": true,
        "status": "string",
        "title": "string",
        "translations": {
          "description": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "title": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "variants": [
          {
            "format": "string",
            "height": 0,
            "url": "string",
            "width": 0
          }
        ]
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}