Query
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
Anchor to Fields and connectionsFields and connections
- Anchor to abandonedCheckoutsabandoned•
Checkouts AbandonedCheckout Connection!non-null List of abandoned checkouts. Includes checkouts that were recovered after being abandoned.
- Anchor to abandonedCheckoutsCountabandoned•
Checkouts Count Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000.
- Anchor to abandonmentabandonment•
Returns an abandonment by ID.
- Anchor to abandonmentByAbandonedCheckoutIdabandonment•
By Abandoned Checkout Id Returns an Abandonment by the Abandoned Checkout ID.
- •
Lookup an App by ID or return the currently authenticated App.
- Anchor to appByHandleapp•
By Handle Fetches app by handle. Returns null if the app doesn't exist.
- Anchor to appByKeyapp•
By Key Fetches an app by its client ID. Returns null if the app doesn't exist.
- Anchor to appCreditsapp•
Credits AppCredit Connection!non-null Credits that can be used towards future app purchases.
- Anchor to appDiscountTypeapp•
Discount Type An app discount type.
- Anchor to appDiscountTypesapp•
Discount Types [AppDiscount Type!]!non-null A list of app discount types installed by apps.
- Anchor to appDiscountTypesNodesapp•
Discount Types Nodes AppDiscount Type Connection!non-null A list of app discount types installed by apps.
- Anchor to appInstallationapp•
Installation Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
- Anchor to appInstallationsapp•
Installations AppInstallation Connection!non-null A list of app installations. To use this query, you need to contact Shopify Support to grant your custom app the
access scope. Public apps can't be granted this access scope.- Anchor to articlearticle•
Returns an Article resource by ID.
- Anchor to articleAuthorsarticle•
Authors ArticleAuthor Connection!non-null List of article authors for the shop.
- Anchor to articlesarticles•Article
Connection!non-null List of the shop's articles.
- Anchor to articleTagsarticle•
Tags [String!]!non-null List of all article tags.
- Anchor to assignedFulfillmentOrdersassigned•
Fulfillment Orders FulfillmentOrder Connection!non-null 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
access scope to be able to retrieve the fulfillment orders assigned to its locations.All assigned fulfillment orders (except those with the
status) will be returned by default. Perform filtering with theargument to receive only fulfillment orders that have been requested to be fulfilled.- Anchor to automaticDiscountNodeautomatic•
Discount Node Returns an automatic discount resource by ID.
- Anchor to automaticDiscountNodesautomatic•
Discount Nodes DiscountAutomatic Node Connection!non-null Returns a list of automatic discounts.
- Anchor to automaticDiscountSavedSearchesautomatic•
Discount Saved Searches SavedSearch Connection!non-null List of the shop's automatic discount saved searches.
- Anchor to availableBackupRegionsavailable•
Backup Regions [MarketRegion!]!non-null The regions that can be used as the backup region of the shop.
- Anchor to availableCarrierServicesavailable•
Carrier Services Returns a list of activated carrier services and associated shop locations that support them.
- Anchor to availableLocalesavailable•
Locales [Locale!]!non-null A list of available locales.
- Anchor to backupRegionbackup•
Region MarketRegion!non-null The backup region of the shop.
- Anchor to balanceAccountbalance•
Account Returns the Balance account information for finance embedded apps.
- Anchor to blogblog•
Returns a Blog resource by ID.
- Anchor to blogsblogs•Blog
Connection!non-null List of the shop's blogs.
- Anchor to blogsCountblogs•
Count Count of blogs.
- Anchor to bundleCountbundle•
Count Int!non-null Returns the number of bundle products that have been created by the current app.
- Anchor to businessEntitiesbusiness•
Entities [BusinessEntity!]!non-null Returns a list of Business Entities associated with the shop.
- Anchor to businessEntitybusiness•
Entity Returns a Business Entity by ID.
- Anchor to carrierServicecarrier•
Service Returns a
object by ID.- Anchor to carrierServicescarrier•
Services Retrieve a list of CarrierServices.
- Anchor to cartTransformscart•
Transforms CartTransform Connection!non-null List of Cart transform objects owned by the current API client.
- Anchor to cashTrackingSessioncash•
Tracking Session Lookup a cash tracking session by ID.
- Anchor to cashTrackingSessionscash•
Tracking Sessions CashTracking Session Connection!non-null 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.
- Anchor to catalogcatalog•
Returns a Catalog resource by ID.
- Anchor to catalogOperationscatalog•
Operations [ResourceOperation!]!non-null Returns the most recent catalog operations for the shop.
- Anchor to catalogscatalogs•Catalog
Connection!non-null The catalogs belonging to the shop.
- Anchor to catalogsCountcatalogs•
Count The count of catalogs belonging to the shop. Limited to a maximum of 10000.
- Anchor to checkoutAndAccountsConfigurationcheckout•
And Accounts Configuration A checkout and accounts configuration for a shop.
- Anchor to checkoutAndAccountsConfigurationscheckout•
And Accounts Configurations List of checkout and accounts configurations on a shop.
- Anchor to checkoutBrandingcheckout•
Branding Returns the visual customizations for checkout for a given checkout profile.
To learn more about updating checkout branding settings, refer to the checkoutBrandingUpsert mutation and the checkout branding tutorial.
- Anchor to checkoutProfilecheckout•
Profile A checkout profile on a shop.
- Anchor to checkoutProfilescheckout•
Profiles CheckoutProfile Connection!non-null List of checkout profiles on a shop.
- Anchor to codeDiscountNodecode•
Discount Node Returns a code discount resource by ID.
- Anchor to codeDiscountNodeByCodecode•
Discount Node By Code Returns a code discount identified by its discount code.
- Anchor to codeDiscountNodescode•
Discount Nodes DiscountCode Node Connection!non-null Returns a list of code-based discounts.
- Anchor to codeDiscountSavedSearchescode•
Discount Saved Searches SavedSearch Connection!non-null List of the shop's code discount saved searches.
- Anchor to collectioncollection•
Returns a Collection resource by ID.
- Anchor to collectionByIdentifiercollection•
By Identifier Return a collection by an identifier.
- Anchor to collectionRulesConditionscollection•
Rules Conditions [CollectionRule Conditions!]!non-null Lists all rules that can be used to create smart collections.
- Anchor to collectionscollections•Collection
Connection!non-null Returns a list of collections.
- Anchor to collectionSavedSearchescollection•
Saved Searches SavedSearch Connection!non-null Returns a list of the shop's collection saved searches.
- Anchor to collectionsCountcollections•
Count Count of collections. Limited to a maximum of 10000.
- Anchor to commentcomment•
Returns a Comment resource by ID.
- Anchor to commentscomments•Comment
Connection!non-null List of the shop's comments.
- Anchor to companiescompanies•Company
Connection!non-null Returns the list of companies in the shop.
- Anchor to companiesCountcompanies•
Count The number of companies for a shop.
- Anchor to companycompany•
Returns a
Companyobject by ID.- Anchor to companyContactcompany•
Contact Returns a
object by ID.- Anchor to companyContactRolecompany•
Contact Role Returns a
object by ID.- Anchor to companyLocationcompany•
Location Returns a
object by ID.- Anchor to companyLocationscompany•
Locations CompanyLocation Connection!non-null Returns the list of company locations in the shop.
- Anchor to consentPolicyconsent•
Policy [ConsentPolicy!]!non-null Returns the customer privacy consent policies of a shop.
- Anchor to consentPolicyRegionsconsent•
Policy Regions [ConsentPolicy Region!]!non-null List of countries and regions for which consent policies can be created or updated.
- Anchor to currentAppInstallationcurrent•
App Installation AppInstallation!non-null Return the AppInstallation for the currently authenticated App.
- Anchor to currentBulkOperationcurrent•
Bulk Operation Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.
- Anchor to currentStaffMembercurrent•
Staff Member The staff member making the API request.
- Anchor to customercustomer•
Returns a Customer resource by ID.
- Anchor to customerAccountPagecustomer•
Account Page Returns a customer account page.
- Anchor to customerAccountPagescustomer•
Account Pages List of the shop's customer account pages.
- Anchor to customerByIdentifiercustomer•
By Identifier Return a customer by an identifier.
- Anchor to customerMergeJobStatuscustomer•
Merge Job Status Returns the status of a customer merge request job.
- Anchor to customerMergePreviewcustomer•
Merge Preview CustomerMerge Preview!non-null Returns a preview of a customer merge request.
- Anchor to customerPaymentMethodcustomer•
Payment Method Returns a CustomerPaymentMethod resource by its ID.
- Anchor to customerscustomers•Customer
Connection!non-null 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
customersquery supports pagination and sorting.- Anchor to customerSavedSearchescustomer•
Saved Searches SavedSearch Connection!non-null List of the shop's customer saved searches.
- Anchor to customersCountcustomers•
Count The number of customers.
- Anchor to customerSegmentMemberscustomer•
Segment Members CustomerSegment Member Connection!non-null The list of members, such as customers, that's associated with an individual segment. The maximum page size is 1000.
- Anchor to customerSegmentMembersCountcustomer•
Segment Members Count The count of customers in a segment.
- Anchor to customerSegmentMembershipcustomer•
Segment Membership SegmentMembership Response!non-null Whether a member, which is a customer, belongs to a segment.
- Anchor to customerSegmentMembersQuerycustomer•
Segment Members Query Returns a segment members query resource by ID.
- Anchor to deliveryCustomizationdelivery•
Customization The delivery customization.
- Anchor to deliveryCustomizationsdelivery•
Customizations DeliveryCustomization Connection!non-null The delivery customizations.
- Anchor to deliveryProfiledelivery•
Profile Returns a Delivery Profile resource by ID.
- Anchor to deliveryProfilesdelivery•
Profiles DeliveryProfile Connection!non-null Returns a list of saved delivery profiles.
- Anchor to deliveryPromiseParticipantsdelivery•
Promise Participants Returns delivery promise participants.
- Anchor to deliveryPromiseProviderdelivery•
Promise Provider Lookup a delivery promise provider.
- Anchor to deliveryPromiseSettingsdelivery•
Promise Settings DeliveryPromise Setting!non-null Represents the delivery promise settings for a shop.
- Anchor to deliveryPromiseSkuSettingdelivery•
Promise Sku Setting A SKU setting for a delivery promise.
- Anchor to deliverySettingsdelivery•
Settings Returns the shop-wide shipping settings.
- Anchor to discountCodesCountdiscount•
Codes Count The total number of discount codes for the shop.
- Anchor to discountNodediscount•
Node Returns a discount resource by ID.
- Anchor to discountNodesdiscount•
Nodes DiscountNode Connection!non-null Returns a list of discounts.
- Anchor to discountNodesCountdiscount•
Nodes Count The total number of discounts for the shop. Limited to a maximum of 10000.
- Anchor to discountRedeemCodeBulkCreationdiscount•
Redeem Code Bulk Creation Returns a bulk code creation resource by ID.
- Anchor to discountRedeemCodeSavedSearchesdiscount•
Redeem Code Saved Searches SavedSearch Connection!non-null List of the shop's redeemed discount code saved searches.
- Anchor to discountResourceFeedbackdiscount•
Resource Feedback Returns the discount resource feedback for the currently authenticated app.
- Anchor to disputedispute•
Returns dispute details based on ID.
- Anchor to disputeEvidencedispute•
Evidence Returns dispute evidence details based on ID.
- Anchor to disputesdisputes•
All disputes related to the Shop.
- Anchor to domaindomain•
Lookup a Domain by ID.
- Anchor to draftOrderdraft•
Order Returns a DraftOrder resource by ID.
- Anchor to draftOrderAvailableDeliveryOptionsdraft•
Order Available Delivery Options Returns a list of available delivery options for a draft order.
- Anchor to draftOrdersdraft•
Orders DraftOrder Connection!non-null List of saved draft orders.
- Anchor to draftOrderSavedSearchesdraft•
Order Saved Searches SavedSearch Connection!non-null List of the shop's draft order saved searches.
- Anchor to draftOrdersCountdraft•
Orders Count Returns the number of draft orders that match the query. Limited to a maximum of 10000.
- Anchor to draftOrderTagdraft•
Order Tag Returns a DraftOrderTag resource by ID.
- Anchor to eventevent•
Get a single event by its id.
- Anchor to eventsevents•
The paginated list of events associated with the store.
- Anchor to eventsCountevents•
Count Count of events. Limited to a maximum of 10000.
- Anchor to filesfiles•File
Connection!non-null Returns a paginated list of files that have been uploaded to Shopify.
- Anchor to fileSavedSearchesfile•
Saved Searches SavedSearch Connection!non-null A list of the shop's file saved searches.
- Anchor to financeAppAccessPolicyfinance•
App Access Policy FinanceApp Access Policy!non-null Returns the access policy for a finance app .
- Anchor to financeKycInformationfinance•
Kyc Information Returns the KYC information for the shop's Shopify Payments account, used in embedded finance apps.
- Anchor to fulfillmentfulfillment•
Returns a Fulfillment resource by ID.
- Anchor to fulfillmentConstraintRulesfulfillment•
Constraint Rules [FulfillmentConstraint Rule!]!non-null The fulfillment constraint rules that belong to a shop.
- Anchor to fulfillmentOrderfulfillment•
Order Returns a Fulfillment order resource by ID.
- Anchor to fulfillmentOrdersfulfillment•
Orders FulfillmentOrder Connection!non-null 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.
- Anchor to fulfillmentServicefulfillment•
Service Returns a FulfillmentService resource by ID.
- Anchor to giftCardgift•
Card Returns a gift card resource by ID.
- Anchor to giftCardConfigurationgift•
Card Configuration GiftCard Configuration!non-null The configuration for the shop's gift cards.
- Anchor to giftCardsgift•
Cards GiftCard Connection!non-null Returns a list of gift cards.
- Anchor to giftCardsCountgift•
Cards Count The total number of gift cards issued for the shop. Limited to a maximum of 10000.
- Anchor to inventoryIteminventory•
Item Returns an InventoryItem object by ID.
- Anchor to inventoryItemsinventory•
Items InventoryItem Connection!non-null Returns a list of inventory items.
- Anchor to inventoryLevelinventory•
Level Returns an InventoryLevel object by ID.
- Anchor to inventoryPropertiesinventory•
Properties InventoryProperties!non-null General inventory properties for the shop.
- Anchor to inventoryShipmentinventory•
Shipment Returns an inventory shipment by ID.
- Anchor to inventoryTransferinventory•
Transfer Returns an inventory transfer by ID.
- Anchor to inventoryTransfersinventory•
Transfers InventoryTransfer Connection!non-null Returns a paginated list of transfers.
- •
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
- Anchor to locationlocation•
Returns an inventory Location resource by ID.
- Anchor to locationByIdentifierlocation•
By Identifier Return a location by an identifier.
- Anchor to locationslocations•Location
Connection!non-null Returns a list of active inventory locations.
- Anchor to locationsAvailableForDeliveryProfilesConnectionlocations•
Available For Delivery Profiles Connection LocationConnection!non-null Returns a list of all origin locations available for a delivery profile.
- Anchor to locationsCountlocations•
Count Returns the count of locations for the given shop. Limited to a maximum of 10000.
- Anchor to manualHoldsFulfillmentOrdersmanual•
Holds Fulfillment Orders FulfillmentOrder Connection!non-null Returns a list of fulfillment orders that are on hold.
- Anchor to marketmarket•
Returns a market resource by ID.
- Anchor to marketingActivitiesmarketing•
Activities MarketingActivity Connection!non-null A list of marketing activities associated with the marketing app.
- Anchor to marketingActivitymarketing•
Activity Returns a MarketingActivity resource by ID.
- Anchor to marketingEventmarketing•
Event Returns a MarketingEvent resource by ID.
- Anchor to marketingEventsmarketing•
Events MarketingEvent Connection!non-null A list of marketing events associated with the marketing app.
- Anchor to marketLocalizableResourcemarket•
Localizable Resource A resource that can have localized values for different markets.
- Anchor to marketLocalizableResourcesmarket•
Localizable Resources Resources that can have localized values for different markets.
- Anchor to marketLocalizableResourcesByIdsmarket•
Localizable Resources By Ids Resources that can have localized values for different markets.
- Anchor to marketsmarkets•Market
Connection!non-null The markets configured for the shop.
- Anchor to marketsResolvedValuesmarkets•
Resolved Values MarketsResolved Values!non-null The resolved values for a buyer signal.
- Anchor to menumenu•
Returns a Menu resource by ID.
- Anchor to menusmenus•Menu
Connection!non-null The shop's menus.
- Anchor to metafieldDefinitionmetafield•
Definition Returns a metafield definition by identifier.
- Anchor to metafieldDefinitionsmetafield•
Definitions MetafieldDefinition Connection!non-null Returns a list of metafield definitions.
- Anchor to metafieldDefinitionTypesmetafield•
Definition Types [MetafieldDefinition Type!]!non-null Each metafield definition has a type, which defines the type of information that it can store. This type is enforced across every instance of the resource that owns the metafield definition.
Refer to the list of supported metafield types.
- Anchor to metafieldsmetafields•Metafield
Connection!non-null A paginated list of metafields.
- Anchor to metaobjectmetaobject•
Retrieves a metaobject by ID.
- Anchor to metaobjectByHandlemetaobject•
By Handle Retrieves a metaobject by handle.
- Anchor to metaobjectDefinitionmetaobject•
Definition Retrieves a metaobject definition by ID.
- Anchor to metaobjectDefinitionByTypemetaobject•
Definition By Type Finds a metaobject definition by type.
- Anchor to metaobjectDefinitionsmetaobject•
Definitions MetaobjectDefinition Connection!non-null All metaobject definitions.
- Anchor to metaobjectsmetaobjects•Metaobject
Connection!non-null All metaobjects for the shop.
- Anchor to mobilePlatformApplicationmobile•
Platform Application Return a mobile platform application by its ID.
- Anchor to mobilePlatformApplicationsmobile•
Platform Applications List the mobile platform applications.
- Anchor to nftSalesEligibilitynft•
Sales Eligibility NftSales Eligibility Result!non-null Determine if a shop is eligibile to sell NFTs.
- Anchor to nodenode•
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.
- Anchor to nodesnodes•[Node]!non-null
Returns the list of nodes (any objects that implement the Node interface) with the given IDs, in accordance with the Relay specification.
- Anchor to onlineStoreonline•
Store OnlineStore!non-null The shop's online store channel.
- Anchor to orderorder•
Returns an Order resource by ID.
- Anchor to orderByIdentifierorder•
By Identifier Return an order by an identifier.
- Anchor to orderEditSessionorder•
Edit Session Returns an Order editing session by order ID.
- Anchor to orderPaymentStatusorder•
Payment Status Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
- Anchor to ordersorders•Order
Connection!non-null Returns a list of orders placed in the store, including data such as order status, customer, and line item details. Use the
ordersquery to build reports, analyze sales performance, or automate fulfillment workflows. Theordersquery supports pagination, sorting, and filtering.- Anchor to orderSavedSearchesorder•
Saved Searches SavedSearch Connection!non-null List of the shop's order saved searches.
- Anchor to ordersCountorders•
Count Returns the count of orders for the given shop. Limited to a maximum of 10000.
- Anchor to pagepage•
Returns a Page resource by ID.
- Anchor to pagespages•Page
Connection!non-null List of the shop's pages.
- Anchor to pagesCountpages•
Count Count of pages.
- Anchor to paymentCustomizationpayment•
Customization The payment customization.
- Anchor to paymentCustomizationspayment•
Customizations PaymentCustomization Connection!non-null The payment customizations.
- Anchor to paymentTermsTemplatespayment•
Terms Templates [PaymentTerms Template!]!non-null The list of payment terms templates eligible for all shops and users.
- Anchor to pendingOrdersCountpending•
Orders Count The number of pendings orders. Limited to a maximum of 10000.
- Anchor to performanceEventsperformance•
Events Events that impact storefront performance, measured via RUM (Real User Monitoring).
- Anchor to performanceMetricsperformance•
Metrics RUM (Real User Monitoring) performance metrics for a shop.
- Anchor to pointOfSaleDevicepoint•
Of Sale Device Lookup a point of sale device by ID.
- Anchor to priceListprice•
List Returns a price list resource by ID.
- Anchor to priceListsprice•
Lists PriceList Connection!non-null All price lists for a shop.
- Anchor to privacySettingsprivacy•
Settings PrivacySettings!non-null Privacy related settings for a shop.
- Anchor to productproduct•
Returns a Product resource by ID.
- Anchor to productByIdentifierproduct•
By Identifier Return a product by an identifier.
- Anchor to productDuplicateJobproduct•
Duplicate Job ProductDuplicate Job!non-null Returns the product duplicate job.
- Anchor to productFeedproduct•
Feed Returns a ProductFeed resource by ID.
- Anchor to productFeedsproduct•
Feeds ProductFeed Connection!non-null The product feeds for the shop.
- Anchor to productOperationproduct•
Operation 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
statusfield indicates whether the operation is,, or.The
productfield provides the details of the created or updated product.For the ProductSetOperation, the
field provides mutation errors that occurred during the operation.- Anchor to productResourceFeedbackproduct•
Resource Feedback Returns the product resource feedback for the currently authenticated app.
- Anchor to productsproducts•Product
Connection!non-null Returns a list of products.
- Anchor to productSavedSearchesproduct•
Saved Searches SavedSearch Connection!non-null Returns a list of the shop's product saved searches.
- Anchor to productsCountproducts•
Count Count of products.
- Anchor to productTagsproduct•
Tags A list of tags that have been added to products. The maximum page size is 5000.
- Anchor to productTypesproduct•
Types The list of types added to products. The maximum page size is 1000.
- Anchor to productVariantproduct•
Variant Returns a ProductVariant resource by ID.
- Anchor to productVariantByIdentifierproduct•
Variant By Identifier Return a product variant by an identifier.
- Anchor to productVariantsproduct•
Variants ProductVariant Connection!non-null Returns a list of product variants.
- Anchor to productVariantsCountproduct•
Variants Count Count of product variants.
- Anchor to productVendorsproduct•
Vendors The list of vendors added to products. The maximum page size is 1000.
- Anchor to publicApiVersionspublic•
Api Versions [ApiVersion!]!non-null The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.
- Anchor to publicationpublication•
Lookup a publication by ID.
- Anchor to publicationspublications•Publication
Connection!non-null List of publications.
- Anchor to publicationsCountpublications•
Count Count of publications.
- Anchor to publishedProductsCountpublished•
Products Count Returns a count of published products by publication ID.
- Anchor to refundrefund•
Returns a Refund resource by ID.
- Anchor to returnreturn•
Returns a Return resource by ID.
- Anchor to returnableFulfillmentreturnable•
Fulfillment Lookup a returnable fulfillment by ID.
- Anchor to returnableFulfillmentsreturnable•
Fulfillments ReturnableFulfillment Connection!non-null List of returnable fulfillments.
- Anchor to returnCalculatereturn•
Calculate The calculated monetary value to be exchanged due to the return.
- Anchor to reverseDeliveryreverse•
Delivery Lookup a reverse delivery by ID.
- Anchor to reverseFulfillmentOrderreverse•
Fulfillment Order Lookup a reverse fulfillment order by ID.
- Anchor to scriptTagscript•
Tag Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
Lookup a script tag resource by ID.
- Anchor to scriptTagsscript•
Tags ScriptTag Connection!non-null Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
A list of script tags.
- Anchor to segmentsegment•
The Customer Segment.
- Anchor to segmentFilterssegment•
Filters SegmentFilter Connection!non-null A list of filters.
- Anchor to segmentFilterSuggestionssegment•
Filter Suggestions SegmentFilter Connection!non-null A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.
- Anchor to segmentMigrationssegment•
Migrations SegmentMigration Connection!non-null A list of a shop's segment migrations.
- Anchor to segmentssegments•Segment
Connection!non-null A list of a shop's segments.
- Anchor to segmentsCountsegments•
Count The number of segments for a shop.
- Anchor to segmentValueSuggestionssegment•
Value Suggestions SegmentValue Connection!non-null 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.
- Anchor to sellingPlanGroupselling•
Plan Group Returns a Selling Plan Group resource by ID.
- Anchor to sellingPlanGroupsselling•
Plan Groups SellingPlan Group Connection!non-null List Selling Plan Groups.
- Anchor to serverPixelserver•
Pixel The server pixel configured by the app.
- Anchor to shopshop•Shop!non-null
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.
- Anchor to shopBillingPreferencesshop•
Billing Preferences ShopBilling Preferences!non-null The shop's billing preferences.
- Anchor to shopifyFunctionshopify•
Function Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.
- Anchor to shopifyFunctionsshopify•
Functions ShopifyFunction Connection!non-null Returns the Shopify Functions owned by the querying API client installed on the shop.
- Anchor to shopifyPaymentsAccountshopify•
Payments Account Shopify Payments account information, including balances and payouts.
- Anchor to shopLocalesshop•
Locales [ShopLocale!]!non-null A list of locales available on a shop.
- Anchor to shopPayPaymentRequestReceiptshop•
Pay Payment Request Receipt Returns a Shop Pay payment request receipt.
- Anchor to shopPayPaymentRequestReceiptsshop•
Pay Payment Request Receipts Returns a list of Shop Pay payment request receipts.
- Anchor to staffMemberstaff•
Member The StaffMember resource, by ID.
- Anchor to staffMembersstaff•
Members The shop staff members.
- Anchor to standardMetafieldDefinitionTemplatesstandard•
Metafield Definition Templates Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved.
Refer to all available
Standard Metafield Definition Templates.- Anchor to storeCreditAccountstore•
Credit Account Returns a store credit account resource by ID.
- Anchor to subscriptionBillingAttemptsubscription•
Billing Attempt Returns a SubscriptionBillingAttempt by ID.
- Anchor to subscriptionBillingAttemptssubscription•
Billing Attempts Returns subscription billing attempts on a store.
- Anchor to subscriptionBillingCyclesubscription•
Billing Cycle Returns a subscription billing cycle found either by cycle index or date.
- Anchor to subscriptionBillingCycleBulkResultssubscription•
Billing Cycle Bulk Results 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.
- Anchor to subscriptionBillingCyclessubscription•
Billing Cycles Returns subscription billing cycles for a contract ID.
- Anchor to subscriptionContractsubscription•
Contract Returns a Subscription Contract resource by ID.
- Anchor to subscriptionContractssubscription•
Contracts SubscriptionContract Connection!non-null List Subscription Contracts.
- Anchor to subscriptionDraftsubscription•
Draft Returns a Subscription Draft resource by ID.
- Anchor to subscriptionGatewaysubscription•
Gateway Gateway used for subscription charges.
- Anchor to subscriptionMigrationGatewayssubscription•
Migration Gateways [SubscriptionMigration Gateway!]!non-null The list of payment gateways that can be used for subscription contract migrations.
- Anchor to taxonomytaxonomy•
The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.
- Anchor to tenderTransactionstender•
Transactions TenderTransaction Connection!non-null Returns a list of TenderTransactions associated with the shop.
- Anchor to themetheme•
Returns a particular theme for the shop.
- Anchor to themesthemes•
Returns a paginated list of themes for the shop.
- Anchor to translatableResourcetranslatable•
Resource A resource that can have localized values for different languages.
- Anchor to translatableResourcestranslatable•
Resources TranslatableResource Connection!non-null Resources that can have localized values for different languages.
- Anchor to translatableResourcesByIdstranslatable•
Resources By Ids TranslatableResource Connection!non-null Resources that can have localized values for different languages.
- Anchor to urlRedirecturl•
Redirect Returns a redirect resource by ID.
- Anchor to urlRedirectImporturl•
Redirect Import Returns a redirect import resource by ID.
- Anchor to urlRedirectsurl•
Redirects UrlRedirect Connection!non-null A list of redirects for a shop.
- Anchor to urlRedirectSavedSearchesurl•
Redirect Saved Searches SavedSearch Connection!non-null A list of the shop's URL redirect saved searches.
- Anchor to urlRedirectsCounturl•
Redirects Count Count of redirects. Limited to a maximum of 10000.
- Anchor to validationvalidation•
Validation available on the shop.
- Anchor to validationsvalidations•Validation
Connection!non-null Validations available on the shop.
- Anchor to webhookSubscriptionwebhook•
Subscription 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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to webhookSubscriptionswebhook•
Subscriptions WebhookSubscription Connection!non-null Returns a list 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.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to webhookSubscriptionsCountwebhook•
Subscriptions Count 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.tomlmay 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.- Anchor to webPixelweb•
Pixel Returns a web pixel by ID.
- Anchor to webPresencesweb•
Presences The web presences for the shop.
Deprecated fields and connections
- Anchor to automaticDiscountautomatic•
Discount Returns an automatic discount resource by ID.
- Anchor to automaticDiscountsautomatic•
Discounts DiscountAutomatic Connection!non-null List of automatic discounts.
- Anchor to channelchannel•
Lookup a channel by ID.
- Anchor to channelschannels•Channel
Connection!non-null List of the active sales channels.
- Anchor to collectionByHandlecollection•
By Handle Return a collection by its handle.
- Anchor to deletionEventsdeletion•
Events DeletionEvent Connection!non-null The paginated list of deletion events.
- Anchor to gateConfigurationgate•
Configuration Fetch a gate configuration resource by ID.
- Anchor to gateConfigurationsgate•
Configurations List of the shop's gate configurations.
- Anchor to locationsAvailableForDeliveryProfileslocations•
Available For Delivery Profiles Returns a list of all origin locations available for a delivery profile.
- Anchor to marketByGeographymarket•
By Geography Returns the applicable market for a customer based on where they are in the world.
- Anchor to primaryMarketprimary•
Market Market!non-null The primary market of the shop.
- Anchor to productByHandleproduct•
By Handle Return a product by its handle.
- Anchor to productTaxonomyNodesproduct•
Taxonomy Nodes ProductTaxonomy Node Connection!non-null Returns the nodes of the product taxonomy based on the arguments provided. If a
searchargument is provided, then all nodes that match the search query globally are returned. If aargument is provided, then all children of the specified node are returned. If aargument is provided, then all siblings of the specified node are returned. If no arguments are provided, then all the top-level nodes of the taxonomy are returned.