Product variants

List of the product variants.

Field

Description

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.

Weight

The weight of the product variant in the unit system specified with weight_unit.

Weight unit

The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: g, kg, oz, lb.

The fulfillment service associated with the product.

Field

Description

Field

Description

Fulfillment orders opt-in

Whether the fulfillment service has opted into fulfillment order based requests.

Handle

Human-readable unique identifier for this fulfillment service.

ID

Globally unique ID.

Inventory management

Whether the fulfillment service tracks product inventory and provides updates to Shopify.

Product based

Whether the fulfillment service supports local deliveries.

Service name

The name of the fulfillment service as seen by merchants.

Type

Type associated with the fulfillment service.

Location associated with the fulfillment service.

Field

Description

Field

Description

Activatable

Whether this location can be reactivated.

Address verified

Whether the location address has been verified.

Deactivatable

Whether this location can be deactivated.

Deactivated at

Date and time the location was deactivated (null if location is still active).

Deletable

Whether this location can be deleted.

Fulfills online orders

Indicates whether this location can fulfill online orders.

Has active inventory

Indicates whether or not this location has active inventory.

Has unfulfilled orders

Indicates whether or not this location has unfulfilled orders.

ID

Globally unique ID.

Is active

Whether the location is active.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Name

The name of the location.

Ships inventory

Indicates whether or not this location is used for calculating shipping rates.

Whether changes to the fulfillment service for the product variant are allowed.

Field

Description

Field

Description

Locked

Whether the attribute is locked for editing.

Reason

The reason the attribute is locked for editing.

The featured image for the variant.

Field

Description

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.

A list of metafields that belong to the resource.

Field

Description

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.

List of product options applied to the variant.

Field

Description

Field

Description

Name

The product option’s name.

Value

The product option’s value.