Node

Details about the gift card used on the checkout.

A post that belongs to a Blog. Each article includes content with optional HTML formatting, an excerpt for previews, ArticleAuthor information, and an associated Image.

Articles can be organized with tags and include SEO metadata. You can manage comments when the blog's comment policy enables them.

A blog container for Article objects. Stores can have multiple blogs, for example to organize content by topic or purpose.

Each blog provides access to its articles, contributing ArticleAuthor objects, and SEO information. You can retrieve articles individually by handle or as a paginated list.

A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart, throughout a customer's session.

Use the checkoutUrl field to direct buyers to Shopify's web checkout to complete their purchase.

Learn more about interacting with carts.

An item in a customer's Cart representing a product variant they intend to purchase. Each cart line tracks the merchandise, quantity, cost breakdown, and any applied discounts.

Cart lines can include custom attributes for additional information like gift wrapping requests, and can be associated with a SellingPlanAllocation for purchase options like subscriptions, pre-orders, or try-before-you-buy. The instructions field indicates whether the line can be removed or have its quantity updated.

A group of products organized by a merchant to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.

Query a collection's products with filtering options like availability, price range, vendor, and tags. Each collection includes SEO information, an optional Image, and supports custom data through metafields.

A comment on an article.

A B2B organization that purchases from the shop. In the Storefront API, company information is accessed through the PurchasingCompany object on CartBuyerIdentity, which provides the associated location and contact for the current purchasing context.

You can store custom data using metafields.

A company's main point of contact.

A branch or office of a Company where B2B customers can place orders. When a B2B customer selects a location after logging in, the Storefront API contextualizes product queries to return location-specific pricing and quantity rules.

Access through the PurchasingCompany object, which associates the location with the buyer's Cart.

Represents information about the grouped merchandise in the cart.

Represents a video hosted outside of Shopify.

Any file that doesn't fit into a designated type like image or video. For example, a PDF or JSON document. Use this object to manage files in a merchant's store.

Generic files are commonly referenced through file reference metafields and returned as part of the MetafieldReference union.

Includes the file's URL, MIME type, size in bytes, and an optional preview image.

A physical store location where product inventory is held and that supports in-store pickup. Provides the location's name, address, and geographic coordinates for proximity-based sorting. Use with StoreAvailability to show customers where a ProductVariant is available for pickup.

Learn more about supporting local pickup on storefronts.

A physical mailing address associated with a Customer or Order. Stores standard address components including street address, city, province, country, and postal code, along with customer name and company information.

The address includes geographic coordinates and provides pre-formatted output through the formatted field, which can optionally include or exclude name and company details.

An audience of buyers that a merchant targets for sales. Audiences can include geographic regions, company locations, and retail locations. Markets enable localized shopping experiences with region-specific languages, currencies, and pricing.

Each market has a unique handle for identification and supports custom data through metafields. Learn more about building localized experiences with Shopify Markets.

An image hosted on Shopify's content delivery network (CDN). Used for product images, brand logos, and other visual content across the storefront.

The image field provides the actual image data with transformation options. Implements the Media interface alongside other media types like Video and Model3d.

A media presentation.

A navigation structure for building store menus. Each menu contains MenuItem objects that can be nested to create multi-level navigation hierarchies.

Menu items can link to collections, products, pages, blogs, or external URLs. Use the menu query to retrieve a menu by its handle.

A navigation link within a Menu. Each item has a title, URL, and can link to store resources like products, collections, pages, blogs, or external URLs.

Menu items support nested hierarchies through the items field, enabling dropdown or multi-level navigation structures. The tags field filters results when the item links to a collection specifically.

Custom metadata attached to a Shopify resource such as a Product, Collection, or Customer. Each metafield is identified by a namespace and key, and stores a value with an associated type.

Values are always stored as strings, but the type field indicates how to interpret the data. When a metafield's type is a resource reference, use the reference or references fields to retrieve the linked objects. Access metafields on any resource that implements the HasMetafields interface.

An instance of custom structured data defined by a metaobject definition. Metaobjects store reusable content that extends beyond standard Shopify resources, such as size charts, author profiles, or custom content sections.

Each metaobject contains fields that match the types and validation rules specified in its definition. Metafield references can point to metaobjects, connecting custom data with products, collections, and other resources. If the definition has the renderable capability, then the seo field provides SEO metadata. If it has the online_store capability, then the onlineStoreUrl field returns the public URL.

Represents a Shopify hosted 3D model.

An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

A custom content page on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.

Each page has a unique handle for URL routing and includes SEO information for search engine optimization. Pages support Metafield attachments for storing additional custom data.

Represents an item listed in a shop's catalog.

Products support multiple product variants, representing different versions of the same product, and can include various media types. Use the selectedOrFirstAvailableVariant or variantBySelectedOptions fields to help customers find the right variant based on their selections.

Products can be organized into collections, associated with selling plans for subscriptions, and extended with custom data through metafields.

Learn more about working with products and collections.

A customizable product attribute that customers select when purchasing, such as "Size", "Color", or "Material". Each option has a name and a set of ProductOptionValue objects representing the available choices.

Different combinations of option values create distinct ProductVariant objects. Option values can include visual swatches that display colors or images to help customers make selections. Option names have a 255-character limit.

Learn more about Shopify's product model.

A specific value for a ProductOption, such as "Red" or "Blue" for a "Color" option. Option values combine across different options to create ProductVariant objects.

Each value can include a visual swatch that displays a color or image. The firstSelectableVariant field returns the variant that combines this option value with the lowest-position values for all other options. This is useful for building product selection interfaces.

Learn more about Shopify's product model.

A specific version of a product available for sale, differentiated by options like size or color. For example, a small blue t-shirt and a large blue t-shirt are separate variants of the same product. For more information, see the docs on Shopify's product model.

For products with quantity rules, variants enforce minimum, maximum, and increment constraints on purchases.

Variants also support subscriptions and pre-orders through selling plan allocations objects, bundle configurations through product variant components objects, and shop pay installments pricing for flexible payment options.

The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the Brand object.

Access store policies such as privacy, refund, shipping, and terms of service via ShopPolicy, and the subscription policy via ShopPolicyWithDefault. PaymentSettings expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary Domain, countries the shop ships to, ShopPayInstallmentsPricing, and SocialLoginProvider options for customer accounts.

The financing plan in Shop Pay Installments.

The terms of the financing plan in Shop Pay Installments.

The shop pay installments pricing information for a product variant.

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

A category from Shopify's Standard Product Taxonomy assigned to a Product. Categories provide hierarchical classification through the ancestors field.

The ancestors field returns the parent chain from the immediate parent up to the root. Each ancestor category also includes its own ancestors.

The name field returns the localized category name based on the storefront's request language with shop locale fallbacks. If a translation isn't available for the resolved locale, the English taxonomy name is returned.

A redirect on the online store.

A video hosted on Shopify's servers. Implements the Media interface and provides multiple video sources through the sources field, each with format, dimensions, and URL information for adaptive playback.

For videos hosted on external platforms like YouTube or Vimeo, use ExternalVideo instead.