Navigable

The billing address provided by the buyer. Null if the user did not provide a billing address.

Anchor to completedAtcompletedAt

The date and time when the buyer completed the checkout. Null if the checkout has not been completed.

Anchor to createdAtcreatedAt

non-null

The date and time when the checkout was created.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

A list of extra information that has been added to the checkout.

Anchor to customercustomer

•Customer

The customer who created this checkout. May be null if the checkout was created from a draft order or via an app.

Anchor to defaultCursordefaultCursor

non-null

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

Anchor to discountCodesdiscountCodes

non-null

The discount codes entered by the buyer at checkout.

•AbandonedCheckoutLineItemConnection!

•ID!

non-null

A globally-unique ID.

Anchor to lineItemslineItems

non-null

A list of the line items in this checkout.

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

Unique merchant-facing identifier for the checkout.

Anchor to notenote

non-null

A merchant-facing note added to the checkout. Not visible to the buyer.

Anchor to shippingAddressshippingAddress

The shipping address to where the line items will be shipped. Null if the user did not provide a shipping address.

Anchor to subtotalPriceSetsubtotalPriceSet

non-null

The sum of all items in the checkout, including discounts but excluding shipping, taxes and tips.

Anchor to taxesIncludedtaxesIncluded

non-null

Whether taxes are included in line item and shipping line prices.

Anchor to taxLinestaxLines

•[TaxLine!]!

non-null

Individual taxes charged on the checkout.

Anchor to totalDiscountSettotalDiscountSet

non-null

The total amount of discounts to be applied.

Anchor to totalDutiesSettotalDutiesSet

•MoneyBag

The total duties applied to the checkout.

Anchor to totalLineItemsPriceSettotalLineItemsPriceSet

non-null

The sum of the prices of all line items in the checkout.

Anchor to totalPriceSettotalPriceSet

non-null

The sum of all items in the checkout, including discounts, shipping, taxes, and tips.

Anchor to totalTaxSettotalTaxSet

•MoneyBag

The total tax applied to the checkout.

Anchor to updatedAtupdatedAt

Anchor to Article Article

non-null

The date and time when the checkout was most recently updated.

Anchor to lineItemsQuantitylineItemsQuantity

•Int!

non-nullDeprecated

•OBJECT

An article that contains content, author information, and metadata. Articles belong to a Blog and can include HTML-formatted body text, summary text, and an associated image. Merchants publish articles to share content, drive traffic, and engage customers.

Articles can be organized with tags and published immediately or scheduled for future publication using the publishedAt timestamp. The API manages comments on articles when the blog's comment policy enables them.

Anchor to authorauthor

•ArticleAuthor

The name of the author of the article.

Anchor to blogblog

•Blog!

non-null

The blog containing the article.

Anchor to bodybody

•HTML!

non-null

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

Anchor to commentscomments

•CommentConnection!

non-null

List of the article's comments.

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

Anchor to imageimage

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

Anchor to tagstags

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 Company Company

•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

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.

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.

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 CompanyLocation CompanyLocation

•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

A location or branch of a Company that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.

Anchor to billingAddressbillingAddress

•CompanyAddress

The address used as billing address for the location.

Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration

•BuyerExperienceConfiguration

The configuration for the buyer's B2B checkout.

Anchor to catalogscatalogs

•CatalogConnection!

non-null

The list of catalogs associated with the company location.

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 catalogsCountcatalogsCount

•Count

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to companycompany

•Company!

non-null

The company that the company location belongs to.

Anchor to createdAtcreatedAt

non-null

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

Anchor to currencycurrency

•CurrencyCode!

non-null

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

Anchor to defaultCursordefaultCursor

non-null

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

Anchor to draftOrdersdraftOrders

•DraftOrderConnection!

non-null

The list of draft orders for the company location.

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

Anchor to hasTimelineCommenthasTimelineComment

non-null

Whether the merchant added a timeline comment to the company location.

•ID!

non-null

A globally-unique ID.

Anchor to inCataloginCatalog

non-null

Whether the company location is assigned a specific catalog.

Anchor to catalogIdcatalogId •ID! required: The ID of the catalog.

Anchor to localelocale

•String

The preferred locale of the company location.

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.

non-null

The name of the company location.

Anchor to notenote

•String

A note about the company location.

Anchor to ordersorders

•OrderConnection!

non-null

The list of orders for the company location.

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.

•CompanyContactRoleAssignmentConnection!

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

Anchor to ordersCountordersCount

•Count

