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

Version unstable

Represents a product, including information about related collections and product variants.

Required access

read_products access scope.

Connections

  • collections (CollectionConnection!)

    A list of the collections that include 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.

    query ( String )

    Supported filter parameters:

    • collection_type
    • publishable_status
    • published_status
    • title
    • updated_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( CollectionSortKeys )

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

  • images (ImageConnection!)

    The 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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • resourcePublications (ResourcePublicationConnection!)

    The list of resources that are published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

    The list of publications that the resource is not published to.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • A list of variants 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 ( ProductVariantSortKeys )

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

Fields

  • availablePublicationCount (Int!)

    The number of publications a resource is published to without feedback errors.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • createdAt (DateTime!)

    The date and time (ISO 8601 format) when the product was created.

  • defaultCursor (String!)

    A default cursor for use in pagination.

  • description (String!)

    A 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.

  • featuredImage (Image)

    The featured image for the product.

  • featuredMedia (Media)

    The featured media for the product.

  • feedback (ResourceFeedback)

    Information about the product that's provided through resource feedback.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String!)

    A unique human-friendly string of the product's title.

  • hasOnlyDefaultVariant (Boolean!)

    Whether the product has only a single variant with the default option and value.

  • hasOutOfStockVariants (Boolean!)

    Whether the product has out of stock variants.

  • id (ID!)

    Globally unique identifier.

  • inCollection (Boolean!)

    Whether the product is in a given collection.

    Argument Description
    id ( ID! ) required

    The ID of the collection to check.

  • isGiftCard (Boolean!)

    Whether the product is a gift card.

  • legacyResourceId (UnsignedInt64!)

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

  • mediaCount (Int!)

    Total count of media belonging to a product.

  • 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).

  • onlineStorePreviewUrl (URL)

    The online store preview URL.

  • 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!]!)

    A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRangeV2 (ProductPriceRangeV2!)

    The price range of the product with prices formatted as decimals.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • productType (String!)

    The product type specified by the merchant.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedAt (DateTime)

    The date and time (ISO 8601 format) when the product was published to the Online Store.

  • publishedOnCurrentPublication (Boolean!)

    Check to see whether the resource is published to the calling app's publication.

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    The ID of the publication to check.

  • requiresSellingPlan (Boolean!)

    Whether the product can only be purchased with a selling plan.

  • sellingPlanGroupCount (Int!)

    Count of selling plan groups associated with the product.

  • seo (SEO!)

    SEO information of the product.

  • status (ProductStatus!)

    The product status.

  • storefrontId (StorefrontID!)

    The storefront ID of the product.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product.

  • templateSuffix (String)

    The theme template used when viewing the product in a store.

  • title (String!)

    The title of the product.

  • totalInventory (Int!)

    The quantity of inventory in stock.

  • totalVariants (Int!)

    The number of variants that are associated with the product.

  • tracksInventory (Boolean!)

    Whether inventory tracking has been enabled for the product.

  • translations ([PublishedTranslation!]!)

    The translations associated with the resource.

    Argument Description
    locale ( String! ) required

    Filters translations locale.

  • 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.

  • vendor (String!)

    The name of the product's vendor.

Types that return Product

Mutations for Product

Implements

Deprecated fields

  • bodyHtml (String) deprecated

    The description of the product, complete with HTML formatting.

    Deprecation warning

    Use descriptionHtml instead

  • descriptionPlainSummary (String!) deprecated

    Stripped description of the product, single line with HTML tags removed. Truncated to 60 characters.

    Deprecation warning

    Use description instead

  • priceRange (ProductPriceRange!) deprecated

    The price range of the product.

    Deprecation warning

    Deprecated in API version 2020-10. Use priceRangeV2 instead.

  • productPublications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • publications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Return only the publications that are published. If false, then return all publications.
    Default value: true

    reverse ( Boolean )

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

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the resource is published to the calling app's channel.

    Deprecation warning

    Use publishedOnCurrentPublication instead

    Required access

    read_product_listings access scope.

  • unpublishedChannels (ChannelConnection!) deprecated

    The list of channels that the resource is not published to.

    Deprecation warning

    Use unpublishedPublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

Version unstable

An auto-generated type for paginating through multiple Products.

Fields

Types that return Product

Mutations for Product

Version unstable

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

