Metafield Reference

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the comment was created.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the comment was published.
Anchor to published_status •string: Filter by published status
Anchor to status •string
Anchor to updated_at •time: Filter by the date and time when the comment was last updated.

Anchor to commentsCountcommentsCount

•Count

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

Arguments

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the comment was created.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the comment was published.
Anchor to published_status •string: Filter by published status
Anchor to status •string
Anchor to updated_at •time: Filter by the date and time when the comment was last updated.

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to createdAtcreatedAt

non-null

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

Anchor to defaultCursordefaultCursor

non-null

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

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

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.

Anchor to isPublishedisPublished

non-null

Whether or not the article is visible.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to publishedAtpublishedAt

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

Anchor to summarysummary

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

non-null

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

Anchor to templateSuffixtemplateSuffix

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

non-null

The title of the article.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

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

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to Collection Collection

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

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

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.

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 activeOperationsactiveOperations

•CollectionOperations!

non-null

Collection duplicate operations involving this collection, either as a source (copying products from this collection to another) or a target (copying products to this collection from another).

Anchor to availablePublicationsCountavailablePublicationsCount

•Count

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

Anchor to descriptiondescription

non-null

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

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

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

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to feedbackfeedback

•ResourceFeedback

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

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.

Anchor to hasProducthasProduct

non-null

Whether the collection includes the specified product.

Anchor to idid •ID! required: The ID of the product to check.

•ID!

non-null

A globally-unique ID.

•Image

The image associated with the collection.

Arguments

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to cropcrop

•CropRegion

Deprecated

Anchor to scalescale

•Int

DeprecatedDefault:1

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to productsproducts

•ProductConnection!

non-null

The products that are included in the collection.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductCollectionSortKeys

Default:COLLECTION_DEFAULT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

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

•ResourcePublicationConnection!

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

Anchor to resourcePublicationsresourcePublications

non-null

The list of resources that are published to a publication.

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to resourcePublicationsCountresourcePublicationsCount

•Count

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

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to resourcePublicationsV2resourcePublicationsV2

•ResourcePublicationV2Connection!

non-null

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

Arguments

Anchor to onlyPublishedonlyPublished

Default:true

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.

Anchor to catalogTypecatalogType

•CatalogType

Filter publications by catalog type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to ruleSetruleSet

•CollectionRuleSet

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

Anchor to seoseo

•SEO!

non-null

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

Anchor to sortOrdersortOrder

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

Anchor to templateSuffixtemplateSuffix

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

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.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unpublishedPublicationsunpublishedPublications

•PublicationConnection!

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•CollectionPublicationConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to publicationspublications

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Whether or not to return only the collection publications that are published.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

Anchor to Company Company

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to unpublishedChannelsunpublishedChannels

•ChannelConnection!

non-nullDeprecated

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

•OBJECT

A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. CompanyLocation objects can have custom pricing through Catalog and PriceList configurations.

Anchor to contactRolescontactRoles

•CompanyContactRoleConnection!

non-null

The list of roles for the company contacts.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyContactRoleSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to contactscontacts

•CompanyContactConnection!

non-null

The list of contacts in the company.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyContactSortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to email •string
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to name •string
Anchor to role_name •string
Anchor to status •string
Anchor to updated_at •time

Anchor to contactsCountcontactsCount

•Count

The number of contacts that belong to the company.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) at which the company was created in Shopify.

Anchor to customerSincecustomerSince

non-null

The date and time (ISO 8601 format) at which the company became the customer.

Anchor to defaultCursordefaultCursor

non-null

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

Anchor to defaultRoledefaultRole

•CompanyContactRole

The role proposed by default for a contact at the company.

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of the company's draft orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•DraftOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to externalIdexternalId

•String

A unique externally-supplied ID for the company.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant added a timeline comment to the company.

•ID!

non-null

A globally-unique ID.

Anchor to lifetimeDurationlifetimeDuration

non-null

The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.

Anchor to locationslocations

•CompanyLocationConnection!

non-null

The list of locations in the company.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CompanyLocationSortKeys

Default:ID

Sort the underlying list by the given key.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to company_id •id
Anchor to created_at •time
Anchor to external_id •string
Anchor to id •id: Filter by id range.
Anchor to ids •string
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string
Anchor to updated_at •time

Anchor to locationsCountlocationsCount

•Count

The number of locations that belong to the company.

Anchor to mainContactmainContact

•CompanyContact

The main contact for the company.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to namename

non-null

The name of the company.

Anchor to notenote

•String

A note about the company.

Anchor to ordersorders

•OrderConnection!

non-null

The list of the company's orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to shipping_address_validation_result_summary •string: Filter by the validation status of the shipping address. Learn more about validating addresses.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to ordersCountordersCount

•Count

The total number of orders placed for this company, across all its locations.

Anchor to totalSpenttotalSpent

•MoneyV2!

non-null

The total amount spent by this company, across all its locations.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) at which the company was last modified.

Anchor to contactCountcontactCount

•Int!

non-nullDeprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to Customer Customer

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

•OBJECT

Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.

Tracks the customer's total spending through the amountSpent field and provides access to associated data such as payment methods and subscription contracts.

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.

Anchor to addressesV2addressesV2

•MailingAddressConnection!

non-null

The addresses associated with the customer.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to amountSpentamountSpent

•MoneyV2!

non-null

The total amount that the customer has spent on orders in their lifetime.

Anchor to canDeletecanDelete

non-null

Whether the merchant can delete the customer from their store.

A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.

Anchor to companyContactProfilescompanyContactProfiles

•[CompanyContact!]!

non-null

A list of the customer's company contact profiles.

Anchor to createdAtcreatedAt

non-null

The date and time when the customer was added to the store.

Anchor to dataSaleOptOutdataSaleOptOut

non-null

Whether the customer has opted out of having their data sold.

Anchor to defaultAddressdefaultAddress

The default address associated with the customer.

Anchor to defaultEmailAddressdefaultEmailAddress

•CustomerEmailAddress

The customer's default email address.

Anchor to defaultPhoneNumberdefaultPhoneNumber

•CustomerPhoneNumber

The customer's default phone number.

Anchor to displayNamedisplayName

non-null

The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.

non-null

A list of events associated with the customer.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to firstNamefirstName

•String

The customer's first name.

•ID!

non-null

A globally-unique ID.

•Image!

non-null

The image associated with the customer.

Anchor to sizesize •Int Deprecated

Anchor to lastNamelastName

•String

The customer's last name.

Anchor to lastOrderlastOrder

•Order

