DocsDocsReference

Create product variant

Creates a new variant for a product with the specified name, number, stock levels, and status

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

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

Creates a new variant for a product with the specified name, number, stock levels, and status

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\}/variants
  • Summary: Create product variant
  • Description: Creates a new variant for a product with the specified name, number, stock levels, and status
  • 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
product_idpathYesstringProduct ID
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Variant data
  • Content: application/json (object)

Input Variant

PropertyTypeRequiredDetails
custom_fieldsobjectNo-
purchase_priceobjectNo-
statusenum("active", "draft", "inactive", "archived")NoStatus of the product
stockobject[]YesStock level of the variant
validate_stockbooleanNo-
variant_dimensionsobjectNo-
variant_group_idstringNo-
variant_namestringYesVariantName of the variant
variant_numberstringYesNumber of the variant

Purchase Price

PropertyTypeRequiredDetails
currencystringNo-
value_centsintegerNo-

Input Variant Stock

PropertyTypeRequiredDetails
inventory_datestringNoISO 8601 date format with time zone e.g. 2024-12-12T09:13:31.039Z.
quantityintegerNo-
warehouse_slugstringYes-

Dimensions

PropertyTypeRequiredDetails
capacity_milliliterintegerNomin: 0 the capacity in milliliter
depthintegerNomin: 0 The products depth in millimeter
diameterintegerNomin: 0 the products diameter in millimeter
heightintegerNomin: 0 The products height in millimeter
lengthintegerNomin: 0 The products length in millimeter
weightintegerNomin: 0 The products weight in grams
widthintegerNomin: 0 The products width in millimeter

Generated example (synthetic):

{
  "custom_fields": {},
  "purchase_price": {
    "currency": "string",
    "value_cents": 0
  },
  "status": "active",
  "stock": [
    {
      "inventory_date": "string",
      "quantity": 0,
      "warehouse_slug": "string"
    }
  ],
  "validate_stock": false,
  "variant_dimensions": {
    "capacity_milliliter": 0,
    "depth": 0,
    "diameter": 0,
    "height": 0,
    "length": 0,
    "weight": 0,
    "width": 0
  },
  "variant_group_id": "string",
  "variant_name": "string",
  "variant_number": "string"
}
Responses4 statuses
StatusDescriptionContent
200Variant created successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Variant 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
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
custom_fieldsobjectNo-
idstringNo-
imagesobject[]NoImages of the product
listingsobjectNo-
parent_product_idstringNo-
purchase_priceobjectNo-
shipping_attributesstring[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
store_groupobject[]NoProduct StoreGroup
tagsobject[]No-
translationsobjectNo-
updated_atstringNo-
validate_stockbooleanNo-
variant_dimensionsobjectNo-
variant_group_idstringNo-
variant_namestringNo-
variant_numberstringNo-
videosobject[]NoVideos of the product
warehouse_variant_stockobject[]No-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
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-
Variant Listings
PropertyTypeRequiredDetails
smartobject[]No-
staticobject[]No-
Purchase Price
PropertyTypeRequiredDetails
currencystringNo-
value_centsintegerNo-
Product Variant Store Group With Prices
PropertyTypeRequiredDetails
created_atstringNo-
idstringNo-
namestringNo-
pricesobject[]No-
slugstringNo-
store_typestringNo-
updated_atstringNo-
Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
Product Variant Translations
PropertyTypeRequiredDetails
nameobject[]No-
Dimensions
PropertyTypeRequiredDetails
capacity_milliliterintegerNomin: 0 the capacity in milliliter
depthintegerNomin: 0 The products depth in millimeter
diameterintegerNomin: 0 the products diameter in millimeter
heightintegerNomin: 0 The products height in millimeter
lengthintegerNomin: 0 The products length in millimeter
weightintegerNomin: 0 The products weight in grams
widthintegerNomin: 0 The products width in millimeter
Video
PropertyTypeRequiredDetails
attributesobject[]No-
descriptionstringNo-
folder_idstringNo-
idstringNo-
pathstringNo-
publicbooleanNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
variantsobject[]No-
Warehouse Variant Stock
PropertyTypeRequiredDetails
available_onlinebooleanNo-
created_atstringNo-
idstringNo-
inventory_datestringNo-
quantityintegerNo-
updated_atstringNo-
warehouse_namestringNo-
warehouse_slugstringNo-
{
  "data": {
    "attributes": [
      {
        "created_at": "string",
        "description": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": false,
        "translations": {
          "description": null,
          "name": null
        },
        "updated_at": "string",
        "values": {}
      }
    ],
    "created_at": "string",
    "custom_fields": {},
    "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"
      }
    ],
    "listings": {
      "smart": [
        {
          "id": null,
          "slug": null
        }
      ],
      "static": [
        {
          "id": null,
          "slug": null
        }
      ]
    },
    "parent_product_id": "string",
    "purchase_price": {
      "currency": "string",
      "value_cents": 0
    },
    "shipping_attributes": [
      "string"
    ],
    "source_app_id": "string",
    "source_id": "string",
    "status": "string",
    "store_group": [
      {
        "created_at": "string",
        "id": "string",
        "name": "string",
        "prices": [],
        "slug": "string",
        "store_type": "string",
        "updated_at": "string"
      }
    ],
    "tags": [
      {
        "attributes": [],
        "created_at": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "markets": [],
        "name": "string",
        "schedules": [],
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "translations": {
          "name": null
        },
        "updated_at": "string"
      }
    ],
    "translations": {
      "name": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string",
    "validate_stock": false,
    "variant_dimensions": {
      "capacity_milliliter": 0,
      "depth": 0,
      "diameter": 0,
      "height": 0,
      "length": 0,
      "weight": 0,
      "width": 0
    },
    "variant_group_id": "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": []
      }
    ],
    "warehouse_variant_stock": [
      {
        "available_online": false,
        "created_at": "string",
        "id": "string",
        "inventory_date": "string",
        "quantity": 0,
        "updated_at": "string",
        "warehouse_name": "string",
        "warehouse_slug": "string"
      }
    ]
  },
  "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
}

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\}/variants
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variants
  • OpenAPI summary: Create product variant

