API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Product object

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductMediaSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • seo (SEO!)

    The product's SEO information.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

Fields

Types that return Product

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return Product

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductMediaSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • seo (SEO!)

    The product's SEO information.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductMediaSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • seo (SEO!)

    The product's SEO information.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • compareAtPriceRange (ProductPriceRange!)

    The compare at price of the product across all variants.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • totalInventory (Int)

    The total quantity of inventory in stock for this Product.

    Required access

    unauthenticated_read_product_inventory access scope.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge

A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty).

Required access

unauthenticated_read_product_listings access scope.

Connections

  • collections (CollectionConnection!)

    List of collections a product belongs to.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • images (ImageConnection!)

    List of images associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    crop ( CropRegion )

    Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.
    Default value: 1

    sortKey ( ProductImageSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

  • The media associated with the product.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    A paginated list of metafields associated with the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    Container for a set of metafields (maximum of 20 characters).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • presentmentPriceRanges (ProductPriceRangeConnection!)

    List of price ranges in the presentment currencies for this shop.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    presentmentCurrencies ( [CurrencyCode!] )

    Specifies the presentment currencies to return a price range in.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • List of the product’s variants.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( ProductVariantSortKeys )

    Sort the underlying list by the given key.
    Default value: POSITION

Fields

  • availableForSale (Boolean!)

    Indicates if at least one product variant is available for sale.

  • createdAt (DateTime!)

    The date and time when the product was created.

  • description (String!)

    Stripped description of the product, single line with HTML tags removed.

    Argument Description
    truncateAt ( Int )

    Truncates string after the given length.

  • descriptionHtml (HTML!)

    The description of the product, complete with HTML formatting.

  • handle (String!)

    A human-friendly unique string for the Product automatically generated from its title. They are used by the Liquid templating language to refer to objects.

  • id (ID!)

    Globally unique identifier.

  • metafield (Metafield)

    The metafield associated with the resource.

    Argument Description
    key ( String! ) required

    Identifier for the metafield (maximum of 30 characters).

    namespace ( String! ) required

    Container for a set of metafields (maximum of 20 characters).

  • onlineStoreUrl (URL)

    The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.

  • options ([ProductOption!]!)

    List of product options.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRange (ProductPriceRange!)

    The price range.

  • productType (String!)

    A categorization that a product can be tagged with, commonly used for filtering and searching.

  • publishedAt (DateTime!)

    The date and time when the product was published to the channel.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product. Additional access scope required for private apps: unauthenticated_read_product_tags.

  • title (String!)

    The product’s title.

  • updatedAt (DateTime!)

    The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

  • variantBySelectedOptions (ProductVariant)

    Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

    Argument Description
    selectedOptions ( [SelectedOptionInput!]! ) required

    The input fields used for a selected option.

  • vendor (String!)

    The product’s vendor name.

Types that return Product

Implements

An auto-generated type for paginating through multiple Products.

On this page

Fields

An auto-generated type which holds one Product and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Product!)

    The item at the end of ProductEdge.

Types that return ProductEdge