QueryRoot

QueryRoot

The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

Connections

appInstallations ([AppInstallationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallationconnection))
List of app installations.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`category` ( `[AppInstallationCategory](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallationcategory)` )	The category of app installations to fetch.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`privacy` ( `[AppInstallationPrivacy](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallationprivacy)` )	The privacy level of app installations to fetch. Default value: `PUBLIC`
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[AppInstallationSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallationsortkeys)` )	Sort the underlying list by the given key. Default value: `INSTALLED_AT`

automaticDiscountNodes ([DiscountAutomaticNodeConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountautomaticnode))
List of automatic discounts.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `status` + `type` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[AutomaticDiscountSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/automaticdiscountsortkeys)` )	Sort the underlying list by the given key. Default value: `CREATED_AT`

automaticDiscountSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s automatic discount saved searches.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

codeDiscountNodes ([DiscountCodeNodeConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodenode))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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[CodeDiscountSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/codediscountsortkeys)` )	Sort the underlying list by the given key. Default value: `CREATED_AT`

codeDiscountSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s code discount saved searches.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

collectionSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s collection saved searches.
Required access
read_products access scope.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

collections ([CollectionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collection))
List of collections.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[CollectionSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

customerSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s customer saved searches.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `name` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[CustomerSavedSearchSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/customers/customersavedsearchsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

customers ([CustomerConnection!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
List of customers.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[CustomerSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/customers/customersortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

deletionEvents ([DeletionEventConnection!](https://shopify.dev/docs/admin-api/graphql/reference/events/deletioneventconnection))
The paginated list of deletion events.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `occurred_at` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[DeletionEventSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/events/deletioneventsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`
`subjectTypes` ( `[[DeletionEventSubjectType!]](https://shopify.dev/docs/admin-api/graphql/reference/events/deletioneventsubjecttype)` )	List of subject types to filter by.

deliveryProfiles ([DeliveryProfileConnection!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile))
List of saved delivery profiles.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`merchantOwnedOnly` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Only include delivery profiles that are created by the merchant.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

discountRedeemCodeSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s redeemed discount code saved searches.
Required access
read_discounts access scope.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `times_used` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[DiscountCodeSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodesortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

draftOrderSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s draft order saved searches.
Required access
read_draft_orders access scope.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

draftOrders ([DraftOrderConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder))
List of saved draft orders.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `created_at` + `customer_id` + `status` + `tag` + `updated_at` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[DraftOrderSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftordersortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

inventoryItems ([InventoryItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryitem))
List of inventory items.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `created_at` + `id` + `sku` + `updated_at` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

locations ([LocationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
List of active locations.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`includeInactive` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	If true, also include the locations that are deactivated. Default value: `false`
`includeLegacy` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	If true, also include the legacy locations of fulfillment services. Default value: `false`
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[LocationSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/locationsortkeys)` )	Sort the underlying list by the given key. Default value: `NAME`

locationsAvailableForDeliveryProfilesConnection ([LocationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
Returns a list of all origin locations available for a delivery profile.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

marketingActivities ([MarketingActivityConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivity))
List of a campaign’s marketing activities.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[MarketingActivitySortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivitysortkeys)` )	Sort the underlying list by the given key. Default value: `CREATED_AT`

marketingEvents ([MarketingEventConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
List of marketing events.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `app_id` + `description` + `started_at` + `type` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[MarketingEventSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingeventsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

metafieldStorefrontVisibilities ([MetafieldStorefrontVisibilityConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldstorefrontvisibilityconnection))
List of metafield namespaces and keys visible to the Storefront API.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`namespace` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Filter the metafields storefront whitelist by namespace.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

orderSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s order saved searches.
Required access
read_orders access scope.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

orders ([OrderConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
List of orders placed.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[OrderSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordersortkeys)` )	Sort the underlying list by the given key. Default value: `PROCESSED_AT`

priceRuleSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s price rule saved searches.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

priceRules ([PriceRuleConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/pricerule))
List of price rules.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[PriceRuleSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/pricerulesortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

privateMetafields ([PrivateMetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldconnection))
List of private metafields.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`namespace` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Filter the private metafields by namespace.
`owner` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	Retrieve the private metafields of a certain resource, specified by the resource ID.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

productSavedSearches ([SavedSearchConnection!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchconnection))
List of the shop’s product saved searches.
Required access
read_products access scope.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

productVariants ([ProductVariantConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
List of the product variants.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[ProductVariantSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariantsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

products ([ProductConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
List of products.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[ProductSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

publications ([PublicationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/apps/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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

scriptTags ([ScriptTagConnection!](https://shopify.dev/docs/admin-api/graphql/reference/online-store/scripttagconnection))
A list of script tags.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`src` ( `[URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)` )	The source URL of the script tag to filter by.

sellingPlanGroups ([SellingPlanGroupConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
List Selling Plan Groups.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `delivery_frequency` + `percentage_off` + `name` + `created_at` See the detailed search syntax.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[SellingPlanGroupSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroupsortkeys)` )	Sort the underlying list by the given key. Default value: `ID`

subscriptionContracts ([SubscriptionContractConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
List Subscription Contracts.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

tenderTransactions ([TenderTransactionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/tendertransaction))
List of TenderTransactions associated with the Shop.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `processed_at` + `test` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

translatableResources ([TranslatableResourceConnection!](https://shopify.dev/docs/admin-api/graphql/reference/translations/translatableresourceconnection))
List of translatable resources.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`resourceType` ( `[TranslatableResourceType!](https://shopify.dev/docs/admin-api/graphql/reference/translations/translatableresourcetype)` ) REQUIRED	Return only resources of a type.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

webhookSubscriptions ([WebhookSubscriptionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionconnection))
List of webhook subscriptions.

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`callbackUrl` ( `[URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)` )	Callback URL to filter by.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`format` ( `[WebhookSubscriptionFormat](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionformat)` )	Response format to filter by.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `created_at` + `updated_at` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`sortKey` ( `[WebhookSubscriptionSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionsortkeys)` )	Sort the underlying list by the given key. Default value: `CREATED_AT`
`topics` ( `[[WebhookSubscriptionTopic!]](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptiontopic)` )	List of webhook subscription topics to filter by.

Fields

app ([App](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
Lookup an App by ID or return the currently authenticated App.

Argument	Description
`id` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	The ID to lookup the App by.

appByHandle ([App](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
Fetches app by handle. Returns null if the app doesn’t exist.

Argument	Description
`handle` ( `[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` ) REQUIRED	Handle of the App.

appByKey ([App](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
Fetches app by apiKey. Returns null if the app doesn’t exist.

Argument	Description
`apiKey` ( `[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` ) REQUIRED	API key of the App.

appInstallation ([AppInstallation](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallation))
Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

Argument	Description
`id` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID used to lookup AppInstallation.

automaticDiscountNode ([DiscountAutomaticNode](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountautomaticnode))
Returns an automatic discount resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DiscountAutomaticNode to return.

availableCarrierServices ([[DeliveryCarrierServiceAndLocations!]!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliverycarrierserviceandlocations))
List of activated carrier services and which shop locations support them.

availableLocales ([[Locale!]!](https://shopify.dev/docs/admin-api/graphql/reference/translations/locale))
List of available locales.

carrierService ([DeliveryCarrierService](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliverycarrierservice))
Lookup a carrier service by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DeliveryCarrierService to return.

codeDiscountNode ([DiscountCodeNode](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodenode))
Returns a code discount resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DiscountCodeNode to return.

codeDiscountNodeByCode ([DiscountCodeNode](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcodenode))
Returns a code discount identified by its code.

Argument	Description
`code` ( `[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` ) REQUIRED	The code of the DiscountCodeNode to return.

collection ([Collection](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collection))
Returns a Collection resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Collection to return.

collectionByHandle ([Collection](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collection))
Return a collection by its handle.

Argument	Description
`handle` ( `[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` ) REQUIRED	The handle of the collection.

collectionRulesConditions ([[CollectionRuleConditions!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collectionruleconditions))
A list of rule conditions to define how collections with rules can be created.

currentAppInstallation ([AppInstallation!](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallation))
Return the AppInstallation for the currently authenticated App.

currentBulkOperation ([BulkOperation](https://shopify.dev/docs/admin-api/graphql/reference/bulk-operations/bulkoperation))
Returns the current app’s most recent BulkOperation.

customer ([Customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
Returns a Customer resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Customer to return.

customerPaymentMethod ([CustomerPaymentMethod](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod))
Returns a CustomerPaymentMethod resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the CustomerPaymentMethod to return.
`showRevoked` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Whether to show the customer’s revoked payment method. Default value: `false`

deliveryProfile ([DeliveryProfile](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliveryprofile))
Lookup a Delivery Profile by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DeliveryProfile to return.

deliverySettings ([DeliverySetting](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/deliverysetting))
The shop-wide shipping settings.

domain ([Domain](https://shopify.dev/docs/admin-api/graphql/reference/online-store/domain))
Lookup a Domain by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Domain to return.

draftOrder ([DraftOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder))
Returns a DraftOrder resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DraftOrder to return.

fulfillment ([Fulfillment](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment))
Returns a Fulfillment resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Fulfillment to return.

fulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
Returns a Fulfillment order resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the FulfillmentOrder to return.

fulfillmentService ([FulfillmentService](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentservice))
Returns a FulfillmentService resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the FulfillmentService to return.

inventoryItem ([InventoryItem](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryitem))
Returns an InventoryItem resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the InventoryItem to return.

inventoryLevel ([InventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel))
Returns an InventoryLevel resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the InventoryLevel to return.

job ([Job](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/job))
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	ID of the job to query.

location ([Location](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
Returns an inventory Location resource by ID.

Argument	Description
`id` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.

marketingActivity ([MarketingActivity](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivity))
Returns a MarketingActivity resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the MarketingActivity to return.

marketingEvent ([MarketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
Returns a MarketingEvent resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the MarketingEvent to return.

metafieldStorefrontVisibility ([MetafieldStorefrontVisibility](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldstorefrontvisibility))
Returns metafield storefront visibility by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the MetafieldStorefrontVisibility to return.

node ([Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node))
Returns a specific node by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Node to return.

nodes ([[Node]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node))
Returns the list of nodes with the given IDs.

Argument	Description
`ids` ( `[[ID!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The IDs of the Nodes to return.

order ([Order](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
Returns an Order resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Order to return.

priceRule ([PriceRule](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/pricerule))
Lookup a price rule by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the PriceRule to return.

privateMetafield ([PrivateMetafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafield))
Returns a private metafield by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the PrivateMetafield to return.

product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
Returns a Product resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Product to return.

productByHandle ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
Return a product by its handle.

Argument	Description
`handle` ( `[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` ) REQUIRED	The handle of the product.

productVariant ([ProductVariant](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant))
Returns a ProductVariant resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the ProductVariant to return.

publicApiVersions ([[ApiVersion!]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/apiversion))
The list of public Admin API versions, including supported, release candidate and unstable versions.

publication ([Publication](https://shopify.dev/docs/admin-api/graphql/reference/apps/publication))
Lookup a publication by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Publication to return.

refund ([Refund](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund))
Returns a Refund resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Refund to return.

scriptTag ([ScriptTag](https://shopify.dev/docs/admin-api/graphql/reference/online-store/scripttag))
Lookup a script tag resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the ScriptTag to return.

sellingPlanGroup ([SellingPlanGroup](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/sellingplangroup))
Returns a Selling Plan Group resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the SellingPlanGroup to return.

shop ([Shop!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shop))
Returns a Shop resource corresponding to access token used in request.

shopLocales ([[ShopLocale!]!](https://shopify.dev/docs/admin-api/graphql/reference/translations/shoplocale))
List of locales available on a shop.

Argument	Description
`published` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Return only published locales.

subscriptionBillingAttempt ([SubscriptionBillingAttempt](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt))
Returns a SubscriptionBillingAttempt by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the SubscriptionBillingAttempt to return.

subscriptionContract ([SubscriptionContract](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
Returns a Subscription Contract resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Subscription Contract to return.

subscriptionDraft ([SubscriptionDraft](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraft))
Returns a Subscription Draft resource by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Subscription Draft to return.

translatableResource ([TranslatableResource](https://shopify.dev/docs/admin-api/graphql/reference/translations/translatableresource))
Translatable resource.

Argument	Description
`resourceId` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	Find a translatable resource by ID.

webhookSubscription ([WebhookSubscription](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscription))
Returns a webhook subscription by ID.

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the WebhookSubscription to return.

Deprecated fields

automaticDiscount ([DiscountAutomatic](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountautomatic)) DEPRECATED
Returns an automatic discount resource by ID.

Deprecation warning
Use automaticDiscountNode instead

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the DiscountAutomatic to return.

automaticDiscounts ([DiscountAutomaticConnection!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountautomatic)) DEPRECATED
List of automatic discounts.

Deprecation warning
Use automaticDiscountNodes instead

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`query` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Supported filter parameters: + `status` + `type` See the detailed search syntax for more information about using filters.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`
`savedSearchId` ( `[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` )	ID of an existing saved search. The search’s query string is used as the query argument.
`sortKey` ( `[AutomaticDiscountSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/automaticdiscountsortkeys)` )	Sort the underlying list by the given key. Default value: `CREATED_AT`

channel ([Channel](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/channel)) DEPRECATED
Lookup a channel by ID.

Deprecation warning
Use publication instead

Argument	Description
`id` ( `[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)` ) REQUIRED	The ID of the Channel to return.

channels ([ChannelConnection!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/channel)) DEPRECATED
List of the active sales channels.

Deprecation warning
Use publications instead

Argument	Description
`after` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come after the specified cursor.
`before` ( `[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)` )	Returns the elements that come before the specified cursor.
`first` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the first `n` elements from the list.
`last` ( `[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)` )	Returns up to the last `n` elements from the list.
`reverse` ( `[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)` )	Reverse the order of the underlying list. Default value: `false`

locationsAvailableForDeliveryProfiles ([[Location!]](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location)) DEPRECATED
Returns a list of all origin locations available for a delivery profile.
Deprecation warning
Use locationsAvailableForDeliveryProfilesConnection instead

xshop开放API

QueryRoot

QueryRoot

On this page

Connections

Fields

Deprecated fields