QueryRoot
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
On this page
Connections
-
appCredits (
AppCreditConnection!
)Credits that can be used towards future app purchases.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(AppTransactionSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
appInstallations (
AppInstallationConnection!
)List of app installations.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
category
(AppInstallationCategory
)The category of app installations to fetch.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.privacy
(AppInstallationPrivacy
)The privacy level of app installations to fetch.
Default value:PUBLIC
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(AppInstallationSortKeys
)Sort the underlying list by the given key.
Default value:INSTALLED_AT
-
automaticDiscountNodes (
DiscountAutomaticNodeConnection!
)List of automatic discounts.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
status
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(AutomaticDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
automaticDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's automatic discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
codeDiscountNodes (
DiscountCodeNodeConnection!
)List of code discounts. Special fields for query params:
- status: active, expired, scheduled
- discount_type: bogo, fixed_amount, free_shipping, percentage.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
discount_type
ends_at
starts_at
status
times_used
type
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CodeDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
codeDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's code discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collectionSavedSearches (
SavedSearchConnection!
)List of the shop's collection saved searches.
Required access
read_products
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collections (
CollectionConnection!
)List of collections.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
collection_type
publishable_status
published_status
title
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CollectionSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customerSavedSearches (
SavedSearchConnection!
)List of the shop's customer saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
name
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(CustomerSavedSearchSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customers (
CustomerConnection!
)List of customers.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
accepts_marketing
country
customer_date
email
last_abandoned_order_date
order_date
orders_count
phone
state
tag
total_spent
updated_at
See the detailed search syntax.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(CustomerSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
deletionEvents (
DeletionEventConnection!
)The paginated list of deletion events.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
occurred_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DeletionEventSortKeys
)Sort the underlying list by the given key.
Default value:ID
subjectTypes
([DeletionEventSubjectType!]
)List of subject types to filter by.
-
deliveryProfiles (
DeliveryProfileConnection!
)List of saved delivery profiles.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.merchantOwnedOnly
(Boolean
)Only include delivery profiles that are created by the merchant.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountRedeemCodeSavedSearches (
SavedSearchConnection!
)List of the shop's redeemed discount code saved searches.
Required access
read_discounts
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
draftOrderSavedSearches (
SavedSearchConnection!
)List of the shop's draft order saved searches.
Required access
read_draft_orders
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
draftOrders (
DraftOrderConnection!
)List of saved draft orders.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
customer_id
status
tag
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DraftOrderSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
inventoryItems (
InventoryItemConnection!
)List of inventory items.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
id
sku
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
locations (
LocationConnection!
)List of active locations.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.includeInactive
(Boolean
)If true, also include the locations that are deactivated.
Default value:false
includeLegacy
(Boolean
)If true, also include the legacy locations of fulfillment services.
Default value:false
last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
active
address1
address2
city
country
legacy
name
province
zip
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(LocationSortKeys
)Sort the underlying list by the given key.
Default value:NAME
-
locationsAvailableForDeliveryProfilesConnection (
LocationConnection!
)Returns a list of all origin locations available for a delivery profile.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
marketingActivities (
MarketingActivityConnection!
)List of a campaign's marketing activities.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
app_id
created_at
marketing_campaign_id
scheduled_to_end_at
scheduled_to_start_at
tactic
title
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(MarketingActivitySortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
marketingEvents (
MarketingEventConnection!
)List of marketing events.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
app_id
description
started_at
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(MarketingEventSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
metafieldStorefrontVisibilities (
MetafieldStorefrontVisibilityConnection!
)List of metafield namespaces and keys visible to the Storefront API.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Filter the metafields storefront whitelist by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
metafields (
MetafieldConnection!
)List of metafields.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Filter metafields by namespace.
owner
(ID!
) requiredRetrieve the metafields of a certain resource, specified by the resource ID.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
orderSavedSearches (
SavedSearchConnection!
)List of the shop's order saved searches.
Required access
read_orders
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
orders (
OrderConnection!
)List of orders placed.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
cart_token
channel_id
chargeback_status
checkout_token
created_at
credit_card_last4
customer_id
delivery_method
discount_code
email
financial_status
fraud_protection_level
fulfillment_location_id
fulfillment_status
location_id
name
processed_at
reference_location_id
return_status
risk_level
sales_channel
source_identifier
source_name
status
tag
test
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(OrderSortKeys
)Sort the underlying list by the given key.
Default value:PROCESSED_AT
-
priceRuleSavedSearches (
SavedSearchConnection!
)List of the shop's price rule saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
priceRules (
PriceRuleConnection!
)List of price rules.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
discount_type
ends_at
starts_at
status
times_used
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(PriceRuleSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Filter the private metafields by namespace.
owner
(ID!
) requiredRetrieve the private metafields of a certain resource, specified by the resource ID.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
productSavedSearches (
SavedSearchConnection!
)List of the shop's product saved searches.
Required access
read_products
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
productVariants (
ProductVariantConnection!
)List of the product variants.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
barcode
collection
delivery_profile_id
gift_card
inventory_quantity
location_id
managed
managed_by
product_id
product_status
product_type
publishable_status
published_status
sku
tag
taxable
title
updated_at
vendor
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(ProductVariantSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
products (
ProductConnection!
)List of products.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
barcode
created_at
delivery_profile_id
error_feedback
gift_card
inventory_total
is_price_reduced
out_of_stock_somewhere
price
product_type
publishable_status
published_status
sku
status
tag
title
updated_at
vendor
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(ProductSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
publications (
PublicationConnection!
)List of the active publications.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
scriptTags (
ScriptTagConnection!
)A list of script tags.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
src
(URL
)The source URL of the script tag to filter by.
-
sellingPlanGroups (
SellingPlanGroupConnection!
)List Selling Plan Groups.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
delivery_frequency
percentage_off
name
created_at
See the detailed search syntax.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(SellingPlanGroupSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
subscriptionContracts (
SubscriptionContractConnection!
)List Subscription Contracts.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
tenderTransactions (
TenderTransactionConnection!
)List of TenderTransactions associated with the Shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
processed_at
test
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
translatableResources (
TranslatableResourceConnection!
)List of translatable resources.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.resourceType
(TranslatableResourceType!
) requiredReturn only resources of a type.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
webhookSubscriptions (
WebhookSubscriptionConnection!
)List of webhook subscriptions.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
callbackUrl
(URL
)Callback URL to filter by.
first
(Int
)Returns up to the first
n
elements from the list.format
(WebhookSubscriptionFormat
)Response format to filter by.
last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(WebhookSubscriptionSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
topics
([WebhookSubscriptionTopic!]
)List of webhook subscription topics to filter by.
Fields
-
app (
App
)Lookup an App by ID or return the currently authenticated App.
Argument Description id
(ID
)The ID to lookup the App by.
-
appByHandle (
App
)Fetches app by handle. Returns null if the app doesn't exist.
Argument Description handle
(String!
) requiredHandle of the App.
-
appByKey (
App
)Fetches app by apiKey. Returns null if the app doesn't exist.
Argument Description apiKey
(String!
) requiredAPI key of the App.
-
appInstallation (
AppInstallation
)Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
Argument Description id
(ID
)ID used to lookup AppInstallation.
-
automaticDiscountNode (
DiscountAutomaticNode
)Returns an automatic discount resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DiscountAutomaticNode to return.
-
availableCarrierServices (
[DeliveryCarrierServiceAndLocations!]!
)List of activated carrier services and which shop locations support them.
-
availableLocales (
[Locale!]!
)List of available locales.
-
carrierService (
DeliveryCarrierService
)Lookup a carrier service by ID.
Argument Description id
(ID!
) requiredThe ID of the DeliveryCarrierService to return.
-
codeDiscountNode (
DiscountCodeNode
)Returns a code discount resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DiscountCodeNode to return.
-
codeDiscountNodeByCode (
DiscountCodeNode
)Returns a code discount identified by its code.
Argument Description code
(String!
) requiredThe code of the DiscountCodeNode to return.
-
collection (
Collection
)Returns a Collection resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Collection to return.
-
collectionByHandle (
Collection
)Return a collection by its handle.
Argument Description handle
(String!
) requiredThe handle of the collection.
-
collectionRulesConditions (
[CollectionRuleConditions!]!
)A list of rule conditions to define how collections with rules can be created.
-
currentAppInstallation (
AppInstallation!
)Return the AppInstallation for the currently authenticated App.
-
currentBulkOperation (
BulkOperation
)Returns the current app's most recent BulkOperation.
-
customer (
Customer
)Returns a Customer resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Customer to return.
-
customerPaymentMethod (
CustomerPaymentMethod
)Returns a CustomerPaymentMethod resource by ID.
-
deliveryProfile (
DeliveryProfile
)Lookup a Delivery Profile by ID.
Argument Description id
(ID!
) requiredThe ID of the DeliveryProfile to return.
-
deliverySettings (
DeliverySetting
)The shop-wide shipping settings.
-
domain (
Domain
)Lookup a Domain by ID.
Argument Description id
(ID!
) requiredThe ID of the Domain to return.
-
draftOrder (
DraftOrder
)Returns a DraftOrder resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DraftOrder to return.
-
fulfillment (
Fulfillment
)Returns a Fulfillment resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Fulfillment to return.
-
fulfillmentOrder (
FulfillmentOrder
)Returns a Fulfillment order resource by ID.
Argument Description id
(ID!
) requiredThe ID of the FulfillmentOrder to return.
-
fulfillmentService (
FulfillmentService
)Returns a FulfillmentService resource by ID.
Argument Description id
(ID!
) requiredThe ID of the FulfillmentService to return.
-
inventoryItem (
InventoryItem
)Returns an InventoryItem resource by ID.
Argument Description id
(ID!
) requiredThe ID of the InventoryItem to return.
-
inventoryLevel (
InventoryLevel
)Returns an InventoryLevel resource by ID.
Argument Description id
(ID!
) requiredThe ID of the InventoryLevel to return.
-
job (
Job
)Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Argument Description id
(ID!
) requiredID of the job to query.
-
location (
Location
)Returns an inventory Location resource by ID.
Argument Description id
(ID
)The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.
-
marketingActivity (
MarketingActivity
)Returns a MarketingActivity resource by ID.
Argument Description id
(ID!
) requiredThe ID of the MarketingActivity to return.
-
marketingEvent (
MarketingEvent
)Returns a MarketingEvent resource by ID.
Argument Description id
(ID!
) requiredThe ID of the MarketingEvent to return.
-
metafield (
Metafield
)Returns a metafield by ID.
Argument Description id
(ID!
) requiredThe ID of the Metafield to return.
-
metafieldStorefrontVisibility (
MetafieldStorefrontVisibility
)Returns metafield storefront visibility by ID.
Argument Description id
(ID!
) requiredThe ID of the MetafieldStorefrontVisibility to return.
-
node (
Node
)Returns a specific node by ID.
Argument Description id
(ID!
) requiredThe ID of the Node to return.
-
nodes (
[Node]!
)Returns the list of nodes with the given IDs.
Argument Description ids
([ID!]!
) requiredThe IDs of the Nodes to return.
-
order (
Order
)Returns an Order resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Order to return.
-
priceRule (
PriceRule
)Lookup a price rule by ID.
Argument Description id
(ID!
) requiredThe ID of the PriceRule to return.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield by ID.
Argument Description id
(ID!
) requiredThe ID of the PrivateMetafield to return.
-
product (
Product
)Returns a Product resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Product to return.
-
productByHandle (
Product
)Return a product by its handle.
Argument Description handle
(String!
) requiredThe handle of the product.
-
productVariant (
ProductVariant
)Returns a ProductVariant resource by ID.
Argument Description id
(ID!
) requiredThe ID of the ProductVariant to return.
-
publicApiVersions (
[ApiVersion!]!
)The list of public Admin API versions, including supported, release candidate and unstable versions.
-
publication (
Publication
)Lookup a publication by ID.
Argument Description id
(ID!
) requiredThe ID of the Publication to return.
-
refund (
Refund
)Returns a Refund resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Refund to return.
-
scriptTag (
ScriptTag
)Lookup a script tag resource by ID.
Argument Description id
(ID!
) requiredThe ID of the ScriptTag to return.
-
sellingPlanGroup (
SellingPlanGroup
)Returns a Selling Plan Group resource by ID.
Argument Description id
(ID!
) requiredThe ID of the SellingPlanGroup to return.
-
shop (
Shop!
)Returns a Shop resource corresponding to access token used in request.
-
shopLocales (
[ShopLocale!]!
)List of locales available on a shop.
Argument Description published
(Boolean
)Return only published locales.
-
subscriptionBillingAttempt (
SubscriptionBillingAttempt
)Returns a SubscriptionBillingAttempt by ID.
Argument Description id
(ID!
) requiredThe ID of the SubscriptionBillingAttempt to return.
-
subscriptionContract (
SubscriptionContract
)Returns a Subscription Contract resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Subscription Contract to return.
-
subscriptionDraft (
SubscriptionDraft
)Returns a Subscription Draft resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Subscription Draft to return.
-
translatableResource (
TranslatableResource
)Translatable resource.
Argument Description resourceId
(ID!
) requiredFind a translatable resource by ID.
-
webhookSubscription (
WebhookSubscription
)Returns a webhook subscription by ID.
Argument Description id
(ID!
) requiredThe ID of the WebhookSubscription to return.
Deprecated fields
-
automaticDiscount (
DiscountAutomatic
) deprecatedReturns an automatic discount resource by ID.
Deprecation warning
Use
automaticDiscountNode
insteadArgument Description id
(ID!
) requiredThe ID of the DiscountAutomatic to return.
-
automaticDiscounts (
DiscountAutomaticConnection!
) deprecatedList of automatic discounts.
Deprecation warning
Use
automaticDiscountNodes
insteadArgument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
status
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(AutomaticDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
channel (
Channel
) deprecatedLookup a channel by ID.
Deprecation warning
Use
publication
insteadArgument Description id
(ID!
) requiredThe ID of the Channel to return.
-
channels (
ChannelConnection!
) deprecatedList of the active sales channels.
Deprecation warning
Use
publications
insteadArgument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
locationsAvailableForDeliveryProfiles (
[Location!]
) deprecatedReturns a list of all origin locations available for a delivery profile.
Deprecation warning
Use
locationsAvailableForDeliveryProfilesConnection
instead
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
On this page
Connections
-
appInstallations (
AppInstallationConnection!
)List of app installations.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
category
(AppInstallationCategory
)The category of app installations to fetch.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.privacy
(AppInstallationPrivacy
)The privacy level of app installations to fetch.
Default value:PUBLIC
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(AppInstallationSortKeys
)Sort the underlying list by the given key.
Default value:INSTALLED_AT
-
automaticDiscountNodes (
DiscountAutomaticNodeConnection!
)List of automatic discounts.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
status
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(AutomaticDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
automaticDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's automatic discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
codeDiscountNodes (
DiscountCodeNodeConnection!
)List of code discounts. Special fields for query params:
- status: active, expired, scheduled
- discount_type: bogo, fixed_amount, free_shipping, percentage.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
discount_type
ends_at
starts_at
status
times_used
type
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CodeDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
codeDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's code discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collectionSavedSearches (
SavedSearchConnection!
)List of the shop's collection saved searches.
Required access
read_products
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collections (
CollectionConnection!
)List of collections.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
collection_type
publishable_status
published_status
title
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CollectionSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customerSavedSearches (
SavedSearchConnection!
)List of the shop's customer saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
name
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(CustomerSavedSearchSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customers (
CustomerConnection!
)List of customers.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
accepts_marketing
country
customer_date
email
last_abandoned_order_date
order_date
orders_count
phone
state
tag
total_spent
updated_at
See the detailed search syntax.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(CustomerSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
deletionEvents (
DeletionEventConnection!
)The paginated list of deletion events.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
occurred_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DeletionEventSortKeys
)Sort the underlying list by the given key.
Default value:ID
subjectTypes
([DeletionEventSubjectType!]
)List of subject types to filter by.
-
deliveryProfiles (
DeliveryProfileConnection!
)List of saved delivery profiles.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.merchantOwnedOnly
(Boolean
)Only include delivery profiles that are created by the merchant.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
discountRedeemCodeSavedSearches (
SavedSearchConnection!
)List of the shop's redeemed discount code saved searches.
Required access
read_discounts
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
draftOrderSavedSearches (
SavedSearchConnection!
)List of the shop's draft order saved searches.
Required access
read_draft_orders
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
draftOrders (
DraftOrderConnection!
)List of saved draft orders.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
customer_id
status
tag
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(DraftOrderSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
inventoryItems (
InventoryItemConnection!
)List of inventory items.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
id
sku
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
locations (
LocationConnection!
)List of active locations.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.includeInactive
(Boolean
)If true, also include the locations that are deactivated.
Default value:false
includeLegacy
(Boolean
)If true, also include the legacy locations of fulfillment services.
Default value:false
last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
active
address1
address2
city
country
legacy
name
province
zip
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(LocationSortKeys
)Sort the underlying list by the given key.
Default value:NAME
-
locationsAvailableForDeliveryProfilesConnection (
LocationConnection!
)Returns a list of all origin locations available for a delivery profile.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
marketingActivities (
MarketingActivityConnection!
)List of a campaign's marketing activities.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
app_id
created_at
marketing_campaign_id
scheduled_to_end_at
scheduled_to_start_at
tactic
title
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(MarketingActivitySortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
marketingEvents (
MarketingEventConnection!
)List of marketing events.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
app_id
description
started_at
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(MarketingEventSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
metafieldStorefrontVisibilities (
MetafieldStorefrontVisibilityConnection!
)List of metafield namespaces and keys visible to the Storefront API.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Filter the metafields storefront whitelist by namespace.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
orderSavedSearches (
SavedSearchConnection!
)List of the shop's order saved searches.
Required access
read_orders
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
orders (
OrderConnection!
)List of orders placed.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
cart_token
channel_id
chargeback_status
checkout_token
created_at
credit_card_last4
customer_id
delivery_method
discount_code
email
financial_status
fraud_protection_level
fulfillment_location_id
fulfillment_status
location_id
name
processed_at
reference_location_id
return_status
risk_level
sales_channel
source_identifier
source_name
status
tag
test
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(OrderSortKeys
)Sort the underlying list by the given key.
Default value:PROCESSED_AT
-
priceRuleSavedSearches (
SavedSearchConnection!
)List of the shop's price rule saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
priceRules (
PriceRuleConnection!
)List of price rules.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
discount_type
ends_at
starts_at
status
times_used
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(PriceRuleSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
privateMetafields (
PrivateMetafieldConnection!
)List of private metafields.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)Filter the private metafields by namespace.
owner
(ID!
) requiredRetrieve the private metafields of a certain resource, specified by the resource ID.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
productSavedSearches (
SavedSearchConnection!
)List of the shop's product saved searches.
Required access
read_products
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
productVariants (
ProductVariantConnection!
)List of the product variants.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
barcode
collection
delivery_profile_id
gift_card
inventory_quantity
location_id
managed
managed_by
product_id
product_status
product_type
publishable_status
published_status
sku
tag
taxable
title
updated_at
vendor
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(ProductVariantSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
products (
ProductConnection!
)List of products.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
barcode
created_at
delivery_profile_id
error_feedback
gift_card
inventory_total
is_price_reduced
out_of_stock_somewhere
price
product_type
publishable_status
published_status
sku
status
tag
title
updated_at
vendor
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(ProductSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
publications (
PublicationConnection!
)List of the active publications.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
scriptTags (
ScriptTagConnection!
)A list of script tags.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
src
(URL
)The source URL of the script tag to filter by.
-
sellingPlanGroups (
SellingPlanGroupConnection!
)List Selling Plan Groups.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
delivery_frequency
percentage_off
name
created_at
See the detailed search syntax.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(SellingPlanGroupSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
subscriptionContracts (
SubscriptionContractConnection!
)List Subscription Contracts.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
tenderTransactions (
TenderTransactionConnection!
)List of TenderTransactions associated with the Shop.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
processed_at
test
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
translatableResources (
TranslatableResourceConnection!
)List of translatable resources.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.resourceType
(TranslatableResourceType!
) requiredReturn only resources of a type.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
webhookSubscriptions (
WebhookSubscriptionConnection!
)List of webhook subscriptions.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
callbackUrl
(URL
)Callback URL to filter by.
first
(Int
)Returns up to the first
n
elements from the list.format
(WebhookSubscriptionFormat
)Response format to filter by.
last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(WebhookSubscriptionSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
topics
([WebhookSubscriptionTopic!]
)List of webhook subscription topics to filter by.
Fields
-
app (
App
)Lookup an App by ID or return the currently authenticated App.
Argument Description id
(ID
)The ID to lookup the App by.
-
appByHandle (
App
)Fetches app by handle. Returns null if the app doesn't exist.
Argument Description handle
(String!
) requiredHandle of the App.
-
appByKey (
App
)Fetches app by apiKey. Returns null if the app doesn't exist.
Argument Description apiKey
(String!
) requiredAPI key of the App.
-
appInstallation (
AppInstallation
)Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.
Argument Description id
(ID
)ID used to lookup AppInstallation.
-
automaticDiscountNode (
DiscountAutomaticNode
)Returns an automatic discount resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DiscountAutomaticNode to return.
-
availableCarrierServices (
[DeliveryCarrierServiceAndLocations!]!
)List of activated carrier services and which shop locations support them.
-
availableLocales (
[Locale!]!
)List of available locales.
-
carrierService (
DeliveryCarrierService
)Lookup a carrier service by ID.
Argument Description id
(ID!
) requiredThe ID of the DeliveryCarrierService to return.
-
codeDiscountNode (
DiscountCodeNode
)Returns a code discount resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DiscountCodeNode to return.
-
codeDiscountNodeByCode (
DiscountCodeNode
)Returns a code discount identified by its code.
Argument Description code
(String!
) requiredThe code of the DiscountCodeNode to return.
-
collection (
Collection
)Returns a Collection resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Collection to return.
-
collectionByHandle (
Collection
)Return a collection by its handle.
Argument Description handle
(String!
) requiredThe handle of the collection.
-
collectionRulesConditions (
[CollectionRuleConditions!]!
)A list of rule conditions to define how collections with rules can be created.
-
currentAppInstallation (
AppInstallation!
)Return the AppInstallation for the currently authenticated App.
-
currentBulkOperation (
BulkOperation
)Returns the current app's most recent BulkOperation.
-
customer (
Customer
)Returns a Customer resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Customer to return.
-
customerPaymentMethod (
CustomerPaymentMethod
)Returns a CustomerPaymentMethod resource by ID.
-
deliveryProfile (
DeliveryProfile
)Lookup a Delivery Profile by ID.
Argument Description id
(ID!
) requiredThe ID of the DeliveryProfile to return.
-
deliverySettings (
DeliverySetting
)The shop-wide shipping settings.
-
domain (
Domain
)Lookup a Domain by ID.
Argument Description id
(ID!
) requiredThe ID of the Domain to return.
-
draftOrder (
DraftOrder
)Returns a DraftOrder resource by ID.
Argument Description id
(ID!
) requiredThe ID of the DraftOrder to return.
-
fulfillment (
Fulfillment
)Returns a Fulfillment resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Fulfillment to return.
-
fulfillmentOrder (
FulfillmentOrder
)Returns a Fulfillment order resource by ID.
Argument Description id
(ID!
) requiredThe ID of the FulfillmentOrder to return.
-
fulfillmentService (
FulfillmentService
)Returns a FulfillmentService resource by ID.
Argument Description id
(ID!
) requiredThe ID of the FulfillmentService to return.
-
inventoryItem (
InventoryItem
)Returns an InventoryItem resource by ID.
Argument Description id
(ID!
) requiredThe ID of the InventoryItem to return.
-
inventoryLevel (
InventoryLevel
)Returns an InventoryLevel resource by ID.
Argument Description id
(ID!
) requiredThe ID of the InventoryLevel to return.
-
job (
Job
)Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Argument Description id
(ID!
) requiredID of the job to query.
-
location (
Location
)Returns an inventory Location resource by ID.
Argument Description id
(ID
)The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.
-
marketingActivity (
MarketingActivity
)Returns a MarketingActivity resource by ID.
Argument Description id
(ID!
) requiredThe ID of the MarketingActivity to return.
-
marketingEvent (
MarketingEvent
)Returns a MarketingEvent resource by ID.
Argument Description id
(ID!
) requiredThe ID of the MarketingEvent to return.
-
metafieldStorefrontVisibility (
MetafieldStorefrontVisibility
)Returns metafield storefront visibility by ID.
Argument Description id
(ID!
) requiredThe ID of the MetafieldStorefrontVisibility to return.
-
node (
Node
)Returns a specific node by ID.
Argument Description id
(ID!
) requiredThe ID of the Node to return.
-
nodes (
[Node]!
)Returns the list of nodes with the given IDs.
Argument Description ids
([ID!]!
) requiredThe IDs of the Nodes to return.
-
order (
Order
)Returns an Order resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Order to return.
-
priceRule (
PriceRule
)Lookup a price rule by ID.
Argument Description id
(ID!
) requiredThe ID of the PriceRule to return.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield by ID.
Argument Description id
(ID!
) requiredThe ID of the PrivateMetafield to return.
-
product (
Product
)Returns a Product resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Product to return.
-
productByHandle (
Product
)Return a product by its handle.
Argument Description handle
(String!
) requiredThe handle of the product.
-
productVariant (
ProductVariant
)Returns a ProductVariant resource by ID.
Argument Description id
(ID!
) requiredThe ID of the ProductVariant to return.
-
publicApiVersions (
[ApiVersion!]!
)The list of public Admin API versions, including supported, release candidate and unstable versions.
-
publication (
Publication
)Lookup a publication by ID.
Argument Description id
(ID!
) requiredThe ID of the Publication to return.
-
refund (
Refund
)Returns a Refund resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Refund to return.
-
scriptTag (
ScriptTag
)Lookup a script tag resource by ID.
Argument Description id
(ID!
) requiredThe ID of the ScriptTag to return.
-
sellingPlanGroup (
SellingPlanGroup
)Returns a Selling Plan Group resource by ID.
Argument Description id
(ID!
) requiredThe ID of the SellingPlanGroup to return.
-
shop (
Shop!
)Returns a Shop resource corresponding to access token used in request.
-
shopLocales (
[ShopLocale!]!
)List of locales available on a shop.
Argument Description published
(Boolean
)Return only published locales.
-
subscriptionBillingAttempt (
SubscriptionBillingAttempt
)Returns a SubscriptionBillingAttempt by ID.
Argument Description id
(ID!
) requiredThe ID of the SubscriptionBillingAttempt to return.
-
subscriptionContract (
SubscriptionContract
)Returns a Subscription Contract resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Subscription Contract to return.
-
subscriptionDraft (
SubscriptionDraft
)Returns a Subscription Draft resource by ID.
Argument Description id
(ID!
) requiredThe ID of the Subscription Draft to return.
-
translatableResource (
TranslatableResource
)Translatable resource.
Argument Description resourceId
(ID!
) requiredFind a translatable resource by ID.
-
webhookSubscription (
WebhookSubscription
)Returns a webhook subscription by ID.
Argument Description id
(ID!
) requiredThe ID of the WebhookSubscription to return.
Deprecated fields
-
automaticDiscount (
DiscountAutomatic
) deprecatedReturns an automatic discount resource by ID.
Deprecation warning
Use
automaticDiscountNode
insteadArgument Description id
(ID!
) requiredThe ID of the DiscountAutomatic to return.
-
automaticDiscounts (
DiscountAutomaticConnection!
) deprecatedList of automatic discounts.
Deprecation warning
Use
automaticDiscountNodes
insteadArgument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
status
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(AutomaticDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
channel (
Channel
) deprecatedLookup a channel by ID.
Deprecation warning
Use
publication
insteadArgument Description id
(ID!
) requiredThe ID of the Channel to return.
-
channels (
ChannelConnection!
) deprecatedList of the active sales channels.
Deprecation warning
Use
publications
insteadArgument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
locationsAvailableForDeliveryProfiles (
[Location!]
) deprecatedReturns a list of all origin locations available for a delivery profile.
Deprecation warning
Use
locationsAvailableForDeliveryProfilesConnection
instead
The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.
On this page
Connections
-
appInstallations (
AppInstallationConnection!
)List of app installations.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
category
(AppInstallationCategory
)The category of app installations to fetch.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.privacy
(AppInstallationPrivacy
)The privacy level of app installations to fetch.
Default value:PUBLIC
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(AppInstallationSortKeys
)Sort the underlying list by the given key.
Default value:INSTALLED_AT
-
automaticDiscountNodes (
DiscountAutomaticNodeConnection!
)List of automatic discounts.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
status
type
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(AutomaticDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
automaticDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's automatic discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
codeDiscountNodes (
DiscountCodeNodeConnection!
)List of code discounts. Special fields for query params:
- status: active, expired, scheduled
- discount_type: bogo, fixed_amount, free_shipping, percentage.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
created_at
discount_type
ends_at
starts_at
status
times_used
type
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CodeDiscountSortKeys
)Sort the underlying list by the given key.
Default value:CREATED_AT
-
codeDiscountSavedSearches (
SavedSearchConnection!
)List of the shop's code discount saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collectionSavedSearches (
SavedSearchConnection!
)List of the shop's collection saved searches.
Required access
read_products
access scope.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
collections (
CollectionConnection!
)List of collections.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
collection_type
publishable_status
published_status
title
updated_at
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(CollectionSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customerSavedSearches (
SavedSearchConnection!
)List of the shop's customer saved searches.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
name
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
sortKey
(CustomerSavedSearchSortKeys
)Sort the underlying list by the given key.
Default value:ID
-
customers (
CustomerConnection!
)List of customers.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.query
(String
)Supported filter parameters:
accepts_marketing
country
customer_date