Products::Variant

Retrieve a single variant

get/products/variants/{id}

Request

Path parameters

idstring required

Response

OK

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_type'physical' | 'digital'

physical or digital. Drives checkout behavior: a physical variant makes checkout collect a shipping address (and shipping options); a digital variant skips both. Unset behaves like digital at checkout, so set it to match the real-world goods.

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

tax_category_idstring nullable

Tax category ID

asset_idsinteger[] nullable

Digital-asset access. The IDs of the workspace Assets a purchase of this variant grants access to. See also has_access_to_all_valid_assets.

has_access_to_all_valid_assetsboolean nullable

When true, a purchase grants access to every valid Asset (rather than only the specific asset_ids).

taxablestring nullable

Taxable

track_quantityboolean nullable

Track Quantity

archivedboolean nullable

Archived

visibleboolean nullable

Is visible

fulfillment_requiredboolean nullable

Fulfillment required

country_of_manufacture_idstring nullable

Country of manufacture

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": [
    904
  ],
  "has_access_to_all_valid_assets": false,
  "included_courses": [
    {
      "id": 31,
      "course_id": 42,
      "full_access": true,
      "included_section_ids": [
        301,
        302
      ]
    }
  ],
  "included_space_groups": [
    {
      "id": 19,
      "communities_space_group_id": 8,
      "spaces_mode": "all",
      "included_space_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
}

Changes

    • warning

      added the new digital enum value to the response property for the response status

    • warning

      added the new physical enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status