[Commerce] Product Variants

The product variant object contains information such as their title, sku, etc.

{
  id: "00000000-0000-0000-0000-000000000000",
  remoteId: "39302373802042",
  createdTimestamp: 1618321872,
  updatedTimestamp: 1683179792,
  productId: "00000000-0000-0000-0000-000000000000",
  title: "Blue",
  price: "1000.00",
  sku: "shirt-01-b",
  optionValues: [
    {
      name: "Color",
      value: "Blue"
    }
  ],
  inventory: {
    totalCount: 93
  },
  weight: {
    value: 100, 
    unit: "kg"
  }
}

Properties


idString

The unique identifier for this variant of the product.


remoteIdString

The ID of the object in the third-party application.


createdTimestampNumber

The Unix timestamp representing when this product variant was created.


updatedTimestampNumber

The Unix timestamp representing when this product variant was last updated.


productIdString

The unique identifier for the product this variant belongs to.


titleString

The name or title of this product variant.


priceString

The price of this product variant.


skuString

The SKU (stock-keeping unit) of this product variant.


optionValuesObject[]

An array containing objects representing the option name and value for this variant, e.g. color: blue.


inventoryObject

An object containing inventory information for this variant, such as the total count available.


weightObject

An object containing the weight and unit of measurement for this variant.


Option Value Object Properties


nameString

The name of the variant option. (e.g. color, size)


valueString

The value of the variant option. (e.g. blue, medium)


Inventory Object Properties

totalCountNumber

The total count of the variant in inventory.


Weight Object Properties

valueNumber

The weight value of the variant.


unitString

The weight unit of the variant.