Product variants
List of the product variants.
|
Field |
Description |
|---|---|
|
Available for sale |
Whether the product variant is available for sale. |
|
Barcode |
The value of the barcode associated with the product. |
|
Compare-at price |
The compare-at price of the variant in the default shop currency. |
|
Created at |
The date and time when the variant was created. |
|
Display name |
Display name of the variant, based on product's title + variant's title. |
|
ID |
Globally unique ID. |
|
Inventory policy |
Whether customers are allowed to place an order for the product variant when it's out of stock. |
|
Inventory quantity |
The total sellable quantity of the variant. |
|
Legacy resource ID |
The ID of the corresponding resource in the REST Admin API. |
|
Position |
The order of the product variant in the list of product variants. The first position in the list is 1. |
|
Price |
The price of the product variant in the default shop currency. |
|
Product ID |
The ID of the product that this variant belongs to. |
|
SKU |
An identifier for the product variant in the shop. Required in order to connect to a fulfillment service. |
|
Storefront ID |
The storefront ID of the product variant. |
|
Tax code |
The tax code for the product variant. |
|
Taxable |
Whether a tax is charged when the product variant is sold. |
|
Title |
The title of the product variant. |
|
Updated at |
The date and time when the product variant was last modified. |
Product variants / Image
The featured image for the variant.
|
Field |
Description |
|---|---|
|
Alt text |
A word or phrase to share the nature or contents of an image. |
|
ID |
Globally unique ID. |
|
Original src |
The location of the original image as a URL. |
|
Transformed src |
The location of the transformed image as a URL. |
Product variants / Metafields
A list of metafields that belong to the resource.
|
Field |
Description |
|---|---|
|
Description |
The description of a metafield. |
|
Key |
The key name for a metafield. |
|
Legacy resource ID |
The ID of the corresponding resource in the REST Admin API. |
|
Metafield ID |
Globally unique ID. |
|
Namespace |
The namespace for a metafield. |
|
Owner type |
Owner type of a metafield visible to the Storefront API. |
|
Type |
The type of data that the metafield stores in the value field. |
|
Value |
The value of a metafield. |
Product variants / Selected options
List of product options applied to the variant.
|
Field |
Description |
|---|---|
|
Name |
The product option’s name. |
|
Value |
The product option’s value. |