Product Variants

{
  id: "00000000-0000-0000-0000-000000000000",
  remoteId: "200100200100",
  productId: "00112233-4455-6677-8899-aabbccddeeff",
  remoteCreatedAt: "2023-11-19T17:00:17.000Z",
  remoteUpdatedAt: "2023-11-19T17:00:17.000Z",
  remoteDeleted: false,
  createdAt: "2024-02-22T11:17:53.264Z",
  updatedAt: "2024-02-22T13:54:03.445Z"
  title: "Medium",
  price: "25.00",
  sku: "SHIRT-M",
  optionValues: [
    {
      name: "Size", 
      value: "Medium"
    }
  ],
  inventory: {
    totalCount: 50
  },
  weight: [
    {
      value: 9.525451098148434,
      unit: "kg"
    },
    {
      value: 9525.451098148435,
      unit: "g"
    },
    {
      value: 336.00076203608785,
      unit: "oz"
    },
    {
      value: 20.999999999999996,
      unit: "lb"
    }
  ]
}

Properties

idString

The unique identifier for this variant of the product.

remoteIdString

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

productIdString

The unique identifier for the product this variant belongs to.

title String read-only

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.

remoteCreatedAtDateTime

The exact date and time when the record was first added or created in the third-party application.

remoteUpdatedAtDateTime

The latest date and time when any modifications or updates were made to the record's details in the third-party application.

remoteDeletedBoolean

Flag to indicate that the record has been deleted in the third-party application.

createdAtDateTime

Date and time the record has been synced into the data cache.

updatedAtDateTime

Date and time the record has been updated in the data cache.

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.