QueryRoot

Returns a list of abandoned checkouts. A checkout is considered abandoned when a customer adds contact information but doesn't complete their purchase. Includes both abandoned and recovered checkouts.

Each checkout provides Customer details, AbandonedCheckoutLineItem objects, pricing information, and a recovery URL for re-engaging customers who didn't complete their purchase.

Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000 by default.

Returns a Abandonment resource by ID.

Returns an Abandonment by the Abandoned Checkout ID.

Retrieves an App by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information.

If the app isn't installed on the current shop, then the installation field will be null.

Retrieves an app by its unique handle. The handle is a URL-friendly identifier for the app.

Returns the App if found, or null if no app exists with the specified handle.

Retrieves an App by its client ID (API key). Returns the app's configuration, installation status, AccessScope objects, and developer information.

Returns null if no app exists with the specified client ID.

An app discount type.

A list of app discount types installed by apps.

A list of app discount types installed by apps.

Retrieves an AppInstallation by ID. If no ID is provided, returns the installation for the currently authenticated App. The query provides essential data for validating installation state and managing app functionality within a store.

Use this query to access installation details including granted AccessScope objects, active AppSubscription objects, AppCredit objects, AppPurchaseOneTime objects, and app-specific metadata.

Learn more about app installation.

A paginated list of AppInstallation objects across multiple stores where your app is installed. Use this query to monitor installation status, track billing and subscriptions through AppSubscription objects, and review granted AccessScope objects.

Filter by AppInstallationCategory to find specific types of installations (such as POS or channel apps) and by AppInstallationPrivacy to scope to public or private installations.

Returns a Article resource by ID.

List of article authors for the shop.

Returns a paginated list of articles from the shop's blogs. Article objects are blog posts that contain content like text, images, and tags.

Supports cursor-based pagination to control the number of articles returned and their order. Use the query argument to filter results by specific criteria.

List of all article tags.

The paginated list of fulfillment orders assigned to the shop locations owned by the app.

Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by fulfillment services that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated fulfillment requests, or might currently not be requested to be fulfilled.

The app must have the read_assigned_fulfillment_orders access scope to be able to retrieve the fulfillment orders assigned to its locations.

All assigned fulfillment orders (except those with the CLOSED status) will be returned by default. Perform filtering with the assignmentStatus argument to receive only fulfillment orders that have been requested to be fulfilled.

Returns a DiscountAutomaticNode resource by ID.

Returns a list of automatic discounts.

List of the shop's automatic discount saved searches.

The geographic regions that you can set as the Shop's backup region. The backup region serves as a fallback when the system can't determine a buyer's actual location.

Returns a list of activated carrier services and associated shop locations that support them.

Returns all locales that Shopify supports. Each Locale includes an ISO code and human-readable name. Use this query to discover which locales you can enable on a shop with the shopLocaleEnable mutation.

The backup region of the shop.

Returns a Blog resource by ID.

Returns a paginated list of the shop's Blog objects. Blogs serve as containers for Article objects and provide content management capabilities for the store's editorial content.

Supports cursor-based pagination to control the number of blogs returned and their order. Use the query argument to filter results by specific criteria.

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

Returns a list of Business Entities associated with the shop.

Returns a Business Entity by ID.

Returns a DeliveryCarrierService resource by ID.

A paginated list of carrier services configured for the shop. Carrier services provide real-time shipping rates from external providers like FedEx, UPS, or custom shipping solutions. Use the query parameter to filter results by attributes such as active status.

Retrieves all cart transform functions currently deployed by your app within the merchant's store. This query provides comprehensive access to your active cart modification logic, enabling management and monitoring of bundling and merchandising features.

The query returns paginated results with full cart transform details, including function IDs, configuration settings, and operational status.

Cart Transform ownership is scoped to your API client, ensuring you only see and manage functions deployed by your specific app. This isolation prevents conflicts between different apps while maintaining security boundaries for sensitive merchandising logic.

Learn more about managing cart transforms.

Returns a CashTrackingSession resource by ID.

Returns a shop's cash tracking sessions for locations with a POS Pro subscription.

Tip: To query for cash tracking sessions in bulk, you can perform a bulk operation.