The total number of orders placed for the location.

Anchor to phonephone

•String

The phone number of the company location.

Anchor to roleAssignmentsroleAssignments

non-null

The list of roles assigned to the company location.

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.

•CompanyContactRoleAssignmentSortKeys

Default:ID

Sort the underlying list by the given key.

•CompanyLocationStaffMemberAssignmentConnection!

•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_contact_id •id
Anchor to company_contact_role_id •id
Anchor to company_id •id
Anchor to company_location_id •id
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to location_name •string
Anchor to role_name •string
Anchor to updated_at •time

Anchor to shippingAddressshippingAddress

•CompanyAddress

The address used as shipping address for the location.

Anchor to staffMemberAssignmentsstaffMemberAssignments

non-null

The list of staff members assigned to the company location.

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.

•CompanyLocationStaffMemberAssignmentSortKeys

Default:ID

Sort the underlying list by the given key.

•StoreCreditAccountConnection!

•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 company_location_id •id
Anchor to created_at •time
Anchor to id •id: Filter by id range.
Anchor to staff_member_id •id
Anchor to updated_at •time

Anchor to storeCreditAccountsstoreCreditAccounts

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.

•CompanyLocationTaxSettings!

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

non-null

The tax settings for the company location.

Anchor to totalSpenttotalSpent

•MoneyV2!

non-null

The total amount spent by the location.

Anchor to updatedAtupdatedAt

non-null

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

Anchor to marketmarket

•Market!

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 CustomerAccountAppExtensionPage CustomerAccountAppExtensionPage

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

•Int!

non-nullDeprecated

Anchor to taxExemptionstaxExemptions

•[TaxExemption!]!

non-nullDeprecated

Anchor to taxRegistrationIdtaxRegistrationId

•String

Deprecated

•OBJECT

An app extension page for the customer account navigation menu.

Anchor to appExtensionUuidappExtensionUuid •String: The UUID of the app extension.
Anchor to defaultCursordefaultCursor •String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to handlehandle •String! non-null: A unique, human-friendly string for the customer account page.
Anchor to idid •ID! non-null: The unique ID for the customer account page.
Anchor to titletitle •String! non-null: The title of the customer account page.

Anchor to CustomerAccountNativePage CustomerAccountNativePage

•OBJECT

A native page for the customer account navigation menu.

Anchor to defaultCursordefaultCursor

non-null

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

non-null

A unique, human-friendly string for the customer account page.

•CustomerAccountNativePagePageType!

•ID!

non-null

The unique ID for the customer account page.

Anchor to pageTypepageType

non-null

The type of customer account native page.

Anchor to DraftOrder DraftOrder

non-null

The title of the customer account page.

•OBJECT

An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:

Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
Send invoices to customers to pay with a secure checkout link.
Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
Re-create orders manually from active sales channels.
Sell products at discount or wholesale rates.
Take pre-orders.

For draft orders in multiple currencies presentment_money is the source of truth for what a customer is going to be charged and shop_money is an estimate of what the merchant might receive in their shop currency.

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.

Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.

Anchor to acceptAutomaticDiscountsacceptAutomaticDiscounts

Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see appliedDiscount) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.

Anchor to allowDiscountCodesInCheckoutallowDiscountCodesInCheckout

non-null

Whether discount codes are allowed during checkout of this draft order.

Anchor to allVariantPricesOverriddenallVariantPricesOverridden

non-null

Whether all variant prices have been overridden.

Anchor to anyVariantPricesOverriddenanyVariantPricesOverridden

non-null

Whether any variant prices have been overridden.

Anchor to appliedDiscountappliedDiscount

•DraftOrderAppliedDiscount

The custom order-level discount applied.

Anchor to billingAddressbillingAddress

The billing address of the customer.

Anchor to billingAddressMatchesShippingAddressbillingAddressMatchesShippingAddress

non-null

Whether the billing address matches the shipping address.

Anchor to completedAtcompletedAt

The date and time when the draft order was converted to a new order, and had it's status changed to Completed.

Anchor to createdAtcreatedAt

non-null

The date and time when the draft order was created in Shopify.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The shop currency used for calculation.

Anchor to customAttributescustomAttributes

•[Attribute!]!

non-null

The custom information added to the draft order on behalf of the customer.

Anchor to customercustomer

•Customer

The customer who will be sent an invoice.

Anchor to defaultCursordefaultCursor

non-null

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

Anchor to discountCodesdiscountCodes

non-null

All discount codes applied.

Anchor to emailemail

•String