Mutations for Product

Version 2021-04 (Release candidate)

Represents a product, including information about related collections and product variants.

Required access

read_products access scope.

Connections

  • collections (CollectionConnection!)

    A list of the collections that include 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.

    query ( String )

    Supported filter parameters:

    • collection_type
    • publishable_status
    • published_status
    • title
    • updated_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( CollectionSortKeys )

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

  • images (ImageConnection!)

    The 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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • resourcePublications (ResourcePublicationConnection!)

    The list of resources that are published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

    The list of publications that the resource is not published to.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • A list of variants 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 ( ProductVariantSortKeys )

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

Fields

  • availablePublicationCount (Int!)

    The number of publications a resource is published to without feedback errors.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • createdAt (DateTime!)

    The date and time (ISO 8601 format) when the product was created.

  • defaultCursor (String!)

    A default cursor for use in pagination.

  • description (String!)

    A 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.

  • featuredImage (Image)

    The featured image for the product.

  • featuredMedia (Media)

    The featured media for the product.

  • feedback (ResourceFeedback)

    Information about the product that's provided through resource feedback.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String!)

    A unique human-friendly string of the product's title.

  • hasOnlyDefaultVariant (Boolean!)

    Whether the product has only a single variant with the default option and value.

  • hasOutOfStockVariants (Boolean!)

    Whether the product has out of stock variants.

  • id (ID!)

    Globally unique identifier.

  • inCollection (Boolean!)

    Whether the product is in a given collection.

    Argument Description
    id ( ID! ) required

    The ID of the collection to check.

  • isGiftCard (Boolean!)

    Whether the product is a gift card.

  • legacyResourceId (UnsignedInt64!)

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

  • mediaCount (Int!)

    Total count of media belonging to a product.

  • 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).

  • onlineStorePreviewUrl (URL)

    The online store preview URL.

  • 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!]!)

    A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRangeV2 (ProductPriceRangeV2!)

    The price range of the product with prices formatted as decimals.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • productType (String!)

    The product type specified by the merchant.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedAt (DateTime)

    The date and time (ISO 8601 format) when the product was published to the Online Store.

  • publishedOnCurrentPublication (Boolean!)

    Check to see whether the resource is published to the calling app's publication.

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    The ID of the publication to check.

  • requiresSellingPlan (Boolean!)

    Whether the product can only be purchased with a selling plan.

  • sellingPlanGroupCount (Int!)

    Count of selling plan groups associated with the product.

  • seo (SEO!)

    SEO information of the product.

  • status (ProductStatus!)

    The product status.

  • storefrontId (StorefrontID!)

    The storefront ID of the product.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product.

  • templateSuffix (String)

    The theme template used when viewing the product in a store.

  • title (String!)

    The title of the product.

  • totalInventory (Int!)

    The quantity of inventory in stock.

  • totalVariants (Int!)

    The number of variants that are associated with the product.

  • tracksInventory (Boolean!)

    Whether inventory tracking has been enabled for the product.

  • translations ([PublishedTranslation!]!)

    The translations associated with the resource.

    Argument Description
    locale ( String! ) required

    Filters translations locale.

  • 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.

  • vendor (String!)

    The name of the product's vendor.

Types that return Product

Mutations for Product

Implements

Deprecated fields

  • bodyHtml (String) deprecated

    The description of the product, complete with HTML formatting.

    Deprecation warning

    Use descriptionHtml instead

  • descriptionPlainSummary (String!) deprecated

    Stripped description of the product, single line with HTML tags removed. Truncated to 60 characters.

    Deprecation warning

    Use description instead

  • priceRange (ProductPriceRange!) deprecated

    The price range of the product.

    Deprecation warning

    Deprecated in API version 2020-10. Use priceRangeV2 instead.

  • productPublications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • publications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Return only the publications that are published. If false, then return all publications.
    Default value: true

    reverse ( Boolean )

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

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the resource is published to the calling app's channel.

    Deprecation warning

    Use publishedOnCurrentPublication instead

    Required access

    read_product_listings access scope.

  • unpublishedChannels (ChannelConnection!) deprecated

    The list of channels that the resource is not published to.

    Deprecation warning

    Use unpublishedPublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

Version 2021-04 (Release candidate)

An auto-generated type for paginating through multiple Products.

On this page

