Skip to main content
Anchor to HasPublishedTranslations

HasPublishedTranslations

interface

Published translations associated with the resource.

•[Translation!]!
non-null

The published translations associated with the resource.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to ArticleArticle
•OBJECT

An article in the blogging system.

•ArticleAuthor

The name of the author of the article.

•Blog!
non-null

The blog containing the article.

•HTML!
non-null

The text of the article's body, complete with HTML markup.

•CommentConnection!
non-null

List of the article's comments.

•Count

Count of comments. Limited to a maximum of 10000 by default.

•DateTime!
non-null

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

•String!
non-null

A default cursor that returns the single next record, sorted ascending by ID.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String!
non-null

A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

•ID!
non-null

A globally-unique ID.

•Image

The image associated with the article.

•Boolean!
non-null

Whether or not the article is visible.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•DateTime

The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.

•HTML

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

•[String!]!
non-null

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

•String

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

•String!
non-null

The title of the article.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime

The date and time (ISO 8601 format) when the article was last updated.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.

•ArticleConnection!
non-null

List of the blog's articles.

•Count

Count of articles. Limited to a maximum of 10000 by default.

•CommentPolicy!
non-null

Indicates whether readers can post comments to the blog and if comments are moderated or not.

•DateTime!
non-null

The date and time when the blog was created.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•BlogFeed

FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.

•String!
non-null

A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog.

•ID!
non-null

A globally-unique ID.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•[String!]!
non-null

A list of tags associated with the 200 most recent blog articles.

•String

The name of the template a blog is using if it's using an alternate template. Returns null if a blog is using the default blog.liquid template.

•String!
non-null

The title of the blog.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime

The date and time when the blog was update.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.

There are two types of collections:

The Collection object provides information to:

  • Organize products by category, season, or promotion.
  • Automate product grouping using rules (for example, by tag, type, or price).
  • Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).
  • Manage collection visibility and publication across sales channels.
  • Add rich descriptions, images, and metadata to enhance discovery.

Note

Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.


Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.

Learn about using metafields with smart collections.

Anchor to availablePublicationsCountavailablePublicationsCount
•Count

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

•String!
non-null

A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•ResourceFeedback

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

•String!
non-null

A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title Summer Catalog 2022 might have the handle summer-catalog-2022.

If the title is changed, the handle doesn't automatically change.

The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.

•Boolean!
non-null

Whether the collection includes the specified product.

Arguments

•ID!
required

The ID of the product to check.


•ID!
non-null

A globally-unique ID.

•Image

The image associated with the collection.

•UnsignedInt64!
non-null

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

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•ProductConnection!
non-null

The products that are included in the collection.

•Count

The number of products in the collection.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication
•Boolean!
non-null

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

Anchor to publishedOnPublicationpublishedOnPublication
•Boolean!
non-null

Whether the resource is published to a specified publication.

Arguments

•ID!
required

The ID of the publication to check. For example, id: "gid://shopify/Publication/123".


Anchor to resourcePublicationsresourcePublications
•ResourcePublicationConnection!
non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount
•Count

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

Anchor to resourcePublicationsV2resourcePublicationsV2
•ResourcePublicationV2Connection!
non-null

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

•CollectionRuleSet

For a smart (automated) collection, specifies the rules that determine whether a product is included.

•SEO!
non-null

If the default SEO fields for page title and description have been modified, contains the modified information.

•CollectionSortOrder!
non-null

The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

•String

The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid template.

•String!
non-null

The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.

•[Translation!]!
non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications
•PublicationConnection!
non-null

The list of publications that the resource isn't published to.

•DateTime!
non-null

The date and time (ISO 8601 format) when the collection was last modified.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•Int!
non-nullDeprecated

Arguments

•Boolean
Default:true

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


•CollectionPublicationConnection!
non-nullDeprecated
•Boolean!
non-nullDeprecated

Arguments

•ID!
required

The ID of the channel to check.


Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel
•Boolean!
non-nullDeprecated
•StorefrontID!
non-nullDeprecated
•ChannelConnection!
non-nullDeprecated
•OBJECT

A shop's banner settings.

•Boolean!
non-null