The email address of the customer, which is used to send notifications.

non-null

The list of events associated with the draft order.

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 hasTimelineCommenthasTimelineComment

non-null

Whether the merchant has added timeline comments to the draft order.

•ID!

non-null

A globally-unique ID.

Anchor to invoiceEmailTemplateSubjectinvoiceEmailTemplateSubject

non-null

The subject defined for the draft invoice email template.

Anchor to invoiceSentAtinvoiceSentAt

The date and time when the invoice was last emailed to the customer.

Anchor to invoiceUrlinvoiceUrl

•URL

The link to the checkout, which is sent to the customer in the invoice email.

Anchor to legacyResourceIdlegacyResourceId

•DraftOrderLineItemConnection!

non-null

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

Anchor to lineItemslineItems

non-null

The list of the line items in the draft 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 lineItemsSubtotalPricelineItemsSubtotalPrice

non-null

A subtotal of the line items and corresponding discounts, excluding shipping charges, shipping discounts, taxes, or order discounts.

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

•[DraftOrderPlatformDiscount!]!

non-null

The identifier for the draft order, which is unique within the store. For example, #D1223.

Anchor to note2note2

•String

The text from an optional note attached to the draft order.

Anchor to orderorder

•Order

The order that was created from the draft order.

Anchor to paymentTermspaymentTerms

•PaymentTerms

The associated payment terms for this draft order.

Anchor to phonephone

•String

The assigned phone number.

Anchor to platformDiscountsplatformDiscounts

non-null

The list of platform discounts applied.

Anchor to poNumberpoNumber

•String

The purchase order number.

Anchor to presentmentCurrencyCodepresentmentCurrencyCode

•CurrencyCode!

non-null

The payment currency used for calculation.

Anchor to purchasingEntitypurchasingEntity

•PurchasingEntity

The purchasing entity.

Anchor to readyready

non-null

Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.

Anchor to reserveInventoryUntilreserveInventoryUntil

The time after which inventory will automatically be restocked.

Anchor to shippingAddressshippingAddress

The shipping address of the customer.

Anchor to shippingLineshippingLine

•ShippingLine

The line item containing the shipping information and costs.

Anchor to statusstatus

•DraftOrderStatus!

non-null

The status of the draft order.

Anchor to subtotalPriceSetsubtotalPriceSet

non-null

The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.

Anchor to tagstags

non-null

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

Anchor to taxesIncludedtaxesIncluded

non-null

Whether the line item prices include taxes.

Anchor to taxExempttaxExempt

non-null

Whether the draft order is tax exempt.

Anchor to taxLinestaxLines

•[TaxLine!]!

non-null

The list of of taxes lines charged for each line item and shipping line.

Anchor to totalDiscountsSettotalDiscountsSet

non-null

Total discounts.

Anchor to totalLineItemsPriceSettotalLineItemsPriceSet

non-null

Total price of line items, excluding discounts.

Anchor to totalPriceSettotalPriceSet

non-null

The total price, includes taxes, shipping charges, and discounts.

Anchor to totalQuantityOfLineItemstotalQuantityOfLineItems

•Int!

non-null

The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.

Anchor to totalShippingPriceSettotalShippingPriceSet

non-null

The total shipping price.

Anchor to totalTaxSettotalTaxSet

non-null

The total tax.

Anchor to totalWeighttotalWeight

non-null

The total weight in grams of the draft order.

Anchor to transformerFingerprinttransformerFingerprint

•String

Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.

Anchor to updatedAtupdatedAt

non-null

The date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.

Anchor to visibleToCustomervisibleToCustomer

•LocalizationExtensionConnection!

non-null

Whether the draft order will be visible to the customer on the self-serve portal.

Anchor to warningswarnings

•[DraftOrderWarning!]!

non-null

The list of warnings raised while calculating.

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 marketNamemarketName

non-nullDeprecated

Anchor to marketRegionCountryCodemarketRegionCountryCode

•CountryCode!

non-nullDeprecated

Anchor to subtotalPricesubtotalPrice

•Money!

non-nullDeprecated

Anchor to totalPricetotalPrice

•Money!

non-nullDeprecated

Anchor to totalShippingPricetotalShippingPrice

•Money!

non-nullDeprecated

Anchor to totalTaxtotalTax

•Money!

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 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 mediaCountmediaCount

•Count

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

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

•ProductComponentTypeConnection!

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

Anchor to statusstatus

•ProductStatus!

non-null

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

Anchor to tagstags

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

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

Anchor to imageimage

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