Fields

Version 2021-04 (Release candidate)

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

Version 2021-01 (Latest)

Represents a product, including information about related collections and product variants.

Required access

read_products access scope.

Connections

  • collections (CollectionConnection!)

    A list of the collections that include 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.

    query ( String )

    Supported filter parameters:

    • collection_type
    • publishable_status
    • published_status
    • title
    • updated_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( CollectionSortKeys )

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

  • images (ImageConnection!)

    The 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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • resourcePublications (ResourcePublicationConnection!)

    The list of resources that are published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

    The list of publications that the resource is not published to.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • A list of variants 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 ( ProductVariantSortKeys )

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

Fields

  • availablePublicationCount (Int!)

    The number of publications a resource is published to without feedback errors.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • createdAt (DateTime!)

    The date and time (ISO 8601 format) when the product was created.

  • defaultCursor (String!)

    A default cursor for use in pagination.

  • description (String!)

    A 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.

  • featuredImage (Image)

    The featured image for the product.

  • featuredMedia (Media)

    The featured media for the product.

  • feedback (ResourceFeedback)

    Information about the product that's provided through resource feedback.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String!)

    A unique human-friendly string of the product's title.

  • hasOnlyDefaultVariant (Boolean!)

    Whether the product has only a single variant with the default option and value.

  • hasOutOfStockVariants (Boolean!)

    Whether the product has out of stock variants.

  • id (ID!)

    Globally unique identifier.

  • inCollection (Boolean!)

    Whether the product is in a given collection.

    Argument Description
    id ( ID! ) required

    The ID of the collection to check.

  • isGiftCard (Boolean!)

    Whether the product is a gift card.

  • legacyResourceId (UnsignedInt64!)

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

  • mediaCount (Int!)

    Total count of media belonging to a product.

  • 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).

  • onlineStorePreviewUrl (URL)

    The online store preview URL.

  • 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!]!)

    A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRangeV2 (ProductPriceRangeV2!)

    The price range of the product with prices formatted as decimals.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • productType (String!)

    The product type specified by the merchant.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedAt (DateTime)

    The date and time (ISO 8601 format) when the product was published to the Online Store.

  • publishedOnCurrentPublication (Boolean!)

    Check to see whether the resource is published to the calling app's publication.

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    The ID of the publication to check.

  • requiresSellingPlan (Boolean!)

    Whether the product can only be purchased with a selling plan.

  • sellingPlanGroupCount (Int!)

    Count of selling plan groups associated with the product.

  • seo (SEO!)

    SEO information of the product.

  • status (ProductStatus!)

    The product status.

  • storefrontId (StorefrontID!)

    The storefront ID of the product.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product.

  • templateSuffix (String)

    The theme template used when viewing the product in a store.

  • title (String!)

    The title of the product.

  • totalInventory (Int!)

    The quantity of inventory in stock.

  • totalVariants (Int!)

    The number of variants that are associated with the product.

  • tracksInventory (Boolean!)

    Whether inventory tracking has been enabled for the product.

  • translations ([PublishedTranslation!]!)

    The translations associated with the resource.

    Argument Description
    locale ( String! ) required

    Filters translations locale.

  • 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.

  • vendor (String!)

    The name of the product's vendor.

Types that return Product

Mutations for Product

Implements

Deprecated fields

  • bodyHtml (String) deprecated

    The description of the product, complete with HTML formatting.

    Deprecation warning

    Use descriptionHtml instead

  • descriptionPlainSummary (String!) deprecated

    Stripped description of the product, single line with HTML tags removed. Truncated to 60 characters.

    Deprecation warning

    Use description instead

  • priceRange (ProductPriceRange!) deprecated

    The price range of the product.

    Deprecation warning

    Deprecated in API version 2020-10. Use priceRangeV2 instead.

  • productPublications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • publications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Return only the publications that are published. If false, then return all publications.
    Default value: true

    reverse ( Boolean )

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

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the resource is published to the calling app's channel.

    Deprecation warning

    Use publishedOnCurrentPublication instead

    Required access

    read_product_listings access scope.

  • unpublishedChannels (ChannelConnection!) deprecated

    The list of channels that the resource is not published to.

    Deprecation warning

    Use unpublishedPublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

Version 2021-01 (Latest)

An auto-generated type for paginating through multiple Products.