The customer's last order.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to lifetimeDurationlifetimeDuration

non-null

The amount of time since the customer was first added to the store.

Example: 'about 12 years'.

Anchor to localelocale

non-null

The customer's locale.

Anchor to mergeablemergeable

•CustomerMergeable!

non-null

Whether the customer can be merged with another customer.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to multipassIdentifiermultipassIdentifier

•String

A unique identifier for the customer that's used with Multipass login.

Anchor to notenote

•String

A note about the customer.

Anchor to numberOfOrdersnumberOfOrders

non-null

The number of orders that the customer has made at the store in their lifetime.

Anchor to ordersorders

•OrderConnection!

non-null

A list of the customer's orders.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•CustomerPaymentMethodConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to cart_token •string: Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.
Anchor to channel •string: Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.
Anchor to channel_id •id: Filter by the channel id field.
Anchor to chargeback_status •string: Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.
Anchor to checkout_token •string: Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.
Anchor to confirmation_number •string: Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.
Anchor to created_at •time: Filter by the date and time when the order was created in Shopify's system.
Anchor to credit_card_last4 •string: Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.
Anchor to current_total_price •float: Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.
Anchor to customer_id •id: Filter orders by the customer id field.
Anchor to delivery_method •string: Filter by the delivery methodType field.
Anchor to discount_code •string: Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.
Anchor to email •string: Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.
Anchor to financial_status •string: Filter by the order displayFinancialStatus field.
Anchor to fraud_protection_level •string: Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.
Anchor to fulfillment_location_id •id: Filter by the fulfillment location id (Fulfillment.location.id) field.
Anchor to fulfillment_status •string: Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.
Anchor to gateway •string: Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.
Anchor to id •id: Filter by id range.
Anchor to location_id •id: Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to name •string: Filter by the order name field.
Anchor to payment_id •string: Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.
Anchor to payment_provider_id •id: Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.
Anchor to po_number •string: Filter by the order poNumber field.
Anchor to processed_at •time: Filter by the order processedAt field.
Anchor to reference_location_id •id: Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.
Anchor to return_status •string: Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.
Anchor to risk_level •string: Filter by the order risk assessment riskLevel field.
Anchor to sales_channel •string: Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.
Anchor to shipping_address_validation_result_summary •string: Filter by the validation status of the shipping address. Learn more about validating addresses.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to source_identifier •string: Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.
Anchor to source_name •string: Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.
Anchor to status •string: Filter by the order's status to manage workflows or analyze the order lifecycle.
Anchor to subtotal_line_items_quantity •string: Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to test •boolean: Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
Anchor to total_weight •string: Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.
Anchor to updated_at •time: Filter by the date and time when the order was last updated in Shopify's system.

Anchor to paymentMethodspaymentMethods

non-null

A list of the customer's payment methods.

Anchor to showRevokedshowRevoked •Boolean Default:false: Whether to show the customer's revoked payment method.
Anchor to showWithPreauthorizedPaymentsshowWithPreauthorizedPayments •Boolean Default:false: When true, shows unrevoked payment methods and revoked payment methods that are connected to future payments. Overrides the showRevoked argument.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productSubscriberStatusproductSubscriberStatus

•CustomerProductSubscriberStatus!

non-null

Possible subscriber states of a customer defined by their subscription contracts.

Anchor to statestate

•CustomerState!

non-null

The state of the customer's account with the shop.

Please note that this only meaningful when Classic Customer Accounts is active.

Anchor to statisticsstatistics

•CustomerStatistics!

non-null

The statistics for a given customer.

Anchor to storeCreditAccountsstoreCreditAccounts

•StoreCreditAccountConnection!

non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•SubscriptionContractConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to currency_code •string
Anchor to id •id: Filter by id range.

Anchor to subscriptionContractssubscriptionContracts

non-null

A list of the customer's subscription contracts.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

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

Anchor to taxExempttaxExempt

non-null

Whether the customer is exempt from being charged taxes on their orders.

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-null

The list of tax exemptions applied to the customer.

Anchor to updatedAtupdatedAt

non-null

The date and time when the customer was last updated.

Anchor to verifiedEmailverifiedEmail

•CustomerEmailMarketingConsentState

non-null

Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

Anchor to addressesaddresses

•[MailingAddress!]!

non-nullDeprecated

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to emailemail

•String

Deprecated

Anchor to emailMarketingConsentemailMarketingConsent

Deprecated

Anchor to hasTimelineCommenthasTimelineComment

non-nullDeprecated

Anchor to marketmarket

•Market

Deprecated

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•CustomerSmsMarketingConsentState

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to phonephone

•String

Deprecated

Anchor to smsMarketingConsentsmsMarketingConsent

Deprecated

Anchor to unsubscribeUrlunsubscribeUrl

•URL!

non-nullDeprecated

Anchor to validEmailAddressvalidEmailAddress

Anchor to GenericFile GenericFile

non-nullDeprecated

•OBJECT

Represents any file other than HTML.

•String

A word or phrase to describe the contents or the function of a file.

Anchor to createdAtcreatedAt

non-null

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

Anchor to fileErrorsfileErrors

non-null

Any errors that have occurred on the file.

Anchor to fileStatusfileStatus

non-null

The status of the file.

•ID!

non-null

A globally-unique ID.

Anchor to mimeTypemimeType

•String

The generic file's MIME type.

Anchor to originalFileSizeoriginalFileSize

•Int

The generic file's size in bytes.

The preview image for the media.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to updateStatusupdateStatus

Anchor to MediaImage MediaImage

Status resulting from the latest update operation. See fileErrors for details.

Anchor to urlurl

•URL

The generic file's URL.

•OBJECT

The MediaImage object represents an image hosted on Shopify's content delivery network (CDN). Shopify CDN is a content system that serves as the primary way to store, manage, and deliver visual content for products, variants, and other resources across the Shopify platform.

The MediaImage object provides information to:

Store and display product and variant images across online stores, admin interfaces, and mobile apps.
Retrieve visual branding elements, including logos, banners, favicons, and background images in checkout flows.
Retrieve signed URLs for secure, time-limited access to original image files.

Each MediaImage object provides both the processed image data (with automatic optimization and CDN delivery) and access to the original source file. The image processing is handled asynchronously, so images might not be immediately available after upload. The status field indicates when processing is complete and the image is ready for use.

The MediaImage object implements the Media interface alongside other media types, like videos and 3D models.

Learn about managing media for products, product variants, and asynchronous media management.

•String

A word or phrase to share the nature or contents of a media.

Anchor to createdAtcreatedAt

non-null

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

Anchor to fileErrorsfileErrors