Indicates if the banner is auto managed.

•Boolean!
non-null

Indicates if the banner is enabled.

•[Translation!]!
non-null

The published translations associated with the resource.

•OBJECT

A link to direct users to.

•String!
non-null

A context-sensitive label for the link.

•[Translation!]!
non-null

The published translations associated with the resource.

•URL!
non-null

The URL that the link visits.

•OBJECT

A menu for display on the storefront.

•String!
non-null

The menu's handle.

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted.

•[MenuItem!]!
non-null

A list of items on the menu sorted by position.

•String!
non-null

The menu's title.

•[Translation!]!
non-null

The published translations associated with the resource.

•OBJECT

A theme for display on the storefront.

•DateTime!
non-null

The date and time when the theme was created.

•OnlineStoreThemeFileConnection

The files in the theme.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The name of the theme, set by the merchant.

•String!
non-null

The prefix of the theme.

•Boolean!
non-null

Whether the theme is processing.

•Boolean!
non-null

Whether the theme processing failed.

•ThemeRole!
non-null

The role of the theme.

•Int

The theme store ID.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime!
non-null

The date and time when the theme was last updated.

•OBJECT

A page on the Online Store.

•HTML!
non-null

The text content of the page, complete with HTML markup.

•String!
non-null

The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.

•DateTime!
non-null

The date and time (ISO 8601 format) of the page creation.

•String!
non-null

A default cursor that returns the single next record, sorted ascending by ID.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•String!
non-null

A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether or not the page is visible.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•DateTime

The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.

•String

The suffix of the template that's used to render the page.

•String!
non-null

Title of the page.

•[Translation!]!
non-null

The published translations associated with the resource.

•DateTime!
non-null

The date and time (ISO 8601 format) of the latest page update.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

The Product object lets you manage products in a merchant’s store.

Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use product variants to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.

Learn more about working with Shopify's product model, including limitations and considerations.

Anchor to availablePublicationsCountavailablePublicationsCount
•Count

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

•ProductBundleComponentConnection!
non-null

A list of components that are associated with a product in a bundle.

•TaxonomyCategory

The category of a product from Shopify's Standard Product Taxonomy.

•CollectionConnection!
non-null

A list of collections that include the product.

•CombinedListing

A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.

•CombinedListingsRole

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.

•ProductCompareAtPriceRange

The compare-at price range of the product in the shop's default currency.

•ProductContextualPricing!
non-null

The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. Only active markets are considered in the price resolution.

•DateTime!
non-null

The date and time when the product was created.

•String!
non-null

A default cursor that returns the single next record, sorted ascending by ID.

•String!
non-null

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

Arguments

•Int

Truncates a string after the given length.


•HTML!
non-null

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•Media

The featured media associated with the product.

•ResourceFeedback

The information that lets merchants know what steps they need to take to make sure that the app is set up correctly.

For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product".

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix
•String

The theme template that's used when customers view the gift card in a store.

•String!
non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but no spaces. The handle is used in the online store URL for the product.

Anchor to hasOnlyDefaultVarianthasOnlyDefaultVariant
•Boolean!
non-null

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

Anchor to hasOutOfStockVariantshasOutOfStockVariants
•Boolean!
non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents
•Boolean!
non-null

Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.

•ID!
non-null

A globally-unique ID.

•Boolean!
non-null

Whether the product is in a specified collection.

Arguments

•ID!
required

The ID of the collection to check. For example, id: "gid://shopify/Collection/123".


•Boolean!
non-null

Whether the product is a gift card.

•UnsignedInt64!
non-null

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

•MediaConnection!
non-null

The media associated with the product. Valid media are images, 3D models, videos.

•Count

The total count of media that's associated with a product.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl
•URL

The preview URL for the online store.

•URL

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

•[ProductOption!]!
non-null

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

•ProductPriceRangeV2!
non-null

The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.

•ProductComponentTypeConnection!
non-null

A list of products that contain at least one variant associated with at least one of the current products' variants via group relationship.

Anchor to productComponentsCountproductComponentsCount
•Count

A count of unique products that contain at least one variant associated with at least one of the current products' variants via group relationship.

•ProductConnection!
non-null

