DocsDocsReference

Create a variant group

Creates a variant group linked to an attribute for a product

POST/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups
API
Management
Updated
Apr 26, 2026

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

Creates a variant group linked to an attribute for a product

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups
  • Summary: Create a variant group
  • Description: Creates a variant group linked to an attribute for a product
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
product_idpathYesstringProduct ID
Request bodyDocumented body
  • Required: Yes
  • Description: Attribute IDs
  • Content: application/json (object)

Create Variant Group Payload

PropertyTypeRequiredDetails
attribute_idsstring[]YesminItems: 1
namestringYes-
priorityintegerNomin: 0 Will be set to the highest priority for the product if not provided
slugstringYes-

Generated example (synthetic):

{
  "attribute_ids": [
    "string"
  ],
  "name": "string",
  "priority": 0,
  "slug": "string"
}
Responses5 statuses
StatusDescriptionContent
201Variant group createdapplication/json (object)
400Invalid request or mismatched attributesapplication/json (object)
401Unauthorized accessapplication/json (object)
404Attribute not foundapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

Variant Group Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Variant Group
PropertyTypeRequiredDetails
attributesobject[]No-
channel_statusesobject[]No-
created_atstringNo-
idstringNo-
imagesobject[]No-
namestringNo-
priorityintegerNo-
product_idstringNo-
slugstringNo-
tagsobject[]No-
translationsobjectNo-
updated_atstringNo-
variantsobject[]No-
videosobject[]No-
Variant Group Attribute
PropertyTypeRequiredDetails
attribute_idstringNo-
attribute_keystringNo-
attribute_namestringNo-
template_keystringNo-
template_namestringNo-
Variant Group Channel Status
PropertyTypeRequiredDetails
channel_idstringNo-
channel_slugstringNo-
statusstringNo-
Image With Priority
PropertyTypeRequiredDetails
altstringNo-
app_idstringNo-
attributesobject[]No-
blurhashstringNo-
copyrightstringNo-
customobjectNo-
folder_idstringNo-
idstringNo-
parent_idstringNo-
priorityintegerNo-
publicbooleanNo-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
urlstringNo-
Product Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
orderintegerNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
Variant Group Translations
PropertyTypeRequiredDetails
nameobject[]No-
slugobject[]No-
Variant Group Variant
PropertyTypeRequiredDetails
idstringNo-
statusstringNo-
variant_namestringNo-
variant_numberstringNo-
Video
PropertyTypeRequiredDetails
attributesobject[]No-
descriptionstringNo-
folder_idstringNo-
idstringNo-
pathstringNo-
publicbooleanNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
variantsobject[]No-
{
  "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",
    "id": "string",
    "images": [
      {
        "alt": "string",
        "app_id": "string",
        "attributes": [],
        "blurhash": "string",
        "copyright": "string",
        "custom": {},
        "folder_id": "string",
        "id": "string",
        "parent_id": "string",
        "priority": 0,
        "public": false,
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "title": "string",
        "translations": {
          "alt": null,
          "copyright": null,
          "title": null
        },
        "url": "string"
      }
    ],
    "name": "string",
    "priority": 0,
    "product_id": "string",
    "slug": "string",
    "tags": [
      {
        "attributes": [],
        "created_at": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "markets": [],
        "name": "string",
        "order": 0,
        "schedules": [],
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "translations": {
          "name": null
        },
        "updated_at": "string"
      }
    ],
    "translations": {
      "name": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ],
      "slug": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string",
    "variants": [
      {
        "id": "string",
        "status": "string",
        "variant_name": "string",
        "variant_number": "string"
      }
    ],
    "videos": [
      {
        "attributes": [],
        "description": "string",
        "folder_id": "string",
        "id": "string",
        "path": "string",
        "public": false,
        "status": "string",
        "title": "string",
        "translations": {
          "description": null,
          "title": null
        },
        "variants": []
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variant Groups
  • OpenAPI summary: Create a variant group

Create a variant group

# Create a variant group Creates a variant group linked to an attribute for a product
POST /api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups
Purpose

Creates a variant group linked to an attribute for a product

Required inputs

team_slug path app_slug path product_id path

Primary response

201 ยท Variant group created

Operation key

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

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups` - Summary: Create a variant group - Description: Creates a variant group linked to an attribute for a product - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | | product_id | path | Yes | string | Product ID | ## Request body - Required: Yes - Description: Attribute IDs - Content: application/json (object) ### Create Variant Group Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_ids` | string[] | Yes | minItems: 1 | | `name` | string | Yes | - | | `priority` | integer | No | min: 0 Will be set to the highest priority for the product if not provided | | `slug` | string | Yes | - | **Generated example (synthetic):** ```json { "attribute_ids": [ "string" ], "name": "string", "priority": 0, "slug": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Variant group created | application/json (object) | | 400 | Invalid request or mismatched attributes | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | Attribute not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Variant Group Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Variant Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `channel_statuses` | object[] | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `images` | object[] | No | - | | `name` | string | No | - | | `priority` | integer | No | - | | `product_id` | string | No | - | | `slug` | string | No | - | | `tags` | object[] | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `variants` | object[] | No | - | | `videos` | object[] | No | - | ##### Variant Group Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_id` | string | No | - | | `attribute_key` | string | No | - | | `attribute_name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | ##### Variant Group Channel Status | Property | Type | Required | Details | | --- | --- | --- | --- | | `channel_id` | string | No | - | | `channel_slug` | string | No | - | | `status` | string | No | - | ##### Image With Priority | Property | Type | Required | Details | | --- | --- | --- | --- | | `alt` | string | No | - | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `blurhash` | string | No | - | | `copyright` | string | No | - | | `custom` | object | No | - | | `folder_id` | string | No | - | | `id` | string | No | - | | `parent_id` | string | No | - | | `priority` | integer | No | - | | `public` | boolean | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `title` | string | No | - | | `translations` | object | No | - | | `url` | string | No | - | ##### Product Tag | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `order` | integer | No | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | ##### Variant Group Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `name` | object[] | No | - | | `slug` | object[] | No | - | ##### Variant Group Variant | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `status` | string | No | - | | `variant_name` | string | No | - | | `variant_number` | string | No | - | ##### Video | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `description` | string | No | - | | `folder_id` | string | No | - | | `id` | string | No | - | | `path` | string | No | - | | `public` | boolean | No | - | | `status` | string | No | - | | `title` | string | No | - | | `translations` | object | No | - | | `variants` | object[] | No | - |
Generated example (synthetic) ```json { "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", "id": "string", "images": [ { "alt": "string", "app_id": "string", "attributes": [], "blurhash": "string", "copyright": "string", "custom": {}, "folder_id": "string", "id": "string", "parent_id": "string", "priority": 0, "public": false, "source_app_id": "string", "source_id": "string", "status": "string", "title": "string", "translations": { "alt": null, "copyright": null, "title": null }, "url": "string" } ], "name": "string", "priority": 0, "product_id": "string", "slug": "string", "tags": [ { "attributes": [], "created_at": "string", "filterable": false, "id": "string", "key": "string", "markets": [], "name": "string", "order": 0, "schedules": [], "source_app_id": "string", "source_id": "string", "status": "string", "translations": { "name": null }, "updated_at": "string" } ], "translations": { "name": [ { "id": null, "locale": null, "value": null } ], "slug": [ { "id": null, "locale": null, "value": null } ] }, "updated_at": "string", "variants": [ { "id": "string", "status": "string", "variant_name": "string", "variant_number": "string" } ], "videos": [ { "attributes": [], "description": "string", "folder_id": "string", "id": "string", "path": "string", "public": false, "status": "string", "title": "string", "translations": { "description": null, "title": null }, "variants": [] } ] }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups` - OpenAPI tag: Variant Groups - OpenAPI summary: Create a variant group