Create product variant

# Create product variant Creates a new variant for a product with the specified name, number, stock levels, and status
POST /api/v1/{team_slug}/{app_slug}/products/{product_id}/variants
Purpose

Creates a new variant for a product with the specified name, number, stock levels, and status

Required inputs

product_id path app_slug path team_slug path

Primary response

200 ยท Variant created successfully

Operation key

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

## 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}/variants` - Summary: Create product variant - Description: Creates a new variant for a product with the specified name, number, stock levels, and status - 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}/variants` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | product_id | path | Yes | string | Product ID | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Variant data - Content: application/json (object) ### Input Variant | Property | Type | Required | Details | | --- | --- | --- | --- | | `custom_fields` | object | No | - | | `purchase_price` | object | No | - | | `status` | enum("active", "draft", "inactive", "archived") | No | Status of the product | | `stock` | object[] | Yes | Stock level of the variant | | `validate_stock` | boolean | No | - | | `variant_dimensions` | object | No | - | | `variant_group_id` | string | No | - | | `variant_name` | string | Yes | VariantName of the variant | | `variant_number` | string | Yes | Number of the variant | #### Purchase Price | Property | Type | Required | Details | | --- | --- | --- | --- | | `currency` | string | No | - | | `value_cents` | integer | No | - | #### Input Variant Stock | Property | Type | Required | Details | | --- | --- | --- | --- | | `inventory_date` | string | No | ISO 8601 date format with time zone e.g. 2024-12-12T09:13:31.039Z. | | `quantity` | integer | No | - | | `warehouse_slug` | string | Yes | - | #### Dimensions | Property | Type | Required | Details | | --- | --- | --- | --- | | `capacity_milliliter` | integer | No | min: 0 the capacity in milliliter | | `depth` | integer | No | min: 0 The products depth in millimeter | | `diameter` | integer | No | min: 0 the products diameter in millimeter | | `height` | integer | No | min: 0 The products height in millimeter | | `length` | integer | No | min: 0 The products length in millimeter | | `weight` | integer | No | min: 0 The products weight in grams | | `width` | integer | No | min: 0 The products width in millimeter | **Generated example (synthetic):** ```json { "custom_fields": {}, "purchase_price": { "currency": "string", "value_cents": 0 }, "status": "active", "stock": [ { "inventory_date": "string", "quantity": 0, "warehouse_slug": "string" } ], "validate_stock": false, "variant_dimensions": { "capacity_milliliter": 0, "depth": 0, "diameter": 0, "height": 0, "length": 0, "weight": 0, "width": 0 }, "variant_group_id": "string", "variant_name": "string", "variant_number": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Variant created successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Variant 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 | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `custom_fields` | object | No | - | | `id` | string | No | - | | `images` | object[] | No | Images of the product | | `listings` | object | No | - | | `parent_product_id` | string | No | - | | `purchase_price` | object | No | - | | `shipping_attributes` | string[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `store_group` | object[] | No | Product StoreGroup | | `tags` | object[] | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `validate_stock` | boolean | No | - | | `variant_dimensions` | object | No | - | | `variant_group_id` | string | No | - | | `variant_name` | string | No | - | | `variant_number` | string | No | - | | `videos` | object[] | No | Videos of the product | | `warehouse_variant_stock` | object[] | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | 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 | - | ##### Variant Listings | Property | Type | Required | Details | | --- | --- | --- | --- | | `smart` | object[] | No | - | | `static` | object[] | No | - | ##### Purchase Price | Property | Type | Required | Details | | --- | --- | --- | --- | | `currency` | string | No | - | | `value_cents` | integer | No | - | ##### Product Variant Store Group With Prices | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `id` | string | No | - | | `name` | string | No | - | | `prices` | object[] | No | - | | `slug` | string | No | - | | `store_type` | string | No | - | | `updated_at` | string | No | - | ##### 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 | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | ##### Product Variant Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `name` | object[] | No | - | ##### Dimensions | Property | Type | Required | Details | | --- | --- | --- | --- | | `capacity_milliliter` | integer | No | min: 0 the capacity in milliliter | | `depth` | integer | No | min: 0 The products depth in millimeter | | `diameter` | integer | No | min: 0 the products diameter in millimeter | | `height` | integer | No | min: 0 The products height in millimeter | | `length` | integer | No | min: 0 The products length in millimeter | | `weight` | integer | No | min: 0 The products weight in grams | | `width` | integer | No | min: 0 The products width in millimeter | ##### 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 | - | ##### Warehouse Variant Stock | Property | Type | Required | Details | | --- | --- | --- | --- | | `available_online` | boolean | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `inventory_date` | string | No | - | | `quantity` | integer | No | - | | `updated_at` | string | No | - | | `warehouse_name` | string | No | - | | `warehouse_slug` | string | No | - |
Generated example (synthetic) ```json { "data": { "attributes": [ { "created_at": "string", "description": "string", "filterable": false, "id": "string", "key": "string", "name": "string", "template_key": "string", "template_name": "string", "translatable": false, "translations": { "description": null, "name": null }, "updated_at": "string", "values": {} } ], "created_at": "string", "custom_fields": {}, "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" } ], "listings": { "smart": [ { "id": null, "slug": null } ], "static": [ { "id": null, "slug": null } ] }, "parent_product_id": "string", "purchase_price": { "currency": "string", "value_cents": 0 }, "shipping_attributes": [ "string" ], "source_app_id": "string", "source_id": "string", "status": "string", "store_group": [ { "created_at": "string", "id": "string", "name": "string", "prices": [], "slug": "string", "store_type": "string", "updated_at": "string" } ], "tags": [ { "attributes": [], "created_at": "string", "filterable": false, "id": "string", "key": "string", "markets": [], "name": "string", "schedules": [], "source_app_id": "string", "source_id": "string", "status": "string", "translations": { "name": null }, "updated_at": "string" } ], "translations": { "name": [ { "id": null, "locale": null, "value": null } ] }, "updated_at": "string", "validate_stock": false, "variant_dimensions": { "capacity_milliliter": 0, "depth": 0, "diameter": 0, "height": 0, "length": 0, "weight": 0, "width": 0 }, "variant_group_id": "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": [] } ], "warehouse_variant_stock": [ { "available_online": false, "created_at": "string", "id": "string", "inventory_date": "string", "quantity": 0, "updated_at": "string", "warehouse_name": "string", "warehouse_slug": "string" } ] }, "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 } ``` ### 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}/variants` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants` - OpenAPI tag: Variants - OpenAPI summary: Create product variant