Retrieves a catalog by its ID. A catalog represents a list of products with publishing and pricing information, and can be associated with a context, such as a market, company location, or app.

Use the catalog query to retrieve information associated with the following workflows:

• Managing product publications across different contexts
• Setting up contextual pricing with price lists
• Managing market-specific product availability
• Configuring B2B customer catalogs

There are several types of catalogs:

• MarketCatalog
• AppCatalog
• CompanyLocationCatalog

Learn more about catalogs for different markets.

Returns the most recent catalog operations for the shop.

The catalogs belonging to the shop.

The count of catalogs belonging to the shop. Limited to a maximum of 10000 by default.

Returns the visual customizations for checkout for a given checkout profile.

To update checkout branding settings, use the checkoutBrandingUpsert mutation. Learn more about customizing checkout's appearance.

Returns a CheckoutProfile. Checkout profiles define the branding settings and UI extensions for a store's checkout experience. Stores can have one published profile that renders on their live checkout and multiple draft profiles for testing customizations in the checkout editor.

List of checkout profiles on a shop.

Returns a code discount resource by ID.

Retrieves a code discount by its discount code. The search is case-insensitive, enabling you to find discounts regardless of how customers enter the code.

Returns a DiscountCodeNode that contains the underlying discount details, which could be a basic amount off discount, a "Buy X Get Y" (BXGY) discount, a free shipping discount, or an app-provided discount.

Learn more about working with Shopify's discount model.

Returns a list of code-based discounts.

List of the shop's code discount saved searches.

Retrieves a collection by its ID. A collection represents a grouping of products that merchants can display and sell as a group in their online store and other sales channels.

Use the collection query when you need to:

• Manage collection publishing across sales channels
• Access collection metadata and SEO information
• Work with collection rules and product relationships

A collection can be either a custom (manual) collection where products are manually added, or a smart (automated) collection where products are automatically included based on defined rules. Each collection has associated metadata including title, description, handle, image, and metafields.

Return a collection by an identifier.

Lists all rules that can be used to create smart collections.

Retrieves a list of collections in a store. Collections are groups of products that merchants can organize for display in their online store and other sales channels. For example, an athletics store might create different collections for running attire, shoes, and accessories.

Use the collections query when you need to:

• Build a browsing interface for a store's product groupings.
• Create collection searching, sorting, and filtering experiences (for example, by title, type, or published status).
• Sync collection data with external systems.
• Manage both custom (manual) and smart (automated) collections.

The collections query supports pagination for large catalogs and saved searches for frequently used collection queries.

The collections query returns collections with their associated metadata, including:

• Basic collection information (title, description, handle, and type)
• Collection image and SEO metadata
• Product count and product relationships
• Collection rules (for smart collections)
• Publishing status and publication details
• Metafields and custom attributes

Learn more about using metafields with smart collections.

Returns a list of the shop's collection saved searches.

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

Returns a Comment resource by ID.

List of the shop's comments.

A paginated list of companies in the shop. Company objects are business entities that purchase from the merchant.

Use the query argument to filter companies by attributes like name or externalId. Sort and paginate results to handle large datasets efficiently. Learn more about Shopify API search syntax.

The number of companies for a shop. Limited to a maximum of 10000 by default.

Returns a Company resource by ID.

Returns a CompanyContact resource by ID.

Returns a CompanyContactRole resource by ID.

Returns a CompanyLocation resource by ID.

A paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.

Each location can have its own billing and shipping addresses, tax settings, PaymentTerms, and Catalog assignments with custom pricing. Use the query parameter to search locations by name or other attributes.

Learn more about managing company locations.

Returns the customer privacy consent policies of a shop.

List of countries and regions for which consent policies can be created or updated.

Returns the AppInstallation for the currently authenticated app. Provides access to granted access scopes, active AppSubscription objects, and billing information for your app.

Use this query to check which permissions your app has, monitor subscription status, or retrieve AppCredit objects. Learn more about managing access scopes, subscription billing, and app credits.

The staff member making the API request.

Returns a Customer resource by ID.

Returns a CustomerAccountPage resource by ID.

List of the shop's customer account pages.

Return a customer by an identifier.

Returns the status of a customer merge request job.

Returns a preview of a customer merge request.

