Get product variant templates

Returns the variant templates for a product

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

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

Returns the variant templates 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: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/templates
  • Summary: Get product variant templates
  • Description: Returns the variant templates 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 bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses
StatusDescriptionContent
200Variant templatesapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Variant Templates Response

PropertyTypeRequiredDetails
dataobject[]No-
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-
Product Variant Template
PropertyTypeRequiredDetails
attribute_template_idstringNo-
created_atstringNo-
idstringNo-
template_keystringNo-
template_namestringNo-
updated_atstringNo-

Generated example (synthetic):

{
  "data": [
    {
      "attribute_template_id": "string",
      "created_at": "string",
      "id": "string",
      "template_key": "string",
      "template_name": "string",
      "updated_at": "string"
    }
  ],
  "details": [
    "string"
  ],
  "success": false
}

401 - 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: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variant-groups/templates
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variant Templates
  • OpenAPI summary: Get product variant templates

Get product variant templates

# Get product variant templates Returns the variant templates for a product
GET /api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups/templates
Purpose

Returns the variant templates for a product

Required inputs

team_slug path app_slug path product_id path

Primary response

200 ยท Variant templates

Operation key

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

## 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: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups/templates` - Summary: Get product variant templates - Description: Returns the variant templates for a product - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups/templates` 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 Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Variant templates | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Variant Templates 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 | - | ##### Product Variant Template | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_template_id` | string | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `updated_at` | string | No | - | **Generated example (synthetic):** ```json { "data": [ { "attribute_template_id": "string", "created_at": "string", "id": "string", "template_key": "string", "template_name": "string", "updated_at": "string" } ], "details": [ "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 } ``` ### 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: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups/templates` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variant-groups/templates` - OpenAPI tag: Variant Templates - OpenAPI summary: Get product variant templates