non-null

Any errors that have occurred on the file.

Anchor to fileStatusfileStatus

non-null

The status of the file.

•ID!

non-null

A globally-unique ID.

•Image

The image for the media. Returns null until status is READY.

Anchor to mediaContentTypemediaContentType

•MediaContentType!

non-null

The media content type.

Anchor to mediaErrorsmediaErrors

•[MediaError!]!

non-null

Any errors which have occurred on the media.

Anchor to mediaWarningsmediaWarnings

•[MediaWarning!]!

non-null

The warnings attached to the media.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to mimeTypemimeType

•String

The MIME type of the image.

Anchor to originalSourceoriginalSource

•MediaImageOriginalSource

The original source of the image.

The preview image for the media.

•MediaStatus!

non-null

Current status of the media.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to updateStatusupdateStatus

Status resulting from the latest update operation. See fileErrors for details.

Anchor to metafieldmetafield

Deprecated

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

Anchor to Metaobject Metaobject

non-nullDeprecated

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

•OBJECT

An instance of custom structured data defined by a MetaobjectDefinition. Metaobjects store reusable data that extends beyond Shopify's standard resources, such as product highlights, size charts, or custom content sections.

Each metaobject includes fields that match the field types and validation rules specified in its definition, which also determines the metaobject's capabilities, such as storefront visibility, publishing and translation support. Metafields can reference metaobjects to connect custom data with Product objects, Collection objects, and other Shopify resources.

Anchor to capabilitiescapabilities

•MetaobjectCapabilityData!

non-null

Metaobject capabilities for this Metaobject.

Anchor to createdAtcreatedAt

non-null

When the object was created.

Anchor to createdBycreatedBy

•App!

non-null

The app used to create the object.

Anchor to createdByAppcreatedByApp

•App!

non-null

The app used to create the object.

Anchor to createdByStaffcreatedByStaff

•StaffMember

The staff member who created the metaobject.

Anchor to definitiondefinition

•MetaobjectDefinition!

non-null

The MetaobjectDefinition that models this object type.

Anchor to displayNamedisplayName

non-null

The preferred display name field value of the metaobject.

Anchor to fieldfield

•MetaobjectField

The field for an object key, or null if the key has no field definition.

Anchor to keykey •String! required: The metaobject key to access.

Anchor to fieldsfields

•[MetaobjectField!]!

non-null

All ordered fields of the metaobject with their definitions and values.

non-null

The unique handle of the object, useful as a custom ID.

•MetafieldRelationConnection!

•ID!

non-null

A globally-unique ID.

Anchor to referencedByreferencedBy

non-null

List of back references metafields that belong to the resource.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to thumbnailFieldthumbnailField

•MetaobjectField

The recommended field to visually represent this metaobject. May be a file reference or color field.

Anchor to typetype

non-null

The type of the metaobject.

Anchor to updatedAtupdatedAt

Anchor to Model3d Model3d

non-null

When the object was last updated.

Anchor to appapp

•App!

non-nullDeprecated

Anchor to staffMemberstaffMember

•StaffMember

Deprecated

•OBJECT

Represents a Shopify hosted 3D model.

•String

A word or phrase to describe the contents or the function of a file.

Anchor to boundingBoxboundingBox

•Model3dBoundingBox

The 3d model's bounding box information.

Anchor to createdAtcreatedAt

non-null

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

Anchor to fileErrorsfileErrors

non-null

Any errors that have occurred on the file.

Anchor to filenamefilename

non-null

The 3d model's filename.

Anchor to fileStatusfileStatus

non-null

The status of the file.

•ID!

non-null

A globally-unique ID.

Anchor to mediaContentTypemediaContentType

•MediaContentType!

non-null

The media content type.

Anchor to mediaErrorsmediaErrors

•[MediaError!]!

non-null

Any errors which have occurred on the media.

Anchor to mediaWarningsmediaWarnings

•[MediaWarning!]!

non-null

The warnings attached to the media.

Anchor to originalSourceoriginalSource

•Model3dSource

The 3d model's original source.

The preview image for the media.

Anchor to sourcessources

•[Model3dSource!]!

non-null

The 3d model's sources.

•MediaStatus!

non-null

Current status of the media.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to updateStatusupdateStatus

Status resulting from the latest update operation. See fileErrors for details.

Anchor to Order Order

•OBJECT

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.

Note

Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders, read_orders, and write_orders scopes.

Caution

Only use orders 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.

Learn more about building apps for orders and fulfillment.

Anchor to additionalFeesadditionalFees

•[AdditionalFee!]!

non-null

A list of additional fees applied to an order, such as duties, import fees, or tax lines.

Anchor to agreementsagreements

•SalesAgreementConnection!

non-null

A list of sales agreements associated with the order, such as contracts defining payment terms, or delivery schedules between merchants and customers.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to happened_at •time
Anchor to id •id: Filter by id range.

Anchor to alertsalerts

•[ResourceAlert!]!

non-null

A list of messages that appear on the Orders page in the Shopify admin. These alerts provide merchants with important information about an order's status or required actions.

Anchor to appapp

•OrderApp

The application that created the order. For example, "Online Store", "Point of Sale", or a custom app name. Use this to identify the order source for attribution and fulfillment workflows. Learn more about building apps for orders and fulfillment.

Anchor to billingAddressbillingAddress

The billing address associated with the payment method selected by the customer for an order. Returns null if no billing address was provided during checkout.

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress

non-null

Whether the billing address matches the shipping address. Returns true if both addresses are the same, and false if they're different or if an address is missing.

Anchor to cancellationcancellation

•OrderCancellation

Details of an order's cancellation, if it has been canceled. This includes the reason, date, and any staff notes.

Anchor to cancelledAtcancelledAt

The date and time in ISO 8601 format when an order was canceled. Returns null if the order hasn't been canceled.

Anchor to cancelReasoncancelReason

•OrderCancelReason

The reason provided for an order cancellation. For example, a merchant might cancel an order if there's insufficient inventory. Returns null if the order hasn't been canceled.

Anchor to canMarkAsPaidcanMarkAsPaid

non-null

Whether an order can be manually marked as paid. Returns false if the order is already paid, is canceled, has pending Shopify Payments transactions, or has a negative payment amount.

Anchor to canNotifyCustomercanNotifyCustomer

non-null

Whether order notifications can be sent to the customer. Returns true if the customer has a valid email address.

Anchor to capturablecapturable

non-null

Whether an authorized payment for an order can be captured. Returns true if an authorized payment exists that hasn't been fully captured yet. Learn more about capturing payments.

