Skip to main content
This collection models sellable item-level SKUs, scoped under products. Each variant contains detailed merchandising attributes, pricing, inventory summaries, channel-level configurations, media assets, and external integrations. It acts as the core transactional and fulfillment unit in most retail systems.
The users will be able to search product variants by selecting the correct filter.
Field NameData TypeDescriptionNested Fields
_idobjectIdUnique identifier for document0
variant_idstringUnique identifier for variant0
product_idstringReference to the parent product.0
skustringThe unique Stock Keeping Unit for this specific variant0
NamestringThe full name of the variant.0
list_priceobjectPrice information for the variant2
list_price.amountstringField for amount0
list_price.currencystringField for currency0
variationsobjectObject containing the variant’s differentiating details2
variations.colorstringField for color0
variations.materialstringField for material0
physical_attributesobjectWeight and dimensions of the variant.6
physical_attributes .weightintegerField for weight0
physical_attributes .weight_unitstringField for weight unit0
physical_attributes .lengthintegerField for length0
physical_attributes .widthfloatUnique identifier for width0
physical_attributes .heightfloatField for height0
physical_attributes .dimension_unitstringField for dimension unit0
inventory_summaryarray_of_objectsA denormalized summary of stock levels at each location6
inventory_summary.location_idstringUnique Identifier of where the inventory is located0
inventory_summary.sellableintegerDescribes total inventory at a particular location available for sale0
inventory_summary.location_namestringName of Location0
inventory_summary.location_typestringField for Location type0
inventory_summary.totalintegerField for total0
inventory_summary.reservedintegerField for reserved0
sales_channelsarray_of_objectsRules for how this variant is sold on each channel9
sales_channels.channel_idstringUnique identifier for channel0
sales_channels.channel_namestringIdentifies channel name0
sales_channels.is_visiblebooleanField for is visible0
sales_channels.is_backorderablebooleanField for is backorderable0
sales_channels.discountablebooleanField for discountable0
sales_channels.min_order_quantityintegerQuantity of min order0
sales_channels.max_order_quantityintegerQuantity of max order0
sales_channels.shipping_classstringField for shipping class0
sales_channels.fulfillment_typestringField for fulfillment type0
external_identifiersarray_of_objectsIDs for this variant in external systems.5
External_identifiers.source_systemstringName of external system0
external_identifiers.identifierstringUnique identifier for identifier0
external_identifiers.created_at_from_sourcedatetimeTimestamp for when created at from source was created/updated0
external_identifiers.last_updated_from_sourcedatetimeTimestamp for when last updated from source was created/updated0
external_identifiers.updated_by_from_sourcestringTimestamp for when updated by from source was created/updated0
mediaarray_of_objectsImages or videos specific to this variant.4
media.typestringSpecifies category of media0
media.urlstringSpecifies media URL0
media.alt_textstringField for alt text0
media.is_primaryboolean0
variation_typestringThe combination of attributes that define this variant0
created_atdatetimeTimestamp when the record was created0
updated_atdatetimeTimestamp when the record was updated0
statusstringThe current status of the variant.0
deletedbooleanSoft delete flag0
brandobjectDenormalized brand information from the parent product.2
brand.idstringUnique identifier for id0
brand.namestringName of brand0
inventory_typestringThe type of inventory0
last_updateddatetimeTimestamp of the last update0
lifecycle_statusstringCurrent status of lifecycle0
sellableintegerField for sellable0
TotalintegerField for total0
 