Returns a CustomerPaymentMethod resource by its ID.

Returns a list of customers in your Shopify store, including key information such as name, email, location, and purchase history. Use this query to segment your audience, personalize marketing campaigns, or analyze customer behavior by applying filters based on location, order history, marketing preferences and tags. The customers query supports pagination and sorting.

List of the shop's customer saved searches.

The number of customers. Limited to a maximum of 10000 by default.

A paginated list of customers that belong to an individual Segment. Segments group customers based on criteria defined through ShopifyQL queries. Access segment members with their profile information and purchase summary data. The connection includes statistics for analyzing segment attributes (such as average and sum calculations) and a total count of all members. The maximum page size is 1000.

Whether a member, which is a customer, belongs to a segment.

Returns a CustomerSegmentMembersQuery resource by ID.

The delivery customization.

The delivery customizations.

Retrieves a DeliveryProfile by ID. Delivery profiles group shipping settings for specific Product objects that ship from selected Location objects to [delivery zones](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone with defined rates.

Learn more about delivery profiles.

Returns a paginated list of DeliveryProfile objects for the shop. Delivery profiles group Product and ProductVariant objects that share shipping rates and zones.

Each profile contains DeliveryLocationGroup objects that organize fulfillment Location objects and their associated delivery zones. DeliveryZone objects define geographic regions with specific shipping methods and rates. Use the merchantOwnedOnly filter to exclude profiles that third-party apps manage.

Learn more about delivery profiles.

Returns delivery promise participants.

Lookup a delivery promise provider.

Represents the delivery promise settings for a shop.

Returns the shop-wide shipping settings.

The total number of discount codes for the shop. Limited to a maximum of 10000 by default.

Returns a DiscountNode resource by ID.

Returns a list of discounts.

The total number of discounts for the shop. Limited to a maximum of 10000 by default.

Returns a DiscountRedeemCodeBulkCreation resource by ID.

List of the shop's redeemed discount code saved searches.

Returns a ShopifyPaymentsDispute resource by ID.

Returns a ShopifyPaymentsDisputeEvidence resource by ID.

All disputes related to the Shop.

Returns a Domain resource by ID.

Retrieves a draft order by its ID. A draft order is an order created by a merchant on behalf of their customers. Draft orders contain all necessary order details (products, pricing, customer information) but require payment to be accepted before they can be converted into completed orders.

Use the draftOrder query to retrieve information associated with the following workflows:

• Creating orders for phone, in-person, or chat sales
• Sending invoices to customers with secure checkout links
• Managing custom items and additional costs
• Selling products at discount or wholesale rates
• Processing pre-orders and saving drafts for later completion

A draft order is associated with a customer and contains multiple line items. Each draft order has a status, which indicates its progress through the sales workflow.

Returns a list of available delivery options for a draft order.

List of saved draft orders.

List of the shop's draft order saved searches.

Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

Returns a DraftOrderTag resource by ID.

Retrieves a single event by ID. Events chronicle activities in your store such as resource creation, updates, or staff comments. The query returns an Event interface of type BasicEvent or CommentEvent.

A paginated list of events that chronicle activities in the store. Event is an interface implemented by types such as BasicEvent and CommentEvent that track actions such as creating Article objects, fulfilling Order objects, adding Product objects, or staff comments on timelines.

The query supports filtering and sorting to help you find specific events or audit store activity over time.

Count of events. Limited to a maximum of 10000.

Retrieves a paginated list of files that have been uploaded to a Shopify store. Files represent digital assets that merchants can upload to their store for various purposes including product images, marketing materials, documents, and brand assets.

Use the files query to retrieve information associated with the following workflows:

• Managing product media and images
• Theme development and asset management
• Brand asset management and checkout branding

Files can include multiple content types, such as images, videos, 3D models, and generic files. Each file has properties like dimensions, file size, alt text for accessibility, and upload status. Files can be filtered by media type and can be associated with products, themes, and other store resources.

A list of the shop's file saved searches.

Returns the access policy for a finance app .

Returns the KYC information for the shop's Shopify Payments account, used in embedded finance apps.

Returns a Fulfillment resource by ID.

The fulfillment constraint rules that belong to a shop.

Returns a FulfillmentOrder resource by ID.

The paginated list of all fulfillment orders. The returned fulfillment orders are filtered according to the fulfillment order access scopes granted to the app.

Use this query to retrieve fulfillment orders assigned to merchant-managed locations, third-party fulfillment service locations, or all kinds of locations together.

For fetching only the fulfillment orders assigned to the app's locations, use the assignedFulfillmentOrders connection.

Returns a FulfillmentService resource by ID.

Retrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.

Additional fields include the initial value, expiration date, deactivation timestamp (if applicable), and the associated Order if the gift card was purchased by a customer through checkout. Gift cards that merchants create manually won't have an associated order.

The configuration for the shop's gift cards.

Returns a paginated list of GiftCard objects issued for the shop.

You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter. You can also apply SavedSearch objects to filter results.

The total number of gift cards issued for the shop. Limited to a maximum of 10000 by default.

Returns an InventoryItem object by ID.

Returns a list of inventory items.

Returns an InventoryLevel object by ID.

General inventory properties for the shop.

Returns an inventory shipment by ID.

Returns an inventory transfer by ID.

Returns a paginated list of transfers.

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

Returns an inventory Location resource by ID.

Return a location by an identifier.

Returns a list of active inventory locations.

Returns a list of all origin locations available for a delivery profile.

Returns the count of locations for the given shop. Limited to a maximum of 10000 by default.

Returns a list of fulfillment orders that are on hold.

Returns a Market resource by ID.

A list of marketing activities associated with the marketing app.

Returns a MarketingActivity resource by ID.

Returns a MarketingEvent resource by ID.

A list of marketing events associated with the marketing app.

A resource that can have localized values for different markets.

Resources that can have localized values for different markets.

Resources that can have localized values for different markets.

Returns a paginated list of Market objects configured for the shop. Markets match buyers based on defined conditions to deliver customized shopping experiences.

Filter markets by MarketType and MarketStatus, search by name, and control sort order. Retrieve market configurations including MarketCurrencySettings, MarketWebPresence objects, and MarketConditions.

Learn more about Shopify Markets.

The resolved values for a buyer signal.

Returns a Menu resource by ID.

The shop's menus.

Retrieves a MetafieldDefinition by its identifier. You can identify a definition using either its owner type, namespace, and key, or its global ID.

Use this query to inspect a definition's configuration, including its data type, validations, access settings, and the count of metafields using it.

Returns a list of metafield definitions.

The available metafield types that you can use when creating MetafieldDefinition objects. Each type specifies what kind of data it stores (such as boolean, color, date, or references), its category, and which validations it supports.

For a list of supported types and their capabilities, refer to the metafield types documentation.

Retrieves a single Metaobject by its global ID. Metaobjects store custom structured data based on defined schemas. The returned metaobject includes its fields with values, display name, handle, and associated metadata like update timestamps and capabilities.

Retrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.

Retrieves a MetaobjectDefinition by its global ID. Metaobject definitions provide the structure and fields for metaobjects.

The definition includes field configurations, access settings, display preferences, and capabilities that determine how metaobjects of this type behave across the Shopify platform.

Retrieves a MetaobjectDefinition by its type. The type serves as a unique identifier that distinguishes one metaobject definition from another.

Returns a paginated list of all MetaobjectDefinition objects configured for the store. Metaobject definitions provide the schema for creating custom data structures composed of individual fields. Each definition specifies the field types, access permissions, and capabilities for Metaobject entries of that type. Use this query to discover available metaobject types before creating or querying metaobject entries.

Learn more about managing metaobjects.

Returns a paginated list of Metaobject entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant or app-specific data types.

Filter results using the query parameter with a search syntax for metaobject fields. Use fields.{key}:{value} to filter by field values, supporting any field previously marked as filterable. The sortKey parameter accepts id, type, updated_at, or display_name to control result ordering.

Learn more about querying metaobjects by field value.

Return a mobile platform application by its ID.

List the mobile platform applications.

Returns a specific node (any object that implements the Node interface) by ID, in accordance with the Relay specification. This field is commonly used for refetching an object.

Returns the list of nodes (any objects that implement the Node interface) with the given IDs, in accordance with the Relay specification.

The shop's online store channel.

The order query retrieves an order by its ID. This query provides access to comprehensive order information such as customer details, line items, financial data, and fulfillment status.

Use the order query to retrieve information associated with the following processes:

• Order management and fulfillment
• Financial reporting
• Customer purchase history and transaction analysis
• Shipping and inventory management

You can only retrieve the last 60 days worth of orders from a store by default. If you want to access older orders, then you need to request access to all orders.

For large order datasets, consider using bulk operations. Bulk operations handle pagination automatically and allow you to retrieve data asynchronously without being constrained by API rate limits. Learn more about creating orders and building order management apps.

Return an order by an identifier.

Returns a OrderEditSession resource by ID.

Returns a payment status by payment reference ID. Used to check the status of a deferred payment.

Returns a list of orders placed in the store, including data such as order status, customer, and line item details. Use the orders query to build reports, analyze sales performance, or automate fulfillment workflows. The orders query supports pagination, sorting, and filtering.

Returns saved searches for orders in the shop. Saved searches store search queries with their filters and search terms.

Returns the count of orders for the given shop. Limited to a maximum of 10000 by default.

Returns a Page resource by ID.

A paginated list of pages from the online store. Page objects are content pages that merchants create to provide information to customers, such as "About Us", "Contact", or policy pages.

The query supports filtering with a search query and sorting by various criteria. Advanced filtering is available through saved searches using the savedSearchId argument.

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

The payment customization.

The payment customizations.

The list of payment terms templates eligible for all shops and users.

The number of pendings orders. Limited to a maximum of 10000.

Returns a PointOfSaleDevice resource by ID.

Returns a price list resource by ID.

All price lists for a shop.

Privacy related settings for a shop.

Retrieves a product by its ID. A product is an item that a merchant can sell in their store.

Use the product query when you need to:

• Access essential product data (for example, title, description, price, images, SEO metadata, and metafields).
• Build product detail pages and manage inventory.
• Handle international sales with localized pricing and content.
• Manage product variants and product options.

Learn more about working with Shopify's product model.

Return a product by an identifier.

Returns the product duplicate job.

Returns a ProductFeed resource by ID.

The product feeds for the shop.

Returns a ProductOperation resource by ID.

This can be used to query the ProductSetOperation, using the ID that was returned when the product was created or updated by the ProductSet mutation.

The status field indicates whether the operation is CREATED, ACTIVE, or COMPLETE.

The product field provides the details of the created or updated product.

For the ProductSetOperation, the userErrors field provides mutation errors that occurred during the operation.

Retrieves product resource feedback for the currently authenticated app, providing insights into product data quality, completeness, and optimization opportunities. This feedback helps apps guide merchants toward better product listings and improved store performance.

For example, an SEO app might receive feedback indicating that certain products lack meta descriptions or have suboptimal titles, enabling the app to provide specific recommendations for improving search visibility and conversion rates.

Use ProductResourceFeedback to:

• Display product optimization recommendations to merchants
• Identify data quality issues across product catalogs
• Build product improvement workflows and guided experiences
• Track progress on product listing completeness and quality
• Implement automated product auditing and scoring systems
• Generate reports on catalog health and optimization opportunities
• Provide contextual suggestions within product editing interfaces

The feedback system evaluates products against various criteria including SEO best practices, required fields, media quality, and sales channel requirements. Each feedback item includes specific details about the issue, suggested improvements, and priority levels.

Feedback is app-specific and reflects the particular focus of your application - marketing apps receive different insights than inventory management apps. The system continuously updates as merchants make changes, providing real-time guidance for product optimization.

This resource is particularly valuable for apps that help merchants improve their product listings, optimize for search engines, or enhance their overall catalog quality. The feedback enables proactive suggestions rather than reactive problem-solving.

Learn more about product optimization.

Retrieves a list of products in a store. Products are the items that merchants can sell in their store.

Use the products query when you need to:

• Build a browsing interface for a product catalog.
• Create product searching, sorting, and filtering experiences.
• Implement product recommendations.
• Sync product data with external systems.

The products query supports pagination to handle large product catalogs and saved searches for frequently used product queries.

The products query returns products with their associated metadata, including:

• Basic product information (for example, title, description, vendor, and type)
• Product options and product variants, with their prices and inventory
• Media attachments (for example, images and videos)
• SEO metadata
• Product categories and tags
• Product availability and publishing statuses

Learn more about working with Shopify's product model.

Returns a list of the shop's product saved searches.

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

Returns tags added to Product objects in the shop. Provides a paginated list of tag strings.

The maximum page size is 5000 tags per request. Tags are returned as simple strings through a StringConnection. The maximum page size is 5000.

The list of types added to products. The maximum page size is 1000.

Retrieves a product variant by its ID.

A product variant is a specific 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 query when you need to:

• Access essential product variant data (for example, title, price, image, and metafields).
• Build product detail pages and manage inventory.
• Handle international sales with localized pricing and content.
• Manage product variants that are part of a bundle or selling plan.

Learn more about working with Shopify's product model.

Return a product variant by an identifier.

Retrieves a list of product variants associated with a product.

A product variant is a specific 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 productVariants query when you need to:

• Search for product variants by attributes such as SKU, barcode, or inventory quantity.
• Filter product variants by attributes, such as whether they're gift cards or have custom metafields.
• Fetch product variants for bulk operations, such as updating prices or inventory.
• Preload data for product variants, such as inventory items, selected options, or associated products.

The productVariants query supports pagination to handle large product catalogs and saved searches for frequently used product variant queries.

The productVariants query returns product variants with their associated metadata, including:

• Basic product variant information (for example, title, SKU, barcode, price, and inventory)
• Media attachments (for example, images and videos)
• Associated products, selling plans, bundles, and metafields

Learn more about working with Shopify's product model.

Count of product variants. Limited to a maximum of 10000 by default.

The list of vendors added to products. The maximum page size is 1000.

The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.

Lookup a publication by ID.

List of publications.

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

Returns a count of published products by publication ID. Limited to a maximum of 10000 by default.

Retrieves a refund by its ID. A refund represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues.

Use the refund query to retrieve information associated with the following workflows:

• Displaying refund details in order management interfaces
• Building customer service tools for reviewing refund history
• Creating reports on refunded amounts and reasons
• Auditing refund transactions and payment gateway records
• Tracking inventory impacts from refunded items

A refund is associated with an order and includes refund line items that specify which items were refunded. Each refund processes through order transactions that handle the actual money transfer back to the customer.

Retrieves a return by its ID. A return represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location.

Use the return query to retrieve information associated with the following workflows:

• Managing returns
• Processing exchanges
• Tracking reverse fulfillment orders

A return is associated with an order and can include multiple return line items. Each return has a status, which indicates the state of the return.

Returns a ReturnableFulfillment resource by ID.

List of returnable fulfillments.

The calculated monetary value to be exchanged due to the return.

Lookup a reverse delivery by ID.

Lookup a reverse fulfillment order by ID.

Returns a ScriptTag resource by ID.

A list of script tags.

Retrieves a customer Segment by ID. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries.

Use segments for targeted marketing campaigns, analyzing customer behavior, or creating personalized experiences. Each segment includes its name, creation date, and the query that defines which Customer objects belong to it.

A list of filters.

A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.

A list of a shop's segment migrations.

Returns a paginated list of Segment objects for the shop. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries. You can filter segments by search query and sort them by creation date or other criteria.

The query supports standard pagination arguments and returns a SegmentConnection containing segment details including names, creation dates, and the query definitions that determine segment membership.

The number of segments for a shop. Limited to a maximum of 10000 by default.

The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.

Returns a SellingPlanGroup resource by ID.

List Selling Plan Groups.

The server pixel configured by the app.

Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.

The shop's billing preferences, including the currency for paying for apps and services. Use this to create app charges in the merchant's local billing currency, helping them budget their app spend without exposure to exchange rate fluctuations.

Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.

Returns Shopify Functions owned by the querying API client installed on the shop. Functions enable you to customize Shopify's backend logic at specific points in the commerce loop, such as discounts, checkout validation, and fulfillment.

You can filter the results by API type to find specific function implementations, or by whether they provide a merchant configuration interface in the Shopify Admin.

The response includes details about each function's configuration, including its title, description, API version, and the input query used to provide data to the function logic.

Learn more about building functions.

Shopify Payments account information, including balances and payouts.

Executes a ShopifyQL query to analyze store data and returns results in a tabular format.

The response includes column metadata with names, data types, and display names, along with the actual data rows. If the query contains syntax errors, then the response provides parse error messages instead of table data.

Returns the locales enabled on a shop. Each locale represents a language for translations and determines how content displays to customers in different markets.

Use the optional published argument to filter for only the locales that are visible to customers. The response includes the ISO locale code, whether it's the shop's primary locale, and which MarketWebPresence objects use each locale.

Returns a Shop Pay payment request receipt.

Returns a list of Shop Pay payment request receipts.

Retrieves a staff member by ID. If no ID is provided, the query returns the staff member that's making the request. A staff member is a user who can access the Shopify admin to manage store operations.

Provides staff member details such as email, name, and shop owner status. When querying the current user (with or without an ID), additional private data becomes available.

Returns a paginated list of StaffMember objects for the shop. Staff members are users who can access the Shopify admin to manage store operations.

Supports filtering by account type, email, and name, with an option to sort results. The query returns a StaffMemberConnection for cursor-based pagination.

Retrieves preset metafield definition templates for common use cases. Each template provides a reserved namespace and key combination for specific purposes like product subtitles, care guides, or ISBN numbers. Use these templates to create standardized metafields across your store. Filter templates by constraint status or exclude those you've already activated.

See the list of standard metafield definitions for available templates.

Retrieves a StoreCreditAccount by ID. Store credit accounts hold monetary balances that account owners can use at checkout. The owner is either a Customer or a CompanyLocation.

Returns a SubscriptionBillingAttempt resource by ID.

Returns subscription billing attempts on a store.

Returns a subscription billing cycle found either by cycle index or date.

Retrieves the results of the asynchronous job for the subscription billing cycle bulk action based on the specified job ID. This query can be used to obtain the billing cycles that match the criteria defined in the subscriptionBillingCycleBulkSearch and subscriptionBillingCycleBulkCharge mutations.

Returns subscription billing cycles for a contract ID.

Returns a Subscription Contract resource by ID.

List Subscription Contracts.

Returns a Subscription Draft resource by ID.

The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.

Transactions representing a movement of money between customers and the shop. Each transaction records the amount, payment method, processing details, and the associated Order.

Positive amounts indicate customer payments to the merchant. Negative amounts represent refunds from the merchant to the customer. Use the query parameter to filter transactions by attributes such as transaction ID, processing date, and point-of-sale device ID.

Returns an OnlineStoreTheme by its ID. Use this query to retrieve theme metadata and access the theme's files, which include templates, assets, translations, and configuration files.

Returns a paginated list of OnlineStoreTheme objects for the online store. Themes control the appearance and layout of the storefront.

You can filter themes by role to find specific theme types, such as MAIN for the published theme and UNPUBLISHED for draft themes.

Retrieves a resource that has translatable fields. Returns the resource's Translation objects for different locales and markets, along with the original TranslatableContent and digest values needed to register new translations. Provides access to existing translations, translatable content with digest hashes for translation registration, and nested translatable resources like ProductVariant objects or Metafield objects.

Learn more about managing translated content.

Returns a paginated list of TranslatableResource objects for a specific resource type. Each resource provides translatable content and digest values needed for the translationsRegister mutation.

Learn more about managing translated content.

Learn more about managing translated content.

Returns a paginated list of TranslatableResource objects for the specified resource IDs. Each resource provides translatable content and digest values needed for the translationsRegister mutation.

Learn more about managing translated content.

Returns a UrlRedirect resource by ID.

Returns a UrlRedirectImport resource by ID.

A list of redirects for a shop.

A list of the shop's URL redirect saved searches.

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

Validation available on the shop.

Validations available on the shop.

Returns a webhook subscription by ID.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Retrieves a paginated list of webhook subscriptions created using the API for the current app and shop.

Subscription details include event topics, endpoint URIs, filtering rules, field inclusion settings, and metafield namespace permissions. Results support cursor-based pagination that you can filter by topic, format, or custom search criteria.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

The count of webhook subscriptions.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions. Limited to a maximum of 10000 by default.

Returns a web pixel by ID.