Anchor to cartDiscountAmountSetcartDiscountAmountSet

The total discount amount applied at the time the order was created, displayed in both shop and presentment currencies, before returns, refunds, order edits, and cancellations. This field only includes discounts applied to the entire order.

Anchor to channelInformationchannelInformation

•ChannelInformation

Details about the sales channel that created the order, such as the channel app type and channel name, which helps to track order sources.

Anchor to clientIpclientIp

•String

The IP address of the customer who placed the order. Useful for fraud detection and geographic analysis.

Anchor to closedclosed

non-null

Whether an order is closed. An order is considered closed if all its line items have been fulfilled or canceled, and all financial transactions are complete.

Anchor to closedAtclosedAt

The date and time ISO 8601 format when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns null if the order isn't closed.

Anchor to confirmationNumberconfirmationNumber

•String

A customer-facing order identifier, often shown instead of the sequential order name. It uses a random alphanumeric format (for example, XPAV284CT) and isn't guaranteed to be unique across orders.

Anchor to confirmedconfirmed

non-null

Whether inventory has been reserved for an order. Returns true if inventory quantities for an order's line items have been reserved. Learn more about managing inventory quantities and states.

Anchor to createdAtcreatedAt

non-null

The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The shop currency when the order was placed. For example, "USD" or "CAD".

Anchor to currentCartDiscountAmountSetcurrentCartDiscountAmountSet

non-null

The current total of all discounts applied to the entire order, after returns, refunds, order edits, and cancellations. This includes discount codes, automatic discounts, and other promotions that affect the whole order rather than individual line items. To get the original discount amount at the time of order creation, use the cartDiscountAmountSet field.

Anchor to currentShippingPriceSetcurrentShippingPriceSet

non-null

The current shipping price after applying refunds and discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.

Anchor to currentSubtotalLineItemsQuantitycurrentSubtotalLineItemsQuantity

•Int!

non-null

The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations.

Anchor to currentSubtotalPriceSetcurrentSubtotalPriceSet

non-null

The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.

Anchor to currentTaxLinescurrentTaxLines

•[TaxLine!]!

non-null

A list of all tax lines applied to line items on the order, after returns. Tax line prices represent the total price for all tax lines with the same rate and title.

Anchor to currentTotalAdditionalFeesSetcurrentTotalAdditionalFeesSet

The current total of all additional fees for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations. Additional fees can include charges such as duties, import fees, and special handling.

Anchor to currentTotalDiscountsSetcurrentTotalDiscountsSet

non-null

The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.

Anchor to currentTotalDutiesSetcurrentTotalDutiesSet

The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.

Anchor to currentTotalPriceSetcurrentTotalPriceSet

non-null

The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.

Anchor to currentTotalTaxSetcurrentTotalTaxSet

non-null

The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies.

Anchor to currentTotalWeightcurrentTotalWeight

non-null

The total weight of the order after returns and refunds, in grams.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

A list of additional information that has been attached to the order. For example, gift message, delivery instructions, or internal notes.

Anchor to customercustomer

•Customer

The customer who placed an order. Returns null if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about customer accounts.

Anchor to customerAcceptsMarketingcustomerAcceptsMarketing

•DiscountApplicationConnection!

non-null

Whether the customer agreed to receive marketing emails at the time of purchase. Use this to ensure compliance with marketing consent laws and to segment customers for email campaigns. Learn more about building customer segments.

Anchor to customerJourneySummarycustomerJourneySummary

•CustomerJourneySummary

The customer's visits and interactions with the online store before placing the order. Use this to understand customer behavior, attribution sources, and marketing effectiveness to optimize your sales funnel.

Anchor to customerLocalecustomerLocale

•String

The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language.

Anchor to discountApplicationsdiscountApplications

non-null

A list of discounts that are applied to the order, excluding order edits and refunds. Includes discount codes, automatic discounts, and other promotions that reduce the order total.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to discountCodediscountCode

•String

The discount code used for an order. Returns null if no discount code was applied.

Anchor to discountCodesdiscountCodes

non-null

The discount codes used for the order. Multiple codes can be applied to a single order.

Anchor to displayAddressdisplayAddress

•OrderDisplayFinancialStatus

The primary address of the customer, prioritizing shipping address over billing address when both are available. Returns null if neither shipping address nor billing address was provided.

Anchor to displayFinancialStatusdisplayFinancialStatus

An order's financial status for display in the Shopify admin.

Anchor to displayFulfillmentStatusdisplayFulfillmentStatus

•OrderDisplayFulfillmentStatus!

non-null

The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the FulfillmentOrder object.

Anchor to displayRefundStatusdisplayRefundStatus

•OrderDisplayRefundStatus

The status of the refund(s) that can be shown to the merchant. Mostly used when a refund is in a deferred state (for example, it was not yet sent to the payments provider).

Anchor to disputesdisputes

•[OrderDisputeSummary!]!

non-null

A list of payment disputes associated with the order, such as chargebacks or payment inquiries. Disputes occur when customers challenge transactions with their bank or payment provider.

Anchor to dutiesIncludeddutiesIncluded

non-null

Whether duties are included in the subtotal price of the order. Duties are import taxes charged by customs authorities when goods cross international borders.

Anchor to editededited

non-null

Whether the order has had any edits applied. For example, adding or removing line items, updating quantities, or changing prices.

Anchor to emailemail

•String

The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns null if no email address was provided during checkout.

Anchor to estimatedTaxesestimatedTaxes

non-null

Whether taxes on the order are estimated. This field returns false when taxes on the order are finalized and aren't subject to any changes.

non-null

A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to fulfillablefulfillable

•FulfillmentOrderConnection!

non-null

Whether there are line items that can be fulfilled. This field returns false when the order has no fulfillable line items. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.

Anchor to fulfillmentOrdersfulfillmentOrders

non-null

A list of fulfillment orders for an order. Each fulfillment order groups line items that are fulfilled together, allowing an order to be processed in parts if needed.

Arguments

Anchor to displayabledisplayable

Default:false

If false, all fulfillment orders will be returned. If true, fulfillment orders that are normally hidden from the merchant will be excluded. For example, fulfillment orders that were closed after being combined or moved are hidden.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to assigned_location_id •id
Anchor to id •id: Filter by id range.
Anchor to status •string
Anchor to updated_at •time

Anchor to fulfillmentsfulfillments

•[Fulfillment!]!

non-null

A list of shipments for the order. Fulfillments represent the physical shipment of products to customers.

