QueryRoot - admin-graphql - OBJECT
Version: 2024-04
Description:
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
Access Scopes
Fields
-
abandonment:
Abandonment -
Returns an abandonment by ID.
-
abandonmentByAbandonedCheckoutId:
Abandonment -
Returns an Abandonment by the Abandoned Checkout ID.
-
app:
App -
Lookup an App by ID or return the currently authenticated App.
-
appByHandle:
App -
Fetches app by handle.
Returns null if the app doesn't exist.
-
appByKey:
App -
Fetches an app by its client ID.
Returns null if the app doesn't exist.
-
appDiscountType:
AppDiscountType -
An app discount type.
-
appDiscountTypes:
AppDiscountType! -
A list of app discount types installed by apps.
-
appInstallation:
AppInstallation -
Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
-
automaticDiscount:
DiscountAutomatic -
Returns an automatic discount resource by ID.
-
automaticDiscountNode:
DiscountAutomaticNode -
Returns an automatic discount resource by ID.
-
availableCarrierServices:
DeliveryCarrierServiceAndLocations! -
Returns a list of activated carrier services and associated shop locations that support them.
-
availableLocales:
Locale! -
A list of available locales.
-
carrierService:
DeliveryCarrierService -
Returns a `DeliveryCarrierService` object by ID.
-
cashTrackingSession:
CashTrackingSession -
Lookup a cash tracking session by ID.
-
catalog:
Catalog -
Returns a Catalog resource by ID.
-
catalogOperations:
ResourceOperation! -
Returns the most recent catalog operations for the shop.
-
catalogsCount:
Count -
The count of catalogs belonging to the shop. Limited to a maximum of 10000.
-
channel:
Channel -
Lookup a channel by ID.
-
checkoutBranding:
CheckoutBranding -
Returns the visual customizations for checkout for a given checkout profile.
To learn more about updating checkout branding settings, refer to the
[checkoutBrandingUpsert](https://shopify.dev/api/admin-graphql/unstable/mutations/checkoutBrandingUpsert)
mutation and the checkout branding [tutorial](https://shopify.dev/docs/apps/checkout/styling).
-
checkoutProfile:
CheckoutProfile -
A checkout profile on a shop.
-
codeDiscountNode:
DiscountCodeNode -
Returns a code discount resource by ID.
-
codeDiscountNodeByCode:
DiscountCodeNode -
Returns a code discount identified by its discount code.
-
collection:
Collection -
Returns a Collection resource by ID.
-
collectionByHandle:
Collection -
Return a collection by its handle.
-
collectionRulesConditions:
CollectionRuleConditions! -
Lists all rules that can be used to create smart collections.
-
companiesCount:
Count -
The number of companies for a shop.
-
company:
Company -
Returns a `Company` object by ID.
-
companyContact:
CompanyContact -
Returns a `CompanyContact` object by ID.
-
companyContactRole:
CompanyContactRole -
Returns a `CompanyContactRole` object by ID.
-
companyLocation:
CompanyLocation -
Returns a `CompanyLocation` object by ID.
-
currentAppInstallation:
AppInstallation! -
Return the AppInstallation for the currently authenticated App.
-
currentBulkOperation:
BulkOperation -
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:
Customer -
Returns a Customer resource by ID.
-
customerMergeJobStatus:
CustomerMergeRequest -
Returns the status of a customer merge request job.
-
customerMergePreview:
CustomerMergePreview! -
Returns a preview of a customer merge request.
-
customerPaymentMethod:
CustomerPaymentMethod -
Returns a CustomerPaymentMethod resource by its ID.
-
customerSegmentMembersQuery:
CustomerSegmentMembersQuery -
Returns a segment members query resource by ID.
-
customerSegmentMembership:
SegmentMembershipResponse! -
Whether a member, which is a customer, belongs to a segment.
-
deliveryCustomization:
DeliveryCustomization -
The delivery customization.
-
deliveryProfile:
DeliveryProfile -
Returns a Delivery Profile resource by ID.
-
deliverySettings:
DeliverySetting -
Returns the shop-wide shipping settings.
-
discountCodesCount:
Count -
The total number of discount codes for the shop.
-
discountNode:
DiscountNode -
Returns a discount resource by ID.
-
discountRedeemCodeBulkCreation:
DiscountRedeemCodeBulkCreation -
Returns a bulk code creation resource by ID.
-
dispute:
ShopifyPaymentsDispute -
Returns dispute details based on ID.
-
disputeEvidence:
ShopifyPaymentsDisputeEvidence -
Returns dispute evidence details based on ID.
-
domain:
Domain -
Lookup a Domain by ID.
-
draftOrder:
DraftOrder -
Returns a DraftOrder resource by ID.
-
draftOrderTag:
DraftOrderTag -
Returns a DraftOrderTag resource by ID.
-
fulfillment:
Fulfillment -
Returns a Fulfillment resource by ID.
-
fulfillmentConstraintRules:
FulfillmentConstraintRule! -
The fulfillment constraint rules that belong to a shop.
-
fulfillmentOrder:
FulfillmentOrder -
Returns a Fulfillment order resource by ID.
-
fulfillmentService:
FulfillmentService -
Returns a FulfillmentService resource by ID.
-
giftCard:
GiftCard -
Returns a gift card resource by ID.
-
giftCardsCount:
Count -
The total number of gift cards issued for the shop. Limited to a maximum of 10000.
-
inventoryItem:
InventoryItem -
Returns an
[InventoryItem](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem)
object by ID.
-
inventoryLevel:
InventoryLevel -
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:
Job -
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
-
location:
Location -
Returns an inventory Location resource by ID.
-
locationsAvailableForDeliveryProfiles:
Location -
Returns a list of all origin locations available for a delivery profile.
-
market:
Market -
Returns a market resource by ID.
-
marketByGeography:
Market -
Returns the applicable market for a customer based on where they are in the world.
-
marketLocalizableResource:
MarketLocalizableResource -
A resource that can have localized values for different markets.
-
marketingActivity:
MarketingActivity -
Returns a MarketingActivity resource by ID.
-
marketingEvent:
MarketingEvent -
Returns a MarketingEvent resource by ID.
-
metafieldDefinition:
MetafieldDefinition -
Returns a metafield definition by identifier.
-
metafieldDefinitionTypes:
MetafieldDefinitionType! -
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](https://shopify.dev/apps/metafields/types).
-
metafieldStorefrontVisibility:
MetafieldStorefrontVisibility -
Returns a `MetafieldStorefrontVisibility` record by ID. A `MetafieldStorefrontVisibility` record lists the
metafields to make visible in the Storefront API.
-
metaobject:
Metaobject -
Retrieves a metaobject by ID.
-
metaobjectByHandle:
Metaobject -
Retrieves a metaobject by handle.
-
metaobjectDefinition:
MetaobjectDefinition -
Retrieves a metaobject definition by ID.
-
metaobjectDefinitionByType:
MetaobjectDefinition -
Finds a metaobject definition by type.
-
node:
Node -
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:
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:
Order -
Returns an Order resource by ID.
-
orderPaymentStatus:
OrderPaymentStatus -
Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
-
paymentCustomization:
PaymentCustomization -
The payment customization.
-
paymentTermsTemplates:
PaymentTermsTemplate! -
The list of payment terms templates eligible for all shops and users.
-
pendingOrdersCount:
Count -
The number of pendings orders. Limited to a maximum of 10000.
-
priceList:
PriceList -
Returns a price list resource by ID.
-
priceRule:
PriceRule -
Returns a code price rule resource by ID.
-
primaryMarket:
Market! -
The primary market of the shop.
-
privateMetafield:
PrivateMetafield -
Returns a private metafield by ID.
Private metafields are accessible only by the application that created them.
-
product:
Product -
Returns a Product resource by ID.
-
productByHandle:
Product -
Return a product by its handle.
-
productDuplicateJob:
ProductDuplicateJob! -
Returns the product duplicate job.
-
productFeed:
ProductFeed -
Returns a ProductFeed resource by ID.
-
productOperation:
ProductOperation -
Returns a ProductOperation resource by ID.
This can be used to query the
[ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), using
the ID that was returned
[when the product was created or updated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously)
by the
[ProductSet](https://shopify.dev/api/admin-graphql/current/mutations/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](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), the
`userErrors` field provides mutation errors that occurred during the operation.
-
productResourceFeedback:
ProductResourceFeedback -
Returns the product resource feedback for the currently authenticated app.
-
productVariant:
ProductVariant -
Returns a ProductVariant resource by ID.
-
productsCount:
Count -
Count of products. Limited to a maximum of 10000.
-
publicApiVersions:
ApiVersion! -
The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.
-
publication:
Publication -
Lookup a publication by ID.
-
publicationsCount:
Count -
Count of publications.
-
refund:
Refund -
Returns a Refund resource by ID.
-
return:
Return -
Returns a Return resource by ID.
-
returnableFulfillment:
ReturnableFulfillment -
Lookup a returnable fulfillment by ID.
-
reverseDelivery:
ReverseDelivery -
Lookup a reverse delivery by ID.
-
reverseFulfillmentOrder:
ReverseFulfillmentOrder -
Lookup a reverse fulfillment order by ID.
-
scriptTag:
ScriptTag -
<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. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div>
<div class="note"><h4>Script tag deprecation</h4>
<p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div>
Lookup a script tag resource by ID.
-
segment:
Segment -
The Customer Segment.
-
segmentsCount:
Count -
The number of segments for a shop.
-
sellingPlanGroup:
SellingPlanGroup -
Returns a Selling Plan Group resource by ID.
-
serverPixel:
ServerPixel -
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.
-
shopLocales:
ShopLocale! -
A list of locales available on a shop.
-
shopifyFunction:
ShopifyFunction -
The Shopify Function.
-
shopifyPaymentsAccount:
ShopifyPaymentsAccount -
Shopify Payments account information, including balances and payouts.
-
shopifyqlQuery:
ShopifyqlResponse -
Returns the results of a ShopifyQL query. Refer to the [ShopifyQL documentation](https://shopify.dev/api/shopifyql) for more information.
-
staffMember:
StaffMember -
The StaffMember resource, by ID.
-
subscriptionBillingAttempt:
SubscriptionBillingAttempt -
Returns a SubscriptionBillingAttempt by ID.
-
subscriptionBillingCycle:
SubscriptionBillingCycle -
Returns a subscription billing cycle found either by cycle index or date.
-
subscriptionContract:
SubscriptionContract -
Returns a Subscription Contract resource by ID.
-
subscriptionDraft:
SubscriptionDraft -
Returns a Subscription Draft resource by ID.
-
taxonomy:
Taxonomy -
The Taxonomy resource lets you access the categories, attributes and values of the loaded taxonomy tree.
-
translatableResource:
TranslatableResource -
A resource that can have localized values for different languages.
-
urlRedirect:
UrlRedirect -
Returns a redirect resource by ID.
-
urlRedirectImport:
UrlRedirectImport -
Returns a redirect import resource by ID.
-
validation:
Validation -
Validation available on the shop.
-
webPixel:
WebPixel -
The web pixel configured by the app.
-
webhookSubscription:
WebhookSubscription -
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](https://shopify.dev/docs/apps/build/webhooks/subscribe).
Connections
Related queries
Related mutations
Related Unions
Examples