Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Variant

OBJECTVariant
Fields
idString!
productIdString!
skuString!
nameString!

Variant name (locale-aware if locale parameter provided)

variantDimensionsVariantDimensions
customFields[CustomField!]!
shippingAttributes[String!]!
variantAttributes[Attribute!]!
validateStockBoolean!
images[Image!]!
createdAtDateTime!
updatedAtDateTime
variantGroupIdString
Example JSON
{
  "id": "string",
  "productId": "string",
  "sku": "string",
  "name": "string",
  "status": "ACTIVE",
  "variantDimensions": {
    "capacityMilliliter": 0,
    "depth": 0,
    "diameter": 0,
    "height": 0,
    "length": 0,
    "weight": 0,
    "width": 0
  },
  "customFields": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "shippingAttributes": [
    "string"
  ],
  "variantAttributes": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "templateKey": "string",
      "filterable": true,
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "validateStock": true,
  "prices": [
    {
      "id": "string",
      "variantId": "string",
      "storeGroupId": "string",
      "storeGroupSlug": "string",
      "marketId": "string",
      "marketSlug": "string",
      "saleStartDate": null,
      "saleEndDate": null,
      "priceWithTax": 0,
      "salePriceWithTax": 0,
      "referencePriceWithTax": 0,
      "onSale": true,
      "currencyCode": "string",
      "status": "string",
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "stock": [
    {
      "variantId": "string",
      "warehouseId": "string",
      "warehouseSlug": "string",
      "quantity": 0,
      "inventoryDate": null,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "images": [
    {
      "id": "string",
      "url": "string",
      "title": "string",
      "altText": "string",
      "copyright": "string",
      "sort": 0,
      "status": "ACTIVE",
      "blurhash": "string",
      "createdWithAi": true,
      "createdAt": "string",
      "updatedAt": null
    }
  ],
  "tags": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "filterable": true,
      "status": "string",
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "createdAt": "string",
  "updatedAt": null,
  "variantGroupId": "string"
}
Used by