On this page

Fields

Version 2021-01 (Latest)

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

Version 2020-10

Represents a product, including information about related collections and product variants.

Required access

read_products access scope.

Connections

  • collections (CollectionConnection!)

    A list of the collections that include 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.

    query ( String )

    Supported filter parameters:

    • collection_type
    • publishable_status
    • published_status
    • title
    • updated_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( CollectionSortKeys )

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

  • images (ImageConnection!)

    The 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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • resourcePublications (ResourcePublicationConnection!)

    The list of resources that are published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • resourcePublicationsV2 (ResourcePublicationV2Connection!)

    The list of resources that are either published or staged to be published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

    The list of publications that the resource is not published to.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • A list of variants 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 ( ProductVariantSortKeys )

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

Fields

  • availablePublicationCount (Int!)

    The number of publications a resource is published to without feedback errors.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • createdAt (DateTime!)

    The date and time (ISO 8601 format) when the product was created.

  • defaultCursor (String!)

    A default cursor for use in pagination.

  • description (String!)

    A 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.

  • featuredImage (Image)

    The featured image for the product.

  • featuredMedia (Media)

    The featured media for the product.

  • feedback (ResourceFeedback)

    Information about the product that's provided through resource feedback.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String!)

    A unique human-friendly string of the product's title.

  • hasOnlyDefaultVariant (Boolean!)

    Whether the product has only a single variant with the default option and value.

  • hasOutOfStockVariants (Boolean!)

    Whether the product has out of stock variants.

  • id (ID!)

    Globally unique identifier.

  • inCollection (Boolean!)

    Whether the product is in a given collection.

    Argument Description
    id ( ID! ) required

    The ID of the collection to check.

  • isGiftCard (Boolean!)

    Whether the product is a gift card.

  • legacyResourceId (UnsignedInt64!)

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

  • mediaCount (Int!)

    Total count of media belonging to a product.

  • 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).

  • onlineStorePreviewUrl (URL)

    The online store preview URL.

  • 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!]!)

    A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • priceRangeV2 (ProductPriceRangeV2!)

    The price range of the product with prices formatted as decimals.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • productType (String!)

    The product type specified by the merchant.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedAt (DateTime)

    The date and time (ISO 8601 format) when the product was published to the Online Store.

  • publishedOnCurrentPublication (Boolean!)

    Check to see whether the resource is published to the calling app's publication.

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    The ID of the publication to check.

  • seo (SEO!)

    SEO information of the product.

  • status (ProductStatus!)

    The product status.

  • storefrontId (StorefrontID!)

    The storefront ID of the product.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product.

  • templateSuffix (String)

    The theme template used when viewing the product in a store.

  • title (String!)

    The title of the product.

  • totalInventory (Int!)

    The quantity of inventory in stock.

  • totalVariants (Int!)

    The number of variants that are associated with the product.

  • tracksInventory (Boolean!)

    Whether inventory tracking has been enabled for the product.

  • translations ([PublishedTranslation!]!)

    The translations associated with the resource.

    Argument Description
    locale ( String! ) required

    Filters translations locale.

  • 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.

  • vendor (String!)

    The name of the product's vendor.

Types that return Product

Mutations for Product

Implements

Deprecated fields

  • bodyHtml (String) deprecated

    The description of the product, complete with HTML formatting.

    Deprecation warning

    Use descriptionHtml instead

  • descriptionPlainSummary (String!) deprecated

    Stripped description of the product, single line with HTML tags removed. Truncated to 60 characters.

    Deprecation warning

    Use description instead

  • priceRange (ProductPriceRange!) deprecated

    The price range of the product.

    Deprecation warning

    Deprecated in API version 2020-10. Use priceRangeV2 instead.

  • productPublications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • publications (ProductPublicationConnection!) deprecated

    A list of the channels where the product is published.

    Deprecation warning

    Use resourcePublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Return only the publications that are published. If false, then return all publications.
    Default value: true

    reverse ( Boolean )

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

  • publishedOnChannel (Boolean!) deprecated

    Check to see whether the resource is published to a given channel.

    Deprecation warning

    Use publishedOnPublication instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    channelId ( ID! ) required

    The ID of the channel to check.

  • publishedOnCurrentChannel (Boolean!) deprecated

    Check to see whether the resource is published to the calling app's channel.

    Deprecation warning

    Use publishedOnCurrentPublication instead

    Required access

    read_product_listings access scope.

  • unpublishedChannels (ChannelConnection!) deprecated

    The list of channels that the resource is not published to.

    Deprecation warning

    Use unpublishedPublications instead

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