Anchor to firstfirst •Int: Truncate the array result to this size.
Anchor to queryquery •String: Optional query string to filter fulfillments by timestamps. Examples: created_at:>='2024-05-07T08:37:00Z' updated_at:<'2025-05-07T08:37:00Z', created_at:'2024-05-07T08:37:00Z'

Anchor to fulfillmentsCountfulfillmentsCount

•Count

The total number of fulfillments for the order, including canceled ones.

Anchor to fullyPaidfullyPaid

non-null

Whether the order has been paid in full. This field returns true when the total amount received equals or exceeds the order total.

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant has added a timeline comment to the order.

•ID!

non-null

A globally-unique ID.

Anchor to incotermInformationincotermInformation

•IncotermInformation

Information about the incoterm used for the order.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to lineItemslineItems

•LineItemConnection!

non-null

A list of the order's line items. Line items represent the individual products and quantities that make up the order.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to localizedFieldslocalizedFields

•LocalizedFieldConnection!

non-null

List of localized fields for the resource.

Arguments

Anchor to countryCodescountryCodes

•[CountryCode!]

The country codes of the extensions.

Anchor to purposespurposes

•[LocalizedFieldPurpose!]

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to merchantBusinessEntitymerchantBusinessEntity

•BusinessEntity!

non-null

The legal business structure that the merchant operates under for this order, such as an LLC, corporation, or partnership. Used for tax reporting, legal compliance, and determining which business entity is responsible for the order.

Anchor to merchantEditablemerchantEditable

non-null

Whether the order can be edited by the merchant. Returns false for orders that can't be modified, such as canceled orders or orders with specific payment statuses.

Anchor to merchantEditableErrorsmerchantEditableErrors

non-null

A list of reasons why the order can't be edited. For example, canceled orders can't be edited.

Anchor to merchantOfRecordAppmerchantOfRecordApp

•OrderApp

The application acting as the Merchant of Record for the order. The Merchant of Record is responsible for tax collection and remittance.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to namename

non-null

The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking.

Anchor to netPaymentSetnetPaymentSet

non-null

The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.

Anchor to nonFulfillableLineItemsnonFulfillableLineItems

•LineItemConnection!

non-null

A list of line items that can't be fulfilled. For example, tips and fully refunded line items can't be fulfilled. For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to notenote

•String

The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes.

Anchor to numbernumber

•Int!

non-null

The order number used to generate the name using the store's configured order number prefix/suffix. This number isn't guaranteed to follow a consecutive integer sequence (e.g. 1, 2, 3..), nor is it guaranteed to be unique across multiple stores, or even for a single store.

Anchor to originalTotalAdditionalFeesSetoriginalTotalAdditionalFeesSet

The total amount of all additional fees, such as import fees or taxes, that were applied when an order was created. Returns null if additional fees aren't applicable.

Anchor to originalTotalDutiesSetoriginalTotalDutiesSet

The total amount of duties calculated when an order was created, before any modifications. Modifications include returns, refunds, order edits, and cancellations. Use currentTotalDutiesSet to retrieve the current duties amount after adjustments.

Anchor to originalTotalPriceSetoriginalTotalPriceSet

•OrderPaymentCollectionDetails!

non-null

The total price of the order at the time of order creation, in shop and presentment currencies. Use this to compare the original order value against the current total after edits, returns, or refunds.

Anchor to paymentCollectionDetailspaymentCollectionDetails

non-null

The payment collection details for the order, including payment status, outstanding amounts, and collection information. Use this to understand when and how payments should be collected, especially for orders with deferred or installment payment terms.

Anchor to paymentGatewayNamespaymentGatewayNames

non-null

A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".

Anchor to paymentTermspaymentTerms

•PaymentTerms

The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns null if no specific payment terms were set for the order.

Anchor to phonephone

•String

The phone number associated with the customer for this order. Useful for contacting customers about shipping updates, delivery notifications, or order issues. Returns null if no phone number was provided during checkout.

Anchor to poNumberpoNumber

•String

The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode

•CurrencyCode!

non-null

The currency used by the customer when placing the order. For example, "USD", "EUR", or "CAD". This may differ from the shop's base currency when serving international customers or using multi-currency pricing.

Anchor to processedAtprocessedAt

non-null

The date and time in ISO 8601 format when the order was processed. This date and time might not match the date and time when the order was created.

Anchor to productNetworkproductNetwork

non-null

Whether the customer also purchased items from other stores in the network.

Anchor to publicationpublication

•Publication

The sales channel that the order was created from, such as the Online Store or Shopify POS.

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntity

The business entity that placed the order, including company details and purchasing relationships. Used for B2B transactions to track which company or organization is responsible for the purchase and payment terms.

Anchor to refundablerefundable

non-null

Whether the order can be refunded based on its payment transactions. Returns false for orders with no eligible payment transactions, such as fully refunded orders or orders with non-refundable payment methods.

Anchor to refundDiscrepancySetrefundDiscrepancySet

non-null

The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.

Anchor to refundsrefunds

•[Refund!]!

non-null

A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments.

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to registeredSourceUrlregisteredSourceUrl

•URL

The URL of the source that the order originated from, if found in the domain registry. Returns null if the source URL isn't in the domain registry.

Anchor to requiresShippingrequiresShipping

non-null

Whether the order requires physical shipping to the customer. Returns false for digital-only orders (such as gift cards or downloadable products) and true for orders with physical products that need delivery. Use this to determine shipping workflows and logistics requirements.

Anchor to restockablerestockable

non-null

Whether any line items on the order can be restocked into inventory. Returns false for digital products, custom items, or items that can't be resold.

Anchor to retailLocationretailLocation

•Location

The physical location where a retail order is created or completed, except for draft POS orders completed using the "mark as paid" flow in the Shopify admin, which return null. Transactions associated with the order might have been processed at a different location.

Anchor to returnsreturns

•ReturnConnection!

non-null

The returns associated with the order. Contains information about items that customers have requested to return, including return reasons, status, and refund details. Use this to track and manage the return process for order items.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to status •string

Anchor to returnStatusreturnStatus

•OrderReturnStatus!

non-null

The order's aggregated return status for display purposes. Indicates the overall state of returns for the order, helping merchants track and manage the return process.

Anchor to riskrisk

•OrderRiskSummary!

non-null

The risk assessment summary for the order. Provides fraud analysis and risk scoring to help you identify potentially fraudulent orders. Use this to make informed decisions about order fulfillment and payment processing.

Anchor to shippingAddressshippingAddress

The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns null for digital orders or orders that don't require shipping.