A list of products that has a variant that contains any of this product's variants as a component.

•String!
non-null

The product type that merchants define.

•DateTime

The date and time when the product was published to the online store.

•Boolean!
non-null

Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.

Arguments

•ContextualPublicationContext!
required

The context used to determine publication status.


Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication
•Boolean!
non-null

Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.

Anchor to publishedOnPublicationpublishedOnPublication
•Boolean!
non-null

Whether the resource is published to a specified publication.

Arguments

•ID!
required

The ID of the publication to check. For example, id: "gid://shopify/Publication/123".


•Boolean!
non-null

Whether the product can only be purchased with a selling plan. Products that are sold on subscription (requiresSellingPlan: true) can be updated only for online stores. If you update a product to be subscription-only (requiresSellingPlan:false), then the product is unpublished from all channels, except the online store.

Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication
•ResourcePublicationV2

The resource that's either published or staged to be published to the publication.

Anchor to resourcePublicationsresourcePublications
•ResourcePublicationConnection!
non-null

The list of resources that are published to a publication.

Anchor to resourcePublicationsCountresourcePublicationsCount
•Count

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

Anchor to resourcePublicationsV2resourcePublicationsV2
•ResourcePublicationV2Connection!
non-null

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

Anchor to restrictedForResourcerestrictedForResource
•RestrictedForResource

Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.

•SellingPlanGroupConnection!
non-null

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount
•Count

A count of selling plan groups that are associated with the product.

•SEO!
non-null

The SEO title and description that are associated with a product.

•ProductStatus!
non-null

The product status, which controls visibility across all sales channels.

•[String!]!
non-null

A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the sports and summer tags to products that are associated with sportwear for summer.

Updating tags overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the tagsAdd mutation.

•String

The theme template that's used when customers view the product in a store.

•String!
non-null

The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

•Int!
non-null

The quantity of inventory that's in stock.

•Boolean!
non-null

Whether inventory tracking has been enabled for the product.

•[Translation!]!
non-null

The published translations associated with the resource.

Anchor to unpublishedPublicationsunpublishedPublications
•PublicationConnection!
non-null

The list of publications that the resource isn't published to.

•DateTime!
non-null

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.

•ProductVariantConnection!
non-null

A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2000 variants.

•Count

The number of variants that are associated with the product.

•String!
non-null

The name of the product's vendor.

•String
Deprecated
•String
Deprecated
Anchor to descriptionPlainSummarydescriptionPlainSummary
•String!
non-nullDeprecated
•Image
Deprecated
•ImageConnection!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•ProductPriceRange!
non-nullDeprecated
•ProductCategory
Deprecated
•ProductPublicationConnection!
non-nullDeprecated
•Int!
non-nullDeprecated

Arguments

•Boolean
Default:true

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


•ProductPublicationConnection!
non-nullDeprecated
•Boolean!
non-nullDeprecated

Arguments

•ID!
required

The ID of the channel to check.


Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel
•Boolean!
non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount
•Int!
non-nullDeprecated
Anchor to standardizedProductTypestandardizedProductType
•StandardizedProductType
Deprecated
•StorefrontID!
non-nullDeprecated
•Int!
non-nullDeprecated
•ChannelConnection!
non-nullDeprecated
•OBJECT

The product property names. For example, "Size", "Color", and "Material". Variants are selected based on permutations of these options. The limit for each product property name is 255 characters.

•ID!
non-null

A globally-unique ID.

•LinkedMetafield

The metafield identifier linked to this option.

•String!
non-null

The product option’s name.

•[ProductOptionValue!]!
non-null

Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.

•Int!
non-null

The product option's position.

•[Translation!]!
non-null

The published translations associated with the resource.

•[String!]!
non-null

The corresponding value to the product option name.

•OBJECT

The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option.

•Boolean!
non-null

Whether the product option value has any linked variants.

•ID!
non-null

A globally-unique ID.

Anchor to linkedMetafieldValuelinkedMetafieldValue
•String

The value of the linked metafield.

•String!
non-null

The name of the product option value.

•ProductOptionValueSwatch

The swatch associated with the product option value.

•[Translation!]!
non-null