Version 2020-10

An auto-generated type for paginating through multiple Products.

On this page

Fields

Version 2020-10

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

Version 2020-07

Represents a product, including information about related collections and product variants.

Required access

read_products access scope.

Connections

  • collections (CollectionConnection!)

    A list of the collections that include 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.

    query ( String )

    Supported filter parameters:

    • collection_type
    • publishable_status
    • published_status
    • title
    • updated_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( CollectionSortKeys )

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

  • images (ImageConnection!)

    The 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 )

    Finds all metafields with a specific namespace under the resource.

    reverse ( Boolean )

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

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields.

    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 )

    Filter the private metafields by namespace.

    reverse ( Boolean )

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

  • resourcePublications (ResourcePublicationConnection!)

    The list of resources that are published to a publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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.

    onlyPublished ( Boolean )

    Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
    Default value: true

    reverse ( Boolean )

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

  • unpublishedPublications (PublicationConnection!)

    The list of publications that the resource is not published to.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    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

  • A list of variants 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 ( ProductVariantSortKeys )

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

Fields

  • availablePublicationCount (Int!)

    The number of publications a resource is published to without feedback errors.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

  • createdAt (DateTime!)

    The date and time (ISO 8601 format) when the product was created.

  • defaultCursor (String!)

    A default cursor for use in pagination.

  • description (String!)

    A 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.

  • featuredImage (Image)

    The featured image for the product.

  • featuredMedia (Media)

    The featured media for the product.

  • feedback (ResourceFeedback)

    Information about the product that's provided through resource feedback.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String!)

    A unique human-friendly string of the product's title.

  • hasOnlyDefaultVariant (Boolean!)

    Whether the product has only a single variant with the default option and value.

  • hasOutOfStockVariants (Boolean!)

    Whether the product has out of stock variants.

  • id (ID!)

    Globally unique identifier.

  • inCollection (Boolean!)

    Whether the product is in a given collection.

    Argument Description
    id ( ID! ) required

    The ID of the collection to check.

  • isGiftCard (Boolean!)

    Whether the product is a gift card.

  • legacyResourceId (UnsignedInt64!)

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

  • mediaCount (Int!)

    Total count of media belonging to a product.

  • 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).

  • onlineStorePreviewUrl (URL)

    The online store preview URL.

  • 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!]!)

    A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.

    Argument Description
    first ( Int )

    Truncate the array result to this size.

  • privateMetafield (PrivateMetafield)

    Returns a private metafield found by namespace and key.

    Argument Description
    key ( String! ) required

    The key for the private metafield.

    namespace ( String! ) required

    The namespace for the private metafield.

  • productType (String!)

    The product type specified by the merchant.

  • publicationCount (Int!)

    The number of publications a resource is published on.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    onlyPublished ( Boolean )

    Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
    Default value: true

  • publishedAt (DateTime)

    The date and time (ISO 8601 format) when the product was published to the Online Store.

  • publishedOnCurrentPublication (Boolean!)

    Check to see whether the resource is published to the calling app's publication.

    Required access

    read_product_listings access scope.

  • publishedOnPublication (Boolean!)

    Check to see whether the resource is published to a given publication.

    Required access

    read_publications access scope. This scope is currently available only to private apps installed on Shopify Plus stores.

    Argument Description
    publicationId ( ID! ) required

    The ID of the publication to check.

  • seo (SEO!)

    SEO information of the product.

  • storefrontId (StorefrontID!)

    The storefront ID of the product.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the product.

  • templateSuffix (String)

    The theme template used when viewing the product in a store.

  • title (String!)

    The title of the product.

  • totalInventory (Int!)

    The quantity of inventory in stock.

  • totalVariants (Int!)

    The number of variants that are associated with the product.

  • tracksInventory (Boolean!)

    Whether inventory tracking has been enabled for the product.

  • translations ([PublishedTranslation!]!)

    The translations associated with the resource.

    Argument Description
    locale ( String! ) required

    Filters translations locale.