Anchor to shippingLineshippingLine

•ShippingLine

A summary of all shipping costs on the order. Aggregates shipping charges, discounts, and taxes to provide a single view of delivery costs.

Anchor to shippingLinesshippingLines

•ShippingLineConnection!

non-null

The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order.

Anchor to includeRemovalsincludeRemovals •Boolean Default:false: Whether results should contain removed shipping lines.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to shopifyProtectshopifyProtect

•ShopifyProtectOrderSummary

The Shopify Protect details for the order, including fraud protection status and coverage information. Shopify Protect helps protect eligible orders against fraudulent chargebacks. Returns null if Shopify Protect is disabled for the shop or the order isn't eligible for protection. Learn more about Shopify Protect.

Anchor to sourceIdentifiersourceIdentifier

•String

A unique POS or third party order identifier. For example, "1234-12-1000" or "111-98567-54". The receiptNumber field is derived from this value for POS orders.

Anchor to sourceNamesourceName

•String

The name of the source associated with the order, such as "web", "mobile_app", or "pos". Use this field to identify the platform where the order was placed.

Anchor to staffMemberstaffMember

•StaffMember

The staff member who created or is responsible for the order. Useful for tracking which team member handled phone orders, manual orders, or order modifications. Returns null for orders created directly by customers through the online store.

Anchor to statusPageUrlstatusPageUrl

•URL!

non-null

The URL where customers can check their order's current status, including tracking information and delivery updates. Provides order tracking links in emails, apps, or customer communications.

Arguments

Anchor to audienceaudience

•Audience

Specifies the intended audience for the status page URL.

Anchor to notificationUsagenotificationUsage

•NotificationUsage

Specifies the intended notification usage for the status page URL.

Anchor to subtotalLineItemsQuantitysubtotalLineItemsQuantity

•Int!

non-null

The sum of quantities for all line items that contribute to the order's subtotal price. This excludes quantities for items like tips, shipping costs, or gift cards that don't affect the subtotal. Use this to quickly understand the total item count for pricing calculations.

Anchor to subtotalPriceSetsubtotalPriceSet

The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. If taxesIncluded is true, then the subtotal also includes tax.

Anchor to suggestedRefundsuggestedRefund

•SuggestedRefund

A calculated refund suggestion for the order based on specified line items, shipping, and duties. Use this to preview refund amounts, taxes, and processing fees before creating an actual refund.

Arguments

Anchor to shippingAmountshippingAmount

•Money

The amount to refund for shipping. Overrides the refundShipping argument.

Anchor to refundShippingrefundShipping

•[RefundAdditionalFeeInput!]

Whether to refund the full shipping amount.

Anchor to refundLineItemsrefundLineItems

•[RefundLineItemInput!]

The line items from the order to include in the refund.

Anchor to refundDutiesrefundDuties

•[RefundDutyInput!]

The duties from the order to include in the refund.

Anchor to refundAdditionalFeesrefundAdditionalFees

The additional fees from the order to include in the refund.

Anchor to suggestFullRefundsuggestFullRefund

Default:false

Whether the suggested refund should be created from all refundable line items on the order. If true, the refundLineItems argument will be ignored.

Anchor to refundMethodAllocationrefundMethodAllocation

•RefundMethodAllocation

Default:ORIGINAL_PAYMENT_METHODS

Specifies which refund methods to allocate the suggested refund amount to.

non-null

A comma separated list of tags associated with the order. Updating tags overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.

Anchor to taxesIncludedtaxesIncluded

non-null

Whether taxes are included in the subtotal price of the order. When true, the subtotal and line item prices include tax amounts. When false, taxes are calculated and displayed separately.

Anchor to taxExempttaxExempt

non-null

Whether taxes are exempt on the order. Returns true for orders where the customer or business has a valid tax exemption, such as non-profit organizations or tax-free purchases. Use this to understand if tax calculations were skipped during checkout.

Anchor to taxLinestaxLines

•[TaxLine!]!

non-null

A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same rate and title.

Anchor to testtest

non-null

Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order can't be converted into a real order and vice versa.

Anchor to totalCapturableSettotalCapturableSet

non-null

The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. This amount isn't adjusted for returns.

Anchor to totalCashRoundingAdjustmenttotalCashRoundingAdjustment

•CashRoundingAdjustment!

non-null

The total rounding adjustment applied to payments or refunds for an order involving cash payments. Applies to some countries where cash transactions are rounded to the nearest currency denomination.

Anchor to totalDiscountsSettotalDiscountsSet

The total amount discounted on the order before returns, in shop and presentment currencies. This includes both order and line level discounts.

Anchor to totalOutstandingSettotalOutstandingSet

non-null

The total amount not yet transacted for the order, in shop and presentment currencies. A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).

Anchor to totalPriceSettotalPriceSet

non-null

The total price of the order, before returns, in shop and presentment currencies. This includes taxes and discounts.

Anchor to totalReceivedSettotalReceivedSet

non-null

The total amount received from the customer before returns, in shop and presentment currencies.

Anchor to totalRefundedSettotalRefundedSet

non-null

The total amount that was refunded, in shop and presentment currencies.

Anchor to totalRefundedShippingSettotalRefundedShippingSet

non-null

The total amount of shipping that was refunded, in shop and presentment currencies.

Anchor to totalShippingPriceSettotalShippingPriceSet

non-null

The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded.

Anchor to totalTaxSettotalTaxSet

The total tax amount before returns, in shop and presentment currencies.

Anchor to totalTipReceivedSettotalTipReceivedSet

non-null

The sum of all tip amounts for the order, in shop and presentment currencies.

Anchor to totalWeighttotalWeight

•UnsignedInt64

The total weight of the order before returns, in grams.

Anchor to transactionstransactions

•[OrderTransaction!]!

non-null

A list of transactions associated with the order.

Anchor to firstfirst •Int: Truncate the array result to this size.
Anchor to capturablecapturable •Boolean: Filter transactions by whether they are capturable.
Anchor to manuallyResolvablemanuallyResolvable •Boolean: Filter transactions by whether they can be resolved manually. For example, fully captured or voided transactions aren't manually resolvable.

Anchor to transactionsCounttransactionsCount

•Count

The number of transactions associated with the order.

Anchor to unpaidunpaid

non-null

Whether no payments have been made for the order.

Anchor to updatedAtupdatedAt

•LocalizationExtensionConnection!

non-null

The date and time in ISO 8601 format when the order was last modified.

Anchor to cartDiscountAmountcartDiscountAmount

•Money

Deprecated

