Home > @infiniteobjects/shopify-data-manager > AdminTypes > QueryRoot
The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.
Signature:
export interface QueryRoot
| Property | Modifiers | Type | Description |
|---|---|---|---|
| abandonment? | Maybe<Abandonment> | (Optional) Returns an abandonment by ID. | |
| abandonmentByAbandonedCheckoutId? | Maybe<Abandonment> | (Optional) Returns an Abandonment by the Abandoned Checkout ID. | |
| app? | Maybe<App> | (Optional) Lookup an App by ID or return the currently authenticated App. | |
| appByHandle? | Maybe<App> | (Optional) Fetches app by handle. Returns null if the app doesn’t exist. | |
| appByKey? | Maybe<App> | (Optional) Fetches an app by its client ID. Returns null if the app doesn’t exist. | |
| appDiscountType? | Maybe<AppDiscountType> | (Optional) An app discount type. | |
| appDiscountTypes | Array<AppDiscountType> | A list of app discount types installed by apps. | |
| appInstallation? | Maybe<AppInstallation> | (Optional) Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App. | |
| appInstallations | AppInstallationConnection | List of app installations. Requires contacting Shopify for access to the read_apps access scope. |
|
| automaticDiscount? | Maybe<DiscountAutomatic> | (Optional) Returns an automatic discount resource by ID. | |
| automaticDiscountNode? | Maybe<DiscountAutomaticNode> | (Optional) Returns an automatic discount resource by ID. | |
| automaticDiscountNodes | DiscountAutomaticNodeConnection | List of automatic discounts. | |
| automaticDiscounts | DiscountAutomaticConnection | List of automatic discounts. | |
| automaticDiscountSavedSearches | SavedSearchConnection | List of the shop’s automatic discount saved searches. | |
| availableCarrierServices | Array<DeliveryCarrierServiceAndLocations> | Returns a list of activated carrier services and associated shop locations that support them. | |
| availableLocales | Array<Locale> | A list of available locales. | |
| carrierService? | Maybe<DeliveryCarrierService> | (Optional) Returns a DeliveryCarrierService object by ID. |
|
| cartTransforms | CartTransformConnection | List of Cart transform objects owned by the current API client. | |
| catalog? | Maybe<Catalog> | (Optional) Returns a Catalog resource by ID. | |
| catalogOperations | Array<ResourceOperation> | Returns the most recent catalog operations for the shop. | |
| catalogs | CatalogConnection | The catalogs belonging to the shop. | |
| channel? | Maybe<Channel> | (Optional) Lookup a channel by ID. | |
| channels | ChannelConnection | List of the active sales channels. | |
| checkoutBranding? | Maybe<CheckoutBranding> | (Optional) Returns the checkout branding settings for a checkout profile. | |
| checkoutProfile? | Maybe<CheckoutProfile> | (Optional) A checkout profile on a shop. | |
| checkoutProfiles | CheckoutProfileConnection | List of checkout profiles on a shop. | |
| codeDiscountNode? | Maybe<DiscountCodeNode> | (Optional) Returns a code discount resource by ID. | |
| codeDiscountNodeByCode? | Maybe<DiscountCodeNode> | (Optional) Returns a code discount identified by its discount code. | |
| codeDiscountNodes | DiscountCodeNodeConnection | List of code discounts. Special fields for query params: * status: active, expired, scheduled * discount_type: bogo, fixed_amount, free_shipping, percentage. | |
| codeDiscountSavedSearches | SavedSearchConnection | List of the shop’s code discount saved searches. | |
| collection? | Maybe<Collection> | (Optional) Returns a Collection resource by ID. | |
| collectionByHandle? | Maybe<Collection> | (Optional) Return a collection by its handle. | |
| collectionRulesConditions | Array<CollectionRuleConditions> | Lists all rules that can be used to create smart collections. | |
| collections | CollectionConnection | Returns a list of collections. | |
| collectionSavedSearches | SavedSearchConnection | Returns a list of the shop’s collection saved searches. | |
| companies | CompanyConnection | Returns the list of companies in the shop. | |
| company? | Maybe<Company> | (Optional) Returns a Company object by ID. |
|
| companyContact? | Maybe<CompanyContact> | (Optional) Returns a CompanyContact object by ID. |
|
| companyContactRole? | Maybe<CompanyContactRole> | (Optional) Returns a CompanyContactRole object by ID. |
|
| companyCount | Scalars[‘Int’][‘output’] | The number of companies for a shop. | |
| companyLocation? | Maybe<CompanyLocation> | (Optional) Returns a CompanyLocation object by ID. |
|
| companyLocations | CompanyLocationConnection | Returns the list of company locations in the shop. | |
| currentAppInstallation | AppInstallation | Return the AppInstallation for the currently authenticated App. | |
| currentBulkOperation? | Maybe<BulkOperation> | (Optional) Returns the current app’s most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop. | |
| customer? | Maybe<Customer> | (Optional) Returns a Customer resource by ID. | |
| customerMergeJobStatus? | Maybe<CustomerMergeRequest> | (Optional) Returns the status of a customer merge request job. | |
| customerMergePreview | CustomerMergePreview | Returns a preview of a customer merge request. | |
| customerPaymentMethod? | Maybe<CustomerPaymentMethod> | (Optional) Returns a CustomerPaymentMethod resource by its ID. | |
| customers | CustomerConnection | List of customers. | |
| customerSegmentMembers | CustomerSegmentMemberConnection | The list of members, such as customers, that’s associated with an individual segment. | |
| customerSegmentMembership | SegmentMembershipResponse | Whether a member, which is a customer, belongs to a segment. | |
| customerSegmentMembersQuery? | Maybe<CustomerSegmentMembersQuery> | (Optional) Returns a segment members query resource by ID. | |
| deletionEvents | DeletionEventConnection | The paginated list of deletion events. | |
| deliveryCustomization? | Maybe<DeliveryCustomization> | (Optional) The delivery customization. | |
| deliveryCustomizations | DeliveryCustomizationConnection | The delivery customizations. | |
| deliveryProfile? | Maybe<DeliveryProfile> | (Optional) Returns a Delivery Profile resource by ID. | |
| deliveryProfiles | DeliveryProfileConnection | Returns a list of saved delivery profiles. | |
| deliverySettings? | Maybe<DeliverySetting> | (Optional) Returns the shop-wide shipping settings. | |
| discountCodeCount | Scalars[‘Int’][‘output’] | The total number of discount codes for the shop. | |
| discountNode? | Maybe<DiscountNode> | (Optional) Returns a discount resource by ID. | |
| discountNodes | DiscountNodeConnection | List of discounts. | |
| discountRedeemCodeBulkCreation? | Maybe<DiscountRedeemCodeBulkCreation> | (Optional) Returns a bulk code creation resource by ID. | |
| discountRedeemCodeSavedSearches | SavedSearchConnection | List of the shop’s redeemed discount code saved searches. | |
| dispute? | Maybe<ShopifyPaymentsDispute> | (Optional) Returns dispute details based on ID. | |
| disputeEvidence? | Maybe<ShopifyPaymentsDisputeEvidence> | (Optional) Returns dispute evidence details based on ID. | |
| domain? | Maybe<Domain> | (Optional) Lookup a Domain by ID. | |
| draftOrder? | Maybe<DraftOrder> | (Optional) Returns a DraftOrder resource by ID. | |
| draftOrders | DraftOrderConnection | List of saved draft orders. | |
| draftOrderSavedSearches | SavedSearchConnection | List of the shop’s draft order saved searches. | |
| draftOrderTag? | Maybe<DraftOrderTag> | (Optional) Returns a DraftOrderTag resource by ID. | |
| files | FileConnection | Returns a paginated list of files that have been uploaded to Shopify. | |
| fileSavedSearches | SavedSearchConnection | A list of the shop’s file saved searches. | |
| fulfillment? | Maybe<Fulfillment> | (Optional) Returns a Fulfillment resource by ID. | |
| fulfillmentConstraintRules | Array<FulfillmentConstraintRule> | The fulfillment constraint rules that belong to a shop. | |
| fulfillmentOrder? | Maybe<FulfillmentOrder> | (Optional) Returns a Fulfillment order resource by ID. | |
| fulfillmentOrders | FulfillmentOrderConnection | <p>The paginated list of all fulfillment orders. The returned fulfillment orders are filtered according to the [fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes) granted to the app.</p><p>Use this query to retrieve fulfillment orders assigned to merchant-managed locations, third-party fulfillment service locations, or all kinds of locations together.</p><p>For fetching only the fulfillment orders assigned to the app’s locations, use the [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) connection.</p> | |
| fulfillmentService? | Maybe<FulfillmentService> | (Optional) Returns a FulfillmentService resource by ID. | |
| giftCard? | Maybe<GiftCard> | (Optional) Returns a gift card resource by ID. | |
| giftCards | GiftCardConnection | Returns a list of gift cards. | |
| giftCardsCount | Scalars[‘UnsignedInt64’][‘output’] | The total number of gift cards issued for the shop. | |
| inventoryItem? | Maybe<InventoryItem> | (Optional) Returns an [InventoryItem](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) object by ID. | |
| inventoryItems | InventoryItemConnection | Returns a list of inventory items. | |
| inventoryLevel? | Maybe<InventoryLevel> | (Optional) Returns an [InventoryLevel](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) object by ID. | |
| inventoryProperties | InventoryProperties | General inventory properties for the shop. | |
| job? | Maybe<Job> | (Optional) Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. | |
| location? | Maybe<Location> | (Optional) Returns an inventory Location resource by ID. | |
| locations | LocationConnection | Returns a list of active inventory locations. | |
| locationsAvailableForDeliveryProfiles? | Maybe<Array<Location>> | (Optional) Returns a list of all origin locations available for a delivery profile. | |
| locationsAvailableForDeliveryProfilesConnection | LocationConnection | Returns a list of all origin locations available for a delivery profile. | |
| manualHoldsFulfillmentOrders | FulfillmentOrderConnection | Returns a list of fulfillment orders that are on hold. | |
| market? | Maybe<Market> | (Optional) Returns a market resource by ID. | |
| marketByGeography? | Maybe<Market> | (Optional) Returns the applicable market for a customer based on where they are in the world. | |
| marketingActivities | MarketingActivityConnection | A list of marketing activities associated with the marketing app. | |
| marketingActivity? | Maybe<MarketingActivity> | (Optional) Returns a MarketingActivity resource by ID. | |
| marketingEvent? | Maybe<MarketingEvent> | (Optional) Returns a MarketingEvent resource by ID. | |
| marketingEvents | MarketingEventConnection | A list of marketing events associated with the marketing app. | |
| marketLocalizableResource? | Maybe<MarketLocalizableResource> | (Optional) A resource that can have localized values for different markets. | |
| marketLocalizableResources | MarketLocalizableResourceConnection | Resources that can have localized values for different markets. | |
| marketLocalizableResourcesByIds | MarketLocalizableResourceConnection | Resources that can have localized values for different markets. | |
| markets | MarketConnection | The markets configured for the shop. | |
| metafieldDefinition? | Maybe<MetafieldDefinition> | (Optional) Returns a metafield definition by ID. | |
| metafieldDefinitions | MetafieldDefinitionConnection | List of metafield definitions. | |
| metafieldDefinitionTypes | Array<MetafieldDefinitionType> | <p>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.</p><p>Refer to the [list of supported metafield types](https://shopify.dev/apps/metafields/types).</p> | |
| metafieldStorefrontVisibilities | MetafieldStorefrontVisibilityConnection | List of the MetafieldStorefrontVisibility records. |
|
| metafieldStorefrontVisibility? | Maybe<MetafieldStorefrontVisibility> | (Optional) Returns a MetafieldStorefrontVisibility record by ID. A MetafieldStorefrontVisibility record lists the metafields to make visible in the Storefront API. |
|
| metaobject? | Maybe<Metaobject> | (Optional) Retrieves a metaobject by ID. | |
| metaobjectByHandle? | Maybe<Metaobject> | (Optional) Retrieves a metaobject by handle. | |
| metaobjectDefinition? | Maybe<MetaobjectDefinition> | (Optional) Retrieves a metaobject definition by ID. | |
| metaobjectDefinitionByType? | Maybe<MetaobjectDefinition> | (Optional) Finds a metaobject definition by type. | |
| metaobjectDefinitions | MetaobjectDefinitionConnection | All metaobject definitions. | |
| metaobjects | MetaobjectConnection | All metaobjects for the shop. | |
| node? | Maybe<Node> | (Optional) Returns a specific node (any object that implements the [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) interface) by ID, in accordance with the [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification). This field is commonly used for refetching an object. | |
| nodes | Array<Maybe<Node>> | Returns the list of nodes (any objects that implement the [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) interface) with the given IDs, in accordance with the [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification). | |
| order? | Maybe<Order> | (Optional) Returns an Order resource by ID. | |
| orderPaymentStatus? | Maybe<OrderPaymentStatus> | (Optional) Returns a payment status by payment reference ID. Used to check the status of a deferred payment. | |
| orders | OrderConnection | Returns a list of orders placed. | |
| orderSavedSearches | SavedSearchConnection | List of the shop’s order saved searches. | |
| paymentCustomization? | Maybe<PaymentCustomization> | (Optional) The payment customization. | |
| paymentCustomizations | PaymentCustomizationConnection | The payment customizations. | |
| paymentTermsTemplates | Array<PaymentTermsTemplate> | The list of payment terms templates eligible for all shops and users. | |
| priceList? | Maybe<PriceList> | (Optional) Returns a price list resource by ID. | |
| priceLists | PriceListConnection | All price lists for a shop. | |
| priceRule? | Maybe<PriceRule> | (Optional) Returns a code price rule resource by ID. | |
| priceRules | PriceRuleConnection | Returns a list of price rule resources that have at least one associated discount code. | |
| priceRuleSavedSearches | SavedSearchConnection | List of the shop’s price rule saved searches. | |
| primaryMarket | Market | The primary market of the shop. | |
| privateMetafield? | Maybe<PrivateMetafield> | (Optional) Returns a private metafield by ID. Private metafields are accessible only by the application that created them. | |
| privateMetafields | PrivateMetafieldConnection | Returns a list of private metafields associated to a resource. | |
| product? | Maybe<Product> | (Optional) Returns a Product resource by ID. | |
| productByHandle? | Maybe<Product> | (Optional) Return a product by its handle. | |
| productDuplicateJob | ProductDuplicateJob | Returns the product duplicate job. | |
| productFeed? | Maybe<ProductFeed> | (Optional) Returns a ProductFeed resource by ID. | |
| productFeeds | ProductFeedConnection | The product feeds for the shop. | |
| productResourceFeedback? | Maybe<ProductResourceFeedback> | (Optional) Returns the product resource feedback for the currently authenticated app. | |
| products | ProductConnection | List of products. | |
| productSavedSearches | SavedSearchConnection | Returns a list of the shop’s product saved searches. | |
| productVariant? | Maybe<ProductVariant> | (Optional) Returns a ProductVariant resource by ID. | |
| productVariants | ProductVariantConnection | List of the product variants. | |
| publicApiVersions | Array<ApiVersion> | The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions. | |
| publication? | Maybe<Publication> | (Optional) Lookup a publication by ID. | |
| publications | PublicationConnection | List of publications. | |
| refund? | Maybe<Refund> | (Optional) Returns a Refund resource by ID. | |
| return? | Maybe<Return> | (Optional) Returns a Return resource by ID. | |
| returnableFulfillment? | Maybe<ReturnableFulfillment> | (Optional) Lookup a returnable fulfillment by ID. | |
| returnableFulfillments | ReturnableFulfillmentConnection | List of returnable fulfillments. | |
| reverseDelivery? | Maybe<ReverseDelivery> | (Optional) Lookup a reverse delivery by ID. | |
| reverseFulfillmentOrder? | Maybe<ReverseFulfillmentOrder> | (Optional) Lookup a reverse fulfillment order by ID. | |
| scriptTag? | Maybe<ScriptTag> | <p>(Optional) <div class="note"><h4>Theme app extensions</h4> <p>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.</p></div></p><p>Lookup a script tag resource by ID.</p> | |
| scriptTags | ScriptTagConnection | <p><div class="note"><h4>Theme app extensions</h4> <p>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.</p></div></p><p>A list of script tags.</p> | |
| segment? | Maybe<Segment> | (Optional) The Customer Segment. | |
| segmentCount | Scalars[‘Int’][‘output’] | The number of segments for a shop. | |
| segmentFilters | SegmentFilterConnection | A list of filters. | |
| segmentFilterSuggestions | SegmentFilterConnection | A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria. | |
| segmentMigrations | SegmentMigrationConnection | A list of a shop’s segment migrations. | |
| segments | SegmentConnection | A list of a shop’s segments. | |
| segmentValueSuggestions | SegmentValueConnection | 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. | |
| sellingPlanGroup? | Maybe<SellingPlanGroup> | (Optional) Returns a Selling Plan Group resource by ID. | |
| sellingPlanGroups | SellingPlanGroupConnection | List Selling Plan Groups. | |
| serverPixel? | Maybe<ServerPixel> | (Optional) The server pixel configured by the app. | |
| shop | Shop | 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. | |
| shopBillingPreferences | ShopBillingPreferences | The shop’s billing preferences. | |
| shopifyFunction? | Maybe<ShopifyFunction> | (Optional) The Shopify Function. | |
| shopifyFunctions | ShopifyFunctionConnection | Returns the Shopify Functions for apps installed on the shop. | |
| shopifyPaymentsAccount? | Maybe<ShopifyPaymentsAccount> | (Optional) Shopify Payments account information, including balances and payouts. | |
| shopifyqlQuery? | Maybe<ShopifyqlResponse> | (Optional) Returns the results of a ShopifyQL query. Refer to the [ShopifyQL documentation](https://shopify.dev/api/shopifyql) for more information. | |
| shopLocales | Array<ShopLocale> | A list of locales available on a shop. | |
| staffMember? | Maybe<StaffMember> | (Optional) The StaffMember resource, by ID. | |
| standardMetafieldDefinitionTemplates | StandardMetafieldDefinitionTemplateConnection | <p>Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved.</p><p>Refer to all available [Standard Metafield Definition Templates](https://shopify.dev/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate).</p> |
|
| subscriptionBillingAttempt? | Maybe<SubscriptionBillingAttempt> | (Optional) Returns a SubscriptionBillingAttempt by ID. | |
| subscriptionBillingAttempts | SubscriptionBillingAttemptConnection | Returns subscription billing attempts on a store. | |
| subscriptionBillingCycle? | Maybe<SubscriptionBillingCycle> | (Optional) Returns a subscription billing cycle found either by cycle index or date. | |
| subscriptionBillingCycles | SubscriptionBillingCycleConnection | Returns subscription billing cycles for a contract ID. | |
| subscriptionContract? | Maybe<SubscriptionContract> | (Optional) Returns a Subscription Contract resource by ID. | |
| subscriptionContracts | SubscriptionContractConnection | List Subscription Contracts. | |
| subscriptionDraft? | Maybe<SubscriptionDraft> | (Optional) Returns a Subscription Draft resource by ID. | |
| tenderTransactions | TenderTransactionConnection | Returns a list of TenderTransactions associated with the shop. | |
| translatableResource? | Maybe<TranslatableResource> | (Optional) A resource that can have localized values for different languages. | |
| translatableResources | TranslatableResourceConnection | Resources that can have localized values for different languages. | |
| translatableResourcesByIds | TranslatableResourceConnection | Resources that can have localized values for different languages. | |
| urlRedirect? | Maybe<UrlRedirect> | (Optional) Returns a redirect resource by ID. | |
| urlRedirectImport? | Maybe<UrlRedirectImport> | (Optional) Returns a redirect import resource by ID. | |
| urlRedirects | UrlRedirectConnection | A list of redirects for a shop. | |
| urlRedirectSavedSearches | SavedSearchConnection | A list of the shop’s URL redirect saved searches. | |
| webhookSubscription? | Maybe<WebhookSubscription> | (Optional) Returns a webhook subscription by ID. | |
| webhookSubscriptions | WebhookSubscriptionConnection | Returns a list of webhook subscriptions. | |
| webPixel? | Maybe<WebPixel> | (Optional) The web pixel configured by the app. |