Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Products::Variant

Create Variant

Create a new variant for a product

post/products/{product_id}/variants

Path parameters

product_idinteger required

Request body

Example request

{
  "products_variant": {
    "products_variant": {
      "name": "Small Aluminum Gloves variant 393f",
      "description": "Dolore provident unde quas.",
      "sku": "LxbnGP0kqyqzQDTK",
      "product_type": "physical",
      "out_of_stock_sales": true,
      "weight": "24.0",
      "weight_unit": "lb",
      "height": "96.0",
      "width": "418.0",
      "length": "66.0",
      "dimensions_unit": "inches",
      "tax_category_id": null,
      "taxable": null,
      "track_quantity": false,
      "archived": false,
      "visible": true,
      "fulfillment_required": false,
      "country_of_manufacture_id": null,
      "image_ids": [],
      "fulfillments_location_ids": []
    }
  }
}

Response

Created

idinteger

ID

public_idstring nullable

Variant public ID

product_idinteger

Product ID

namestring

Name

descriptionstring nullable

The description of the variant. The description of the default variant is the user-facing description of the Product.

skustring nullable

SKU

product_typestring

Type

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:properties_value_ids","oasType":"schema","type":"unknown","description":"Properties values"}
out_of_stock_salesstring nullable

Out of stock sales

weightnumber nullable

Weight

weight_unitstring

Weight unit

heightnumber nullable

Height

widthnumber nullable

Width

lengthnumber nullable

Length

dimensions_unitstring nullable

Dimensions unit

quantityinteger nullable

Quantity

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:tag_ids","oasType":"schema","type":"unknown","description":"Tags"}
tax_category_idstring nullable

Tax category ID

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:asset_ids","oasType":"schema","type":"unknown","description":"Assets"}
taxablestring nullable

Taxable

track_quantityboolean nullable

Track Quantity

archivedboolean nullable

Archived

visibleboolean nullable

Is visible

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:price_ids","oasType":"schema","type":"unknown","description":"Price IDs"}
fulfillment_requiredboolean nullable

Fulfillment required

country_of_manufacture_idstring nullable

Country of manufacture

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:image_ids","oasType":"schema","type":"unknown","description":"The images for the variant."}
{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:fulfillments_location_ids","oasType":"schema","type":"unknown","description":"The fulfillment locations for the variant."}
created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

defaultboolean nullable

Identifies if the variant is the default variant for the product.

Example response

{
  "id": 15,
  "public_id": "NRBUIp",
  "product_id": 24,
  "name": "Small Aluminum Gloves variant 393f",
  "description": "Dolore provident unde quas.",
  "sku": "LxbnGP0kqyqzQDTK",
  "product_type": "physical",
  "properties_value_ids": [
    null
  ],
  "out_of_stock_sales": null,
  "weight": "24.0",
  "weight_unit": "lb",
  "height": "96.0",
  "width": "418.0",
  "length": "66.0",
  "dimensions_unit": "inches",
  "quantity": 0,
  "tag_ids": [
    39
  ],
  "tax_category_id": null,
  "asset_ids": [],
  "taxable": null,
  "track_quantity": false,
  "archived": false,
  "visible": true,
  "price_ids": [],
  "fulfillment_required": false,
  "country_of_manufacture_id": null,
  "image_ids": [],
  "fulfillments_location_ids": [],
  "created_at": "2025-08-11T19:14:39.799Z",
  "updated_at": "2025-08-11T19:14:39.799Z",
  "default": false,
  "properties_values": [
    {
      "property_id": 15,
      "value": "Red"
    }
  ],
  "created_by_platform_application": null
}