Anchor to channelchannel

•Channel

Deprecated

Anchor to customerJourneycustomerJourney

•CustomerJourney

Deprecated

Anchor to landingPageDisplayTextlandingPageDisplayText

•String

Deprecated

Anchor to landingPageUrllandingPageUrl

•URL

Deprecated

Anchor to localizationExtensionslocalizationExtensions

non-nullDeprecated

Arguments

Anchor to countryCodescountryCodes

•[CountryCode!]

The country codes of the extensions.

Anchor to purposespurposes

•[LocalizationExtensionPurpose!]

The purpose of the extensions.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to netPaymentnetPayment

•Money!

non-nullDeprecated

Anchor to physicalLocationphysicalLocation

•Location

Deprecated

Anchor to referralCodereferralCode

•String

Deprecated

Anchor to referrerDisplayTextreferrerDisplayText

•String

Deprecated

Anchor to referrerUrlreferrerUrl

•URL

Deprecated

Anchor to riskLevelriskLevel

•OrderRiskLevel!

non-nullDeprecated

Anchor to risksrisks

•[OrderRisk!]!

non-nullDeprecated

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to subtotalPricesubtotalPrice

•Money

Deprecated

Anchor to totalCapturabletotalCapturable

•Money!

non-nullDeprecated

Anchor to totalDiscountstotalDiscounts

•Money

Deprecated

Anchor to totalPricetotalPrice

•Money!

non-nullDeprecated

Anchor to totalReceivedtotalReceived

•Money!

non-nullDeprecated

Anchor to totalRefundedtotalRefunded

•Money!

non-nullDeprecated

Anchor to totalShippingPricetotalShippingPrice

•Money!

non-nullDeprecated

Anchor to totalTaxtotalTax

•Money

Deprecated

Anchor to totalTipReceivedtotalTipReceived

•MoneyV2!

non-nullDeprecated

Anchor to Page Page

•OBJECT

A standalone content page in the online store. Pages display HTML-formatted content for informational pages like "About Us", contact information, or shipping policies.

Each page has a unique handle for URL routing and supports custom template suffixes for specialized layouts. Pages can be published or hidden, and include creation and update timestamps.

Anchor to bodybody

•HTML!

non-null

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

Anchor to bodySummarybodySummary

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.

Anchor to createdAtcreatedAt

non-null

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

Anchor to defaultCursordefaultCursor

non-null

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

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

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.

Anchor to isPublishedisPublished

non-null

Whether or not the page is visible.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to publishedAtpublishedAt

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

Anchor to templateSuffixtemplateSuffix

•String

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

non-null

Title of the page.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to Product Product

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

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

Anchor to bundleComponentsbundleComponents

•ProductBundleComponentConnection!

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to bundleConsolidatedOptionsbundleConsolidatedOptions

•[ComponentizedProductsBundleConsolidatedOption!]

A list of consolidated options for a product in a bundle.

Anchor to categorycategory

•TaxonomyCategory

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

Anchor to collectionscollections

•CollectionConnection!

non-null

A list of collections that include the product.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•CollectionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to collection_type •string
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to product_id •id: Filter by collections containing a product by its ID.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the collection was published to the Online Store.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to title •string
Anchor to updated_at •time

Anchor to combinedListingcombinedListing

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

Anchor to combinedListingRolecombinedListingRole

•CombinedListingsRole

The role of the product in a combined listing.

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

Anchor to compareAtPriceRangecompareAtPriceRange

•ProductCompareAtPriceRange

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

Anchor to contextualPricingcontextualPricing

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

Arguments

Anchor to contextcontext

•ContextualPricingContext!

required

The context used to generate contextual pricing for the variant.

Anchor to createdAtcreatedAt

non-null

The date and time when the product was created.

Anchor to defaultCursordefaultCursor

non-null

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

Anchor to descriptiondescription

non-null

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

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

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

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to featuredMediafeaturedMedia

•Media

The featured media associated with the product.

Anchor to feedbackfeedback

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

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

non-null

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

Anchor to hasOutOfStockVariantshasOutOfStockVariants

non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents

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.

Anchor to inCollectioninCollection

non-null

Whether the product is in a specified collection.

Anchor to idid •ID! required: The ID of the collection to check. For example, id: "gid://shopify/Collection/123".

Anchor to isGiftCardisGiftCard

non-null

Whether the product is a gift card.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to mediamedia

•MediaConnection!

non-null

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

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductMediaSortKeys

Default:POSITION

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id •id: Filter by id range.
Anchor to media_type •string

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

•ProductComponentTypeConnection!

required

The list of metafields to retrieve by namespace and key.

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl

•URL

The preview URL for the online store.

Anchor to onlineStoreUrlonlineStoreUrl

•URL

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

Anchor to optionsoptions

•[ProductOption!]!

non-null

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

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to priceRangeV2priceRangeV2

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

Anchor to productComponentsproductComponents

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 firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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.

Anchor to productParentsproductParents

•ProductConnection!

non-null

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

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the product was published to the online store and other sales channels.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to tracks_inventory •boolean: Filter by products that have inventory tracking enabled.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to productTypeproductType

non-null

The product type that merchants define.

Anchor to publishedAtpublishedAt

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

Anchor to publishedInContextpublishedInContext

•ContextualPublicationContext!

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

Anchor to contextcontext

required

The context used to determine publication status.

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

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

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

Anchor to requiresSellingPlanrequiresSellingPlan

•ResourcePublicationConnection!

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

non-null

The list of resources that are published to a publication.

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to resourcePublicationsCountresourcePublicationsCount

•Count

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

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to resourcePublicationsV2resourcePublicationsV2

•ResourcePublicationV2Connection!

non-null

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

Arguments

Anchor to onlyPublishedonlyPublished

Default:true

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.

Anchor to catalogTypecatalogType

•CatalogType

Filter publications by catalog type.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•SellingPlanGroupConnection!

Default:false

Reverse the order of the underlying list.

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.

Anchor to calculatedOrderIdcalculatedOrderId •ID! required: The resource Id of the order with edits applied but not saved.

Anchor to sellingPlanGroupssellingPlanGroups

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 firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

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

Anchor to seoseo

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

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.

Anchor to templateSuffixtemplateSuffix

•String

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

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.

Anchor to totalInventorytotalInventory

•Int!

non-null

The quantity of inventory that's in stock.

Anchor to tracksInventorytracksInventory

non-null

Whether inventory tracking has been enabled for the product.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unpublishedPublicationsunpublishedPublications

•PublicationConnection!

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to updatedAtupdatedAt

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.

