MetafieldDefinitionPinnedStatus

All metafield definitions.

Only metafield definitions that are pinned.

Only metafield definitions that are not pinned.

An article in the blogging system.

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.

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:

• Custom (manual) collections: You specify the products to include in a collection.
• Smart (automated) collections: You define rules, and products matching those rules are automatically included in the collection.

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.

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.

Represents information about a company which is also a customer of the shop.

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

A delivery customization.

The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

The DiscountCodeNode object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.

The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to orders, products, or shipping, and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store.

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.

Resources that metafield definitions can be applied to.

Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have fulfills_online_orders: true and are configured with a shipping rate, pickup enabled or local delivery will be able to sell from their storefront.

A market is a group of one or more regions that you want to target for international sales. By creating a market, you can configure a distinct, localized shopping experience for customers from a specific area of the world. For example, you can change currency, configure international pricing, or add market-specific domains or subfolders.

The Order object represents a customer's request to purchase one or more products from a store. Use the Order object to handle the complete purchase lifecycle from checkout to fulfillment.

Use the Order object when you need to:

• Display order details on customer account pages or admin dashboards.
• Create orders for phone sales, wholesale customers, or subscription services.
• Update order information like shipping addresses, notes, or fulfillment status.
• Process returns, exchanges, and partial refunds.
• Generate invoices, receipts, and shipping labels.

The Order object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.

Learn more about building apps for orders and fulfillment.

A page on the Online Store.

A payment customization.

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.

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:

• InventoryItem: Used for inventory tracking
• Image: Used for variant-specific images
• SellingPlanGroup: Used for subscriptions and selling plans

Learn more about Shopify's product model.

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.

A checkout server side validation installed on the shop.

The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.