Choose a version:

EventSortKeys

enum

The set of valid sort keys for the Event query.

Anchor to Valid valuesValid values

Anchor to CREATED_ATCREATED_AT: Sort by the created_at value.
Anchor to IDID: Sort by the id value.

Was this section helpful?

Anchor to FieldsFields

Anchor to Article.events Article.events •ARGUMENT: An article in the blogging system.
Anchor to Blog.events Blog.events •ARGUMENT: Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.
Anchor to Collection.events Collection.events •ARGUMENT: The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.

There are two types of collections:

Custom (manual) collections: You specify the products to include in a collection.

Smart (automated) collections: You define rules, and products matching those rules are automatically included in the collection.

The Collection object provides information to:

Organize products by category, season, or promotion.

Automate product grouping using rules (for example, by tag, type, or price).

Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).

Manage collection visibility and publication across sales channels.

Add rich descriptions, images, and metadata to enhance discovery.

Note
Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.
Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.

Learn about using metafields with smart collections.
Anchor to Comment.events Comment.events •ARGUMENT: A comment on an article.
Anchor to Company.events Company.events •ARGUMENT: Represents information about a company which is also a customer of the shop.
Anchor to CompanyLocation.events CompanyLocation.events •ARGUMENT: A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.
Anchor to Customer.events Customer.events •ARGUMENT: Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Anchor to DiscountAutomaticBxgy.events DiscountAutomaticBxgy.events •ARGUMENT: The DiscountAutomaticBxgy object lets you manage buy X get Y discounts (BXGY) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.

The DiscountAutomaticBxgy object stores information about automatic BXGY discounts that apply to specific products and variants, collections, or all items in a cart.

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

Note
The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.
Anchor to DiscountAutomaticNode.events DiscountAutomaticNode.events •ARGUMENT: The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.
Anchor to DiscountCodeNode.events DiscountCodeNode.events •ARGUMENT: The DiscountCodeNode object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.

Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.
Anchor to DiscountNode.events DiscountNode.events •ARGUMENT: The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

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

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.
Anchor to DraftOrder.events DraftOrder.events •ARGUMENT: 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 HasEvents.events HasEvents.events •ARGUMENT: Represents an object that has a list of events.
Anchor to InventoryTransfer.events InventoryTransfer.events •ARGUMENT: Represents the intention to move inventory between locations.
Anchor to Order.events Order.events •ARGUMENT: The Order object represents a customer's request to purchase one or more products from a store. Use the Order object to handle the complete purchase lifecycle from checkout to fulfillment.

Use the Order object when you need to:

Display order details on customer account pages or admin dashboards.

Create orders for phone sales, wholesale customers, or subscription services.

Update order information like shipping addresses, notes, or fulfillment status.

Process returns, exchanges, and partial refunds.

Generate invoices, receipts, and shipping labels.

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

Note
Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders, read_orders, and write_orders scopes.
Caution
Only use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.
Anchor to Page.events Page.events •ARGUMENT: A page on the Online Store.
Anchor to PriceRule.events PriceRule.events •ARGUMENT: Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

We recommend using the types and queries detailed at Getting started with discounts instead. These will replace the GraphQL PriceRule object and REST Admin PriceRule and DiscountCode resources.
Anchor to Product.events Product.events •ARGUMENT: 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 ProductVariant.events ProductVariant.events •ARGUMENT: 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 QueryRoot.events QueryRoot.events •ARGUMENT: The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
Anchor to events.sortKey events.sortKey •QUERY

Was this section helpful?