Anchor to variantsvariants

•ProductVariantConnection!

non-null

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

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductVariantSortKeys

Default:POSITION

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to variantsCountvariantsCount

•Count

The number of variants that are associated with the product.

Anchor to vendorvendor

non-null

The name of the product's vendor.

Anchor to bodyHtmlbodyHtml

•String

Deprecated

Anchor to customProductTypecustomProductType

•String

Deprecated

Anchor to descriptionPlainSummarydescriptionPlainSummary

non-nullDeprecated

Anchor to featuredImagefeaturedImage

•Image

Deprecated

Anchor to imagesimages

•ImageConnection!

non-nullDeprecated

Arguments

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to cropcrop

•CropRegion

Deprecated

Anchor to scalescale

•Int

DeprecatedDefault:1

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductImageSortKeys

Default:POSITION

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•ProductPublicationConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to priceRangepriceRange

•ProductPriceRange!

non-nullDeprecated

Anchor to productCategoryproductCategory

•ProductCategory

Deprecated

Anchor to productPublicationsproductPublications

non-nullDeprecated

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to publicationspublications

•ProductPublicationConnection!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Return only the publications that are published. If false, then return all publications.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

Anchor to ProductVariant ProductVariant

non-nullDeprecated

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to standardizedProductTypestandardizedProductType

•StandardizedProductType

Deprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to totalVariantstotalVariants

•Int!

non-nullDeprecated

Anchor to unpublishedChannelsunpublishedChannels

•ChannelConnection!

non-nullDeprecated

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

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

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.

Anchor to availableForSaleavailableForSale

•ProductVariantContextualPricing!

non-null

Whether the product variant is available for sale.

Anchor to barcodebarcode

•String

The value of the barcode associated with the product.

Anchor to compareAtPricecompareAtPrice

•Money

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

Anchor to contextualPricingcontextualPricing

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.

Arguments

Anchor to contextcontext

•ContextualPricingContext!

required

The context used to generate contextual pricing for the variant.

Anchor to createdAtcreatedAt

non-null

The date and time when the variant was created.

Anchor to defaultCursordefaultCursor

•[DeliveryPromiseParticipant!]!

non-null

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

Anchor to deliveryProfiledeliveryProfile

•DeliveryProfile

The delivery profile for the variant.

Anchor to deliveryPromiseParticipantsdeliveryPromiseParticipants

non-null

The delivery promise participants for the product variant.

Anchor to brandedPromiseHandlebrandedPromiseHandle •String! required: The branded promise handle to filter by.

Anchor to displayNamedisplayName

non-null

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

non-null

The paginated list of events associated with the host subject.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event happened.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

•ProductVariantInventoryPolicy!

•ID!

non-null

A globally-unique ID.

Anchor to inventoryIteminventoryItem

•InventoryItem!

non-null

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

Anchor to inventoryPolicyinventoryPolicy

non-null

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

Anchor to inventoryQuantityinventoryQuantity

•Int

The total sellable quantity of the variant.

Anchor to legacyResourceIdlegacyResourceId

non-null

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

Anchor to mediamedia

•MediaConnection!

non-null

The media associated with the product variant.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldmetafield

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

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

required

The list of metafields to retrieve by namespace and key.

Anchor to positionposition

•Int!

non-null

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

Anchor to priceprice

•Money!

non-null

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

Anchor to productproduct

•Product!

non-null

The product that this variant belongs to.

Anchor to productParentsproductParents

•ProductConnection!

non-null

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

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

•ProductVariantComponentConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.
Anchor to product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
Anchor to publishable_status •string: Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.
Anchor to published_at •time: Filter by the date and time when the product was published to the online store and other sales channels.
Anchor to published_status •string: Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to tracks_inventory •boolean: Filter by products that have inventory tracking enabled.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to productVariantComponentsproductVariantComponents

non-null

A list of the product variant components.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to requiresComponentsrequiresComponents

•SellingPlanGroupConnection!

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.

Anchor to selectedOptionsselectedOptions

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

Anchor to sellingPlanGroupssellingPlanGroups

non-null

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

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

Count of selling plan groups associated with the product variant.

Anchor to showUnitPriceshowUnitPrice

non-null

Whether to show the unit price for this product variant.

Anchor to skusku

•String

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

Anchor to taxabletaxable

non-null

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

non-null

The title of the product variant.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unitPriceunitPrice

•MoneyV2

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

Anchor to unitPriceMeasurementunitPriceMeasurement

•UnitPriceMeasurement

The unit price measurement for the variant.

Anchor to updatedAtupdatedAt

non-null

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

•Image

Deprecated

Arguments

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to cropcrop

•CropRegion

Deprecated

Anchor to scalescale

•Int

DeprecatedDefault:1

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Default:false

Reverse the order of the underlying list.

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•ProductVariantPricePairConnection!

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to presentmentPricespresentmentPrices

non-nullDeprecated

Arguments

Anchor to presentmentCurrenciespresentmentCurrencies

•[CurrencyCode!]

The presentment currencies prices should return in.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

Anchor to TaxonomyValue TaxonomyValue

Default:false

Reverse the order of the underlying list.

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to taxCodetaxCode

•String

Deprecated

•OBJECT

Represents a Shopify product taxonomy value.

Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to namename •String! non-null: The name of the product taxonomy value. For example, Red.

Anchor to Video Video

•OBJECT

Represents a Shopify hosted video.

•String

A word or phrase to share the nature or contents of a media.

Anchor to createdAtcreatedAt

non-null

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

Anchor to durationduration

•Int

The video's duration in milliseconds. This value is null unless the video's status field is READY.

Anchor to fileErrorsfileErrors

non-null

Any errors that have occurred on the file.

Anchor to filenamefilename

non-null

The video's filename.

Anchor to fileStatusfileStatus

non-null

The status of the file.

•ID!

non-null

A globally-unique ID.

Anchor to mediaContentTypemediaContentType

•MediaContentType!

non-null

The media content type.

Anchor to mediaErrorsmediaErrors

•[MediaError!]!

non-null

Any errors which have occurred on the media.

Anchor to mediaWarningsmediaWarnings

•[MediaWarning!]!

non-null

The warnings attached to the media.

Anchor to originalSourceoriginalSource

•VideoSource

The video's original source. This value is null unless the video's status field is READY.

The preview image for the media.

Anchor to sourcessources

•[VideoSource!]!

non-null

The video's sources. This value is empty unless the video's status field is READY.

•MediaStatus!

non-null

Current status of the media.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to updateStatusupdateStatus