{
  "variant_id": "b57f10f1-3200-480c-95be-59d90309df47",
  "product_id": "ce0c0f12-4dee-40ea-9605-a721c23766c1",
  "sku": "AVIATOR-BLK-METAL",
  "name": "Luxe Aviator Sunglasses - Black / Metal",
  "list_price": {
    "amount": "109.00",
    "currency": "USD"
  },
  "variations": {
    "color": "Black",
    "material": "Metal"
  },
  "physical_attributes": {
    "weight": 150,
    "weight_unit": "g",
    "length": 14,
    "width": 5.5,
    "height": 4.2,
    "dimension_unit": "cm"
  },
  "inventory_summary": [
    {
      "location_id": "9479cd9f-929c-4a5c-93ea-fc96c7751032",
      "location_name": "Unknown",
      "location_type": "warehouse",
      "total": 3262,
      "sellable": 3259,
      "reserved": 3
    },
    {
      "location_id": "ea753e16-62dd-42bc-9523-d351b4f4ce1f",
      "location_name": "Unknown",
      "location_type": "warehouse",
      "total": 383,
      "sellable": 355,
      "reserved": 28
    },
    {
      "location_id": "a6320a75-40bf-4958-99a0-3d6318c5b86c",
      "location_name": "Unknown",
      "location_type": "warehouse",
      "total": 39,
      "sellable": 38,
      "reserved": 1
    }
  ],
  "sales_channels": [
    {
      "channel_id": "b8a3e7e4-3e4d-4f1a-9c6f-8e4d3e4d3e4d",
      "channel_name": "ecommerce_website",
      "is_visible": true,
      "is_backorderable": true,
      "discountable": true,
      "min_order_quantity": 1,
      "max_order_quantity": 50,
      "shipping_class": "standard",
      "fulfillment_type": "in-house"
    },
    {
      "channel_id": "c9b4f8f5-4f5e-5g2b-ad7g-9f5e4f5e4f5e",
      "channel_name": "amazon_marketplace",
      "is_visible": false,
      "is_backorderable": false,
      "discountable": false,
      "min_order_quantity": 1,
      "max_order_quantity": 10,
      "shipping_class": "standard",
      "fulfillment_type": "FBA"
    }
  ],
  "external_identifiers": [
    {
      "source_system": "Fulfillment_ShipMonk",
      "identifier": "SMK-836213",
      "created_at_from_source": "2024-10-10T00:00:00.000000Z",
      "last_updated_from_source": "2025-02-03T00:00:00.000000Z",
      "updated_by_from_source": "dwebb"
    },
    {
      "source_system": "Ecommerce_Shopify",
      "identifier": "SHOP-349873",
      "created_at_from_source": "2024-09-03T00:00:00.000000Z",
      "last_updated_from_source": "2024-09-05T00:00:00.000000Z",
      "updated_by_from_source": "lisac"
    },
    {
      "source_system": "ERP_NetSuite",
      "identifier": "NS-278927",
      "created_at_from_source": "2024-08-28T00:00:00.000000Z",
      "last_updated_from_source": "2025-06-27T00:00:00.000000Z",
      "updated_by_from_source": "chrisb"
    },
    {
      "source_system": "Analytics_Snowflake",
      "identifier": "SNOW-43708",
      "created_at_from_source": "2025-04-25T00:00:00.000000Z",
      "last_updated_from_source": "2025-06-04T00:00:00.000000Z",
      "updated_by_from_source": "deborahwalker"
    }
  ],
  "media": [
    {
      "type": "image",
      "url": "https://example.com/images/aviator-black-metal-front.jpg",
      "alt_text": "Black metal aviator sunglasses, front view",
      "is_primary": true
    },
    {
      "type": "image",
      "url": "https://example.com/images/aviator-black-metal-side.jpg",
      "alt_text": "Black metal aviator sunglasses, side view",
      "is_primary": false
    }
  ],
  "variation_type": "color,material",
  "created_at": {
    "$date": "2025-06-28T19:10:42.000Z"
  },
  "updated_at": {
    "$date": "2025-09-03T14:09:46.820Z"
  },
  "status": "active",
  "deleted": false,
  "brand": {
    "id": "a009c154-c397-4b94-9812-24eafe8ca9e8",
    "name": "Verve & Velvet"
  },
  "inventory_type": "luxury",
  "last_updated": {
    "$date": "2025-08-20T23:35:52.210Z"
  },
  "lifecycle_status": "new",
  "sellable": 2416,
  "total": 2416
}