The published translations associated with the resource.

•OBJECT

The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

  • Tracking inventory for each variant
  • Setting unique prices for each variant
  • Assigning barcodes and SKUs to connect variants to fulfillment services
  • Attaching variant-specific images and media
  • Setting delivery and tax requirements
  • Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

Learn more about Shopify's product model.

•Boolean!
non-null

Whether the product variant is available for sale.

•String

The value of the barcode associated with the product.

•Money

The compare-at price of the variant in the default shop currency.

•ProductVariantContextualPricing!
non-null

The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution.

•DateTime!
non-null

The date and time when the variant was created.

•String!
non-null

A default cursor that returns the single next record, sorted ascending by ID.

•DeliveryProfile

The delivery profile for the variant.

•String!
non-null

Display name of the variant, based on product's title + variant's title.

•EventConnection!
non-null

The paginated list of events associated with the host subject.

•ID!
non-null

A globally-unique ID.

•Image

The featured image for the variant.

•InventoryItem!
non-null

The inventory item, which is used to query for inventory information.

•ProductVariantInventoryPolicy!
non-null

Whether customers are allowed to place an order for the product variant when it's out of stock.

•Int

The total sellable quantity of the variant.

•UnsignedInt64!
non-null

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

•MediaConnection!
non-null

The media associated with the product variant.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•Int!
non-null

The order of the product variant in the list of product variants. The first position in the list is 1.

•Money!
non-null

The price of the product variant in the default shop currency.

•Product!
non-null

The product that this variant belongs to.

•ProductConnection!
non-null

A list of products that have product variants that contain this variant as a product component.

Anchor to productVariantComponentsproductVariantComponents
•ProductVariantComponentConnection!
non-null

A list of the product variant components.

•Boolean!
non-null

Whether a product variant requires components. The default value is false. If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles.

•[SelectedOption!]!
non-null

List of product options applied to the variant.

Anchor to sellableOnlineQuantitysellableOnlineQuantity
•Int!
non-null

The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.

•SellingPlanGroupConnection!
non-null

A list of all selling plan groups defined in the current shop associated with the product variant.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount
•Count

Count of selling plan groups associated with the product variant.

•Boolean!
non-null

Whether to show the unit price for this product variant.

•String

A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.

•Boolean!
non-null

Whether a tax is charged when the product variant is sold.

•String!
non-null

The title of the product variant.

•[Translation!]!
non-null

The published translations associated with the resource.

•MoneyV2

The unit price value for the variant based on the variant measurement.

Anchor to unitPriceMeasurementunitPriceMeasurement
•UnitPriceMeasurement

The unit price measurement for the variant.

•DateTime!
non-null

The date and time (ISO 8601 format) when the product variant was last modified.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•ProductVariantPricePairConnection!
non-nullDeprecated
Anchor to sellingPlanGroupCountsellingPlanGroupCount
•Int!
non-nullDeprecated
•StorefrontID!
non-nullDeprecated
•String
Deprecated
•OBJECT

Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

For more information on selling plans, refer to Creating and managing selling plans.

•SellingPlanBillingPolicy!
non-null

A selling plan policy which describes the recurring billing details.

•SellingPlanCategory

The category used to classify the selling plan for reporting purposes.

•DateTime!
non-null

The date and time when the selling plan was created.

•SellingPlanDeliveryPolicy!
non-null

A selling plan policy which describes the delivery details.

•String

Buyer facing string which describes the selling plan commitment.

•ID!
non-null

A globally-unique ID.

•SellingPlanInventoryPolicy

When to reserve inventory for a selling plan.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•String!
non-null

A customer-facing description of the selling plan.

If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.

•[String!]!
non-null

The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

•Int

Relative position of the selling plan for display. A lower position will be displayed before a higher position.

•[SellingPlanPricingPolicy!]!
non-null

Selling plan pricing details.

•[Translation!]!
non-null

The published translations associated with the resource.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OBJECT

Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups and associated records (selling plans and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.

•String

The ID for app, exposed in Liquid and product JSON.

•Boolean!
non-null

Whether the given product is directly associated to the selling plan group.

Arguments

•ID!
required

The ID of the product.


Anchor to appliesToProductVariantappliesToProductVariant
•Boolean!
non-null

Whether the given product variant is directly associated to the selling plan group.

Arguments

•ID!
required

The ID of the product.


Anchor to appliesToProductVariantsappliesToProductVariants
•Boolean!
non-null

Whether any of the product variants of the given product are associated to the selling plan group.

Arguments

•ID!
required

The ID of the product.


•DateTime!
non-null

The date and time when the selling plan group was created.

•String

The merchant-facing description of the selling plan group.

•ID!
non-null

A globally-unique ID.

•String!
non-null

The merchant-facing label of the selling plan group.

•String!
non-null

The buyer-facing label of the selling plan group.

•[String!]!
non-null

The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

•Int

The relative position of the selling plan group for display.

•ProductConnection!
non-null

Products associated to the selling plan group.

•Count

A count of products associated to the selling plan group.

•ProductVariantConnection!
non-null

Product variants associated to the selling plan group.

Anchor to productVariantsCountproductVariantsCount
•Count

A count of product variants associated to the selling plan group.

•SellingPlanConnection!
non-null

Selling plans associated to the selling plan group.

•String

A summary of the policies associated to the selling plan group.

•[Translation!]!
non-null

The published translations associated with the resource.

•OBJECT

Represents a collection of general settings and information about the shop.

•StaffMember!
non-null

Account owner information.

•[ShopAlert!]!
non-null

A list of the shop's active alert messages that appear in the Shopify admin.

Anchor to allProductCategoriesListallProductCategoriesList
•[TaxonomyCategory!]!
non-null

A list of the shop's product categories. Limit: 1000 product categories.

Anchor to availableChannelAppsavailableChannelApps
•AppConnection!
non-null

The list of sales channels not currently installed on the shop.

•ShopAddress!
non-null

The shop's billing address information.

Anchor to channelDefinitionsForInstalledChannelschannelDefinitionsForInstalledChannels
•[AvailableChannelDefinitionsByChannel!]!
non-null

List of all channel definitions associated with a shop.

Anchor to checkoutApiSupportedcheckoutApiSupported
•Boolean!
non-null

Specifies whether the shop supports checkouts via Checkout API.

•String!
non-null

The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.

Anchor to countriesInShippingZonescountriesInShippingZones
•CountriesInShippingZones!
non-null

Countries that have been defined in shipping zones for the shop.

•DateTime!
non-null

The date and time when the shop was created.

•CurrencyCode!
non-null

The three letter code for the currency that the shop sells in.

•CurrencyFormats!
non-null

How currencies are displayed on your store.

•CurrencySettingConnection!
non-null

The presentment currency settings for the shop excluding the shop's own currency.

•ShopCustomerAccountsSetting!
non-null

Whether customer accounts are required, optional, or disabled for the shop.

•CustomerAccountsV2!
non-null

Information about the shop's customer accounts.

•StringConnection!
non-null

A list of tags that have been added to customer accounts.

•String

The shop's meta description used in search engine results.

•StringConnection!
non-null

A list of tags that have been added to draft orders.

•String!
non-null

The shop owner's email address. Shopify will use this email address to communicate with the shop owner.

Anchor to enabledPresentmentCurrenciesenabledPresentmentCurrencies
•[CurrencyCode!]!
non-null

The presentment currencies enabled for the shop.

•EntitlementsType!
non-null

The entitlements for a shop.

•ShopFeatures!
non-null

The set of features enabled for the shop.

•[FulfillmentService!]!
non-null

List of the shop's installed fulfillment services.

•String!
non-null

The shop's time zone as defined by the IANA.

•ID!
non-null

A globally-unique ID.

Anchor to marketingSmsConsentEnabledAtCheckoutmarketingSmsConsentEnabledAtCheckout
•Boolean!
non-null

Whether SMS marketing has been enabled on the shop's checkout configuration settings.

Anchor to merchantApprovalSignalsmerchantApprovalSignals
•MerchantApprovalSignals

The approval signals for a shop to support onboarding to channel apps.

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

•String!
non-null

The shop's .myshopify.com domain name.

•String!
non-null

The shop's name.

•[NavigationItem!]!
non-null

The shop's settings related to navigation.

Anchor to orderNumberFormatPrefixorderNumberFormatPrefix
•String!
non-null

The prefix that appears before order numbers.

Anchor to orderNumberFormatSuffixorderNumberFormatSuffix
•String!
non-null

The suffix that appears after order numbers.

•StringConnection!
non-null

A list of tags that have been added to orders.

•PaymentSettings!
non-null

The shop's settings related to payments.

•ShopPlan!
non-null

The shop's billing plan.

•Domain!
non-null

The primary domain of the shop's online store.

•ShopResourceLimits!
non-null

The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.

•URL!
non-null

The URL of the rich text editor that can be used for mobile devices.

•SearchResultConnection!
non-null

Fetches a list of admin search results by a specified query.

•SearchFilterOptions!
non-null

The list of search filter options for the shop. These can be used to filter productvisibility for the shop.

•Boolean!
non-null

Whether the shop has outstanding setup steps.

•[CountryCode!]!
non-null

The list of countries that the shop ships to.

•String!
non-null

The name of the shop owner.

•[ShopPolicy!]!
non-null

The list of all legal policies associated with a shop.

Anchor to storefrontAccessTokensstorefrontAccessTokens
•StorefrontAccessTokenConnection!
non-null

The storefront access token of a private application. These are scoped per-application.

•Boolean!
non-null

Whether applicable taxes are included in the shop's product prices.

•Boolean!
non-null

Whether the shop charges taxes for shipping.

Anchor to timezoneAbbreviationtimezoneAbbreviation
•String!
non-null

The shop's time zone abbreviation.

•String!
non-null

The shop's time zone offset.

Anchor to timezoneOffsetMinutestimezoneOffsetMinutes
•Int!
non-null

The shop's time zone offset expressed as a number of minutes.

Anchor to transactionalSmsDisabledtransactionalSmsDisabled
•Boolean!
non-null

Whether transactional SMS sent by Shopify have been disabled for a shop.

•[Translation!]!
non-null

The published translations associated with the resource.

•UnitSystem!
non-null

The shop's unit system for weights and measures.

•DateTime!
non-null

The date and time when the shop was last updated.

•URL!
non-null

The URL of the shop's online store.

•WeightUnit!
non-null

The shop's primary unit of weight for products and shipping.

Anchor to allProductCategoriesallProductCategories
•[ProductCategory!]!
non-nullDeprecated
•String!
non-nullDeprecated
Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders
•FulfillmentOrderConnection!
non-nullDeprecated
•ChannelConnection!
non-nullDeprecated
•CollectionConnection!
non-nullDeprecated
•CustomerConnection!
non-nullDeprecated
•[Domain!]!
non-nullDeprecated
•DraftOrderConnection!
non-nullDeprecated
•FulfillmentOrderConnection!
non-nullDeprecated
•InventoryItemConnection!
non-nullDeprecated
Anchor to limitedPendingOrderCountlimitedPendingOrderCount
•LimitedPendingOrderCount!
non-nullDeprecated
•LocationConnection!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
•OrderConnection!
non-nullDeprecated
•ImageConnection!
non-nullDeprecated
•ProductConnection!
non-nullDeprecated
•StringConnection!
non-nullDeprecated
•StringConnection!
non-nullDeprecated
•ProductVariantConnection!
non-nullDeprecated
•StringConnection!
non-nullDeprecated
•Int!
non-nullDeprecated
•StaffMemberConnection!
non-nullDeprecated
•URL!
non-nullDeprecated
•OBJECT

Policy that a merchant has configured for their store, such as their refund or privacy policy.

•HTML!
non-null

The text of the policy. The maximum size is 512kb.

•Date!
non-null

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

•ID!
non-null

A globally-unique ID.

•String!
non-null

The translated title of the policy. For example, Refund Policy or Politique de remboursement.

•[Translation!]!
non-null

The published translations associated with the resource.

•ShopPolicyType!
non-null

The shop policy type.

•Date!
non-null

The date and time (ISO 8601 format) when the policy was last modified.

•URL!
non-null

The public URL of the policy.


Was this section helpful?