Shop
Represents the shop object.
# Represents the shop object. type Shop implements HasMetafields & Node { # Alert message that appears in the Shopify admin. alerts: [ShopAlert!]!# The token required to query the shop's reports or dashboards. analyticsToken: String!
# List of app installations on the shop. appInstallations( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# The category of app installations to fetch. category: AppInstallationCategory
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# The privacy level of app installations to fetch. privacy: AppInstallationPrivacy = PUBLIC
# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: AppInstallationSortKeys = INSTALLED_AT ): AppInstallationConnection!
# List of sales channels not currently installed on the shop. availableChannelApps( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): AppConnection!
# The shop's billing address information. billingAddress: MailingAddress!
# List of channel app installations on the shop. channelAppInstallations( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# If true, don't include private channel app installations. excludePrivateApps: Boolean = true
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: AppInstallationSortKeys = INSTALLED_AT ): AppInstallationConnection!
# Exposes the number of channels. channelCount: Int!
# List of the shop's active sales channels. channels( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): ChannelConnection!
# Specifies whether the shop supports checkouts via Checkout API. checkoutApiSupported: Boolean!
# Return a collection by its handle. collectionByHandle( # The handle of the collection. handle: String! ): Collection
# List of the shop's collection saved searches. collectionSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): SavedSearchConnection!
# List of the shop's collections. collections( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
collection_type
# -published_status
# -title
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# ID of an existing saved search. # The search’s query string will be used as the query argument. savedSearchId: ID
# Sort the underlying list by the given key. sortKey: CollectionSortKeys = ID ): CollectionConnection!
# The contact email used for communication between the shop owner and the customer. contactEmail: String!
# Countries that have been defined in shipping zones for the shop. countriesInShippingZones: CountriesInShippingZones!
# The three letter code for the shop's currency. currencyCode: CurrencyCode!
# The currency settings for the shop. currencySettings( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): CurrencySettingConnection!
# The shop's customer account requirement preference. customerAccounts: ShopCustomerAccountsSetting!
# List of the shop's customer saved searches. customerSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
name
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: CustomerSavedSearchSortKeys = ID ): SavedSearchConnection!
# Tags added to customer accounts. customerTags( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# Customer accounts associated to the shop. customers( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
accepts_marketing
# -country
# -customer_date
# -last_abandoned_order_date
# -order_date
# -orders_count
# -phone
# -state
# -tag
# -total_spent
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: CustomerSortKeys = ID ): CustomerConnection!
# The shop's meta description used in search engine results. description: String
# List of the shop's draft order saved searches. draftOrderSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): SavedSearchConnection!
# Tags added to draft orders. draftOrderTags( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# List of saved draft orders on the shop. draftOrders( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
created_at
# -customer_id
# -status
# -tag
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: DraftOrderSortKeys = ID ): DraftOrderConnection!
# The shop's contact e-mail address. email: String!
# The presentment currencies enabled for the shop. enabledPresentmentCurrencies: [CurrencyCode!]!
# The shop's features. features: ShopFeatures!
# List of the shop's installed fulfillment services. fulfillmentServices: [FulfillmentService!]!
# The shop's time zone as defined by the IANA. ianaTimezone: String!
# Globally unique identifier. id: ID!
# List of apps that are installed on the shop. installedApps( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: AppsSortKeys = TITLE
# Whether or not to only return visible apps. By default, only visible apps are returned. # Visible apps are ones which can be seen on the installed apps page. # To return any installed app (including non-visible ones), set this to
false
. visibleOnly: Boolean = true ): AppConnection!# List of the shop's inventory items. inventoryItems( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
created_at
# -id
# -sku
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false ): InventoryItemConnection!
# The number of pendings orders on the shop. # Limited to a maximum of 10000. limitedPendingOrderCount: LimitedPendingOrderCount!
# List of active locations of the shop. locations( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# If true, also include the locations that are deactivated. includeInactive: Boolean = false
# If true, also include the legacy locations of fulfillment services. includeLegacy: Boolean = false
# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
active
# -address1
# -address2
# -city
# -country
# -legacy
# -name
# -province
# -zip
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: LocationSortKeys = NAME ): LocationConnection!
# List of a shop's marketing activities. marketingEvents( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
app_id
# -description
# -started_at
# -type
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: MarketingEventSortKeys = ID ): MarketingEventConnection!
# The metafield associated with the resource. metafield( # Identifier for the metafield (maximum of 30 characters). key: String!
# Container for a set of metafields (maximum of 20 characters). namespace: String! ): Metafield
# A paginated list of metafields associated with the resource. metafields( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Finds all metafields with a specific namespace under the resource. namespace: String
# Reverse the order of the underlying list. reverse: Boolean = false ): MetafieldConnection!
# The shop's .myshopify.com domain name. myshopifyDomain: String!
# The shop's name. name: String!
# The navigation settings of the shop. navigationSettings: [NavigationItem!]!
# List of the shop's order saved searches. orderSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): SavedSearchConnection!
# Tags added to orders. orderTags( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# List of orders placed on the shop. orders( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
cart_token
# -channel_id
# -chargeback_status
# -checkout_token
# -created_at
# -credit_card_last4
# -customer_id
# -discount_code
# -financial_status
# -fraud_protection_level
# -fulfillment_status
# -location_id
# -processed_at
# -reference_location_id
# -risk_level
# -sales_channel
# -source_name
# -status
# -tag
# -test
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: OrderSortKeys = PROCESSED_AT ): OrderConnection!
# Settings related to payments. paymentSettings: PaymentSettings!
# Number of pending orders on the shop. pendingOrderCount: Int!
# The shop's plan. plan: ShopPlan!
# List of the shop's price rule saved searches. priceRuleSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): SavedSearchConnection!
# List of the shop’s price rules. priceRules( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
created_at
# -discount_type
# -ends_at
# -starts_at
# -status
# -times_used
# -updated_at
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# ID of an existing saved search. # The search’s query string will be used as the query argument. savedSearchId: ID
# Sort the underlying list by the given key. sortKey: PriceRuleSortKeys = ID ): PriceRuleConnection!
# The shop's primary domain name. primaryDomain: Domain!
# Return a product by its handle. productByHandle( # The handle of the product. handle: String! ): Product
# All images of all products of the shop. productImages( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Crops the image according to the specified region. This argument is # deprecated: Use
crop
onImage.transformedSrc
instead. crop: CropRegion# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Image height in pixels between 1 and 2048. This argument is deprecated: Use #
maxHeight
onImage.transformedSrc
instead. maxHeight: Int# Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead. maxWidth: Int# Reverse the order of the underlying list. reverse: Boolean = false
# Image size multiplier for high-resolution retina displays. Must be between 1 # and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead. scale: Int = 1# Sort the underlying list by the given key. sortKey: ProductImageSortKeys = CREATED_AT ): ImageConnection!
# List of the shop's product saved searches. productSavedSearches( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): SavedSearchConnection!
# Tags added to products. productTags( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# Types added to products. productTypes( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# List of the shop's product variants. productVariants( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
barcode
# -collection
# -gift_card
# -inventory_quantity
# -location_id
# -managed
# -managed_by
# -product_id
# -product_type
# -published_status
# -sku
# -tag
# -taxable
# -title
# -updated_at
# -vendor
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# Sort the underlying list by the given key. sortKey: ProductVariantSortKeys = ID ): ProductVariantConnection!
# Vendors added to products. productVendors( # Returns up to the first
n
elements from the list. first: Int! ): StringConnection!# List of the shop's products. products( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Supported filter parameters: # -
barcode
# -created_at
# -delivery_profile_id
# -error_feedback
# -gift_card
# -inventory_total
# -out_of_stock_somewhere
# -product_type
# -published_status
# -sku
# -tag
# -title
# -updated_at
# -vendor
# # See the detailed search syntax. query: String# Reverse the order of the underlying list. reverse: Boolean = false
# ID of an existing saved search. # The search’s query string will be used as the query argument. savedSearchId: ID
# Sort the underlying list by the given key. sortKey: ProductSortKeys = ID ): ProductConnection!
# Exposes the number of publications. publicationCount: Int!
# Resource limits of a shop. resourceLimits: ShopResourceLimits!
# The URL of the rich text editor. richTextEditorUrl: URL!
# Return admin search results. search( # Returns the elements that come after the specified cursor. after: String
# Returns up to the first
n
elements from the list. first: Int!# The search query to filter by. query: String!
# The search result types to filter by. types: [SearchResultType!] ): SearchResultConnection!
# List of search filter options. searchFilters: SearchFilterOptions!
# Whether the shop has outstanding setup steps. setupRequired: Boolean!
# Countries that the shop ships to. shipsToCountries: [CountryCode!]!
# Shopify Payments account information, including balances and payouts. shopifyPaymentsAccount: ShopifyPaymentsAccount
# Storefront access token of a private application. Scoped per-application. storefrontAccessTokens( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Reverse the order of the underlying list. reverse: Boolean = false ): StorefrontAccessTokenConnection!
# The URL of the shop's storefront. storefrontUrl: URL!
# Specifies whether or not taxes are charged for shipping. taxShipping: Boolean!
# The setting for whether applicable taxes are included in product prices. taxesIncluded: Boolean!
# The shop's time zone abbreviation. timezoneAbbreviation: String!
# The shop's time zone offset. timezoneOffset: String!
# The shop's time zone offset expressed in number of minutes. timezoneOffsetMinutes: Int!
# All images uploaded to the shop. uploadedImages( # Returns the elements that come after the specified cursor. after: String
# Returns the elements that come before the specified cursor. before: String
# Crops the image according to the specified region. This argument is # deprecated: Use
crop
onImage.transformedSrc
instead. crop: CropRegion# Returns up to the first
n
elements from the list. first: Int# Returns up to the last
n
elements from the list. last: Int# Image height in pixels between 1 and 2048. This argument is deprecated: Use #
maxHeight
onImage.transformedSrc
instead. maxHeight: Int# Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead. maxWidth: Int# Reverse the order of the underlying list. reverse: Boolean = false
# Image size multiplier for high-resolution retina displays. Must be between 1 # and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead. scale: Int = 1# Sort the underlying list by the given key. sortKey: ShopImageSortKeys = CREATED_AT ): ImageConnection!
# The URL of the shop's storefront. url: URL!
# The shop's primary unit of weight for products and shipping. weightUnit: WeightUnit! }
Implements
Connections
availableChannelApps
(AppConnection!
)
List of sales channels not currently installed on the shop.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
currencySettings
(CurrencySettingConnection!
)
The currency settings for the shop.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
customerTags
(StringConnection!
)
Tags added to customer accounts.
Required access
read_customers
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
draftOrderTags
(StringConnection!
)
Tags added to draft orders.
Required access
read_draft_orders
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
marketingEvents
(MarketingEventConnection!
)
List of a shop's marketing activities.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
MarketingEventSortKeys
|
|
Sort the underlying list by the given key. |
metafields
(MetafieldConnection!
)
A paginated list of metafields associated with the resource.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
namespace
|
String
|
|
Finds all metafields with a specific namespace under the resource. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
orderTags
(StringConnection!
)
Tags added to orders.
Required access
read_orders
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
productImages
(ImageConnection!
)
All images of all products of the shop.
Required access
read_products
access scope
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
crop
|
CropRegion
|
|
Crops the image according to the specified region. This argument is deprecated: Use |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
maxHeight
|
Int
|
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
|
Int
|
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
scale
|
Int
|
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
sortKey
|
ProductImageSortKeys
|
|
Sort the underlying list by the given key. |
productTags
(StringConnection!
)
Tags added to products.
Required access
read_products
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
productTypes
(StringConnection!
)
Types added to products.
Required access
read_products
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
productVendors
(StringConnection!
)
Vendors added to products.
Required access
read_products
access scope
Argument | Type | Default | Description |
---|---|---|---|
first required
|
Int!
|
|
Returns up to the first |
search
(SearchResultConnection!
)
Return admin search results.
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
first required
|
Int!
|
|
Returns up to the first |
query required
|
String!
|
|
The search query to filter by. |
types
|
[SearchResultType!]
|
|
The search result types to filter by. |
storefrontAccessTokens
(StorefrontAccessTokenConnection!
)
Storefront access token of a private application. Scoped per-application.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
uploadedImages
(ImageConnection!
)
All images uploaded to the shop.
Required access
read_images
access scope
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
crop
|
CropRegion
|
|
Crops the image according to the specified region. This argument is deprecated: Use |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
maxHeight
|
Int
|
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
|
Int
|
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
scale
|
Int
|
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
sortKey
|
ShopImageSortKeys
|
|
Sort the underlying list by the given key. |
Fields
contactEmail
(String!
)
The contact email used for communication between the shop owner and the customer.
countriesInShippingZones
(CountriesInShippingZones!
)
Countries that have been defined in shipping zones for the shop.
limitedPendingOrderCount
(LimitedPendingOrderCount!
)
The number of pendings orders on the shop. Limited to a maximum of 10000.
metafield
(Metafield
)
The metafield associated with the resource.
Argument | Type | Default | Description |
---|---|---|---|
key required
|
String!
|
|
Identifier for the metafield (maximum of 30 characters). |
namespace required
|
String!
|
|
Container for a set of metafields (maximum of 20 characters). |
Deprecated fields
appInstallations
(AppInstallationConnection!
)
deprecated
List of app installations on the shop.
Deprecation warning
Use QueryRoot.appInstallations
instead.
Required access
read_apps
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
privacy
|
AppInstallationPrivacy
|
|
The privacy level of app installations to fetch. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
AppInstallationSortKeys
|
|
Sort the underlying list by the given key. |
channelAppInstallations
(AppInstallationConnection!
)
deprecated
List of channel app installations on the shop.
Deprecation warning
Use appInstallations
instead
Required access
read_apps
access scope
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
excludePrivateApps
|
Boolean
|
|
If true, don't include private channel app installations. |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
AppInstallationSortKeys
|
|
Sort the underlying list by the given key. |
channelCount
(Int!
)
deprecated
Exposes the number of channels.
Deprecation warning
Use publicationCount
instead
channels
(ChannelConnection!
)
deprecated
List of the shop's active sales channels.
Deprecation warning
Use QueryRoot.channels
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
collectionByHandle
(Collection
)
deprecated
Return a collection by its handle.
Deprecation warning
Use QueryRoot.collectionByHandle
instead.
Argument | Type | Default | Description |
---|---|---|---|
handle required
|
String!
|
|
The handle of the collection. |
collectionSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's collection saved searches.
Deprecation warning
Use QueryRoot.priceRuleSavedSearches
instead.
Required access
read_products
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
collections
(CollectionConnection!
)
deprecated
List of the shop's collections.
Deprecation warning
Use QueryRoot.collections
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
savedSearchId
|
ID
|
|
ID of an existing saved search. The search’s query string will be used as the query argument. |
sortKey
|
CollectionSortKeys
|
|
Sort the underlying list by the given key. |
customerSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's customer saved searches.
Deprecation warning
Use QueryRoot.customerSavedSearches
instead.
Required access
read_customers
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
CustomerSavedSearchSortKeys
|
|
Sort the underlying list by the given key. |
customers
(CustomerConnection!
)
deprecated
Customer accounts associated to the shop.
Deprecation warning
Use QueryRoot.customers
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
CustomerSortKeys
|
|
Sort the underlying list by the given key. |
draftOrderSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's draft order saved searches.
Deprecation warning
Use QueryRoot.draftOrderSavedSearches
instead.
Required access
read_draft_orders
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
draftOrders
(DraftOrderConnection!
)
deprecated
List of saved draft orders on the shop.
Deprecation warning
Use QueryRoot.draftOrders
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
DraftOrderSortKeys
|
|
Sort the underlying list by the given key. |
installedApps
(AppConnection!
)
deprecated
List of apps that are installed on the shop.
Deprecation warning
Use appInstallations
instead
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
AppsSortKeys
|
|
Sort the underlying list by the given key. |
visibleOnly
|
Boolean
|
|
Whether or not to only return visible apps. By default, only visible apps are returned.
Visible apps are ones which can be seen on the installed apps page.
To return any installed app (including non-visible ones), set this to |
inventoryItems
(InventoryItemConnection!
)
deprecated
List of the shop's inventory items.
Deprecation warning
Use QueryRoot.inventoryItems
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
locations
(LocationConnection!
)
deprecated
List of active locations of the shop.
Deprecation warning
Use QueryRoot.locations
instead.
Argument | Type | Default | 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 |
includeInactive
|
Boolean
|
|
If true, also include the locations that are deactivated. |
includeLegacy
|
Boolean
|
|
If true, also include the legacy locations of fulfillment services. |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
LocationSortKeys
|
|
Sort the underlying list by the given key. |
orderSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's order saved searches.
Deprecation warning
Use QueryRoot.orderSavedSearches
instead.
Required access
read_orders
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
orders
(OrderConnection!
)
deprecated
List of orders placed on the shop.
Deprecation warning
Use QueryRoot.orders
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
OrderSortKeys
|
|
Sort the underlying list by the given key. |
pendingOrderCount
(Int!
)
deprecated
Number of pending orders on the shop.
Deprecation warning
Use limitedPendingOrderCount
instead
Required access
read_orders
access scope
priceRuleSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's price rule saved searches.
Deprecation warning
Use QueryRoot.priceRuleSavedSearches
instead.
Required access
read_price_rules
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
priceRules
(PriceRuleConnection!
)
deprecated
List of the shop’s price rules.
Deprecation warning
Use QueryRoot.priceRules
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
savedSearchId
|
ID
|
|
ID of an existing saved search. The search’s query string will be used as the query argument. |
sortKey
|
PriceRuleSortKeys
|
|
Sort the underlying list by the given key. |
productByHandle
(Product
)
deprecated
Return a product by its handle.
Deprecation warning
Use QueryRoot.productByHandle
instead.
Argument | Type | Default | Description |
---|---|---|---|
handle required
|
String!
|
|
The handle of the product. |
productSavedSearches
(SavedSearchConnection!
)
deprecated
List of the shop's product saved searches.
Deprecation warning
Use QueryRoot.productSavedSearches
instead.
Required access
read_products
access scope
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
productVariants
(ProductVariantConnection!
)
deprecated
List of the shop's product variants.
Deprecation warning
Use QueryRoot.productVariants
instead.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
ProductVariantSortKeys
|
|
Sort the underlying list by the given key. |
products
(ProductConnection!
)
deprecated
List of the shop's products.
Deprecation warning
Use QueryRoot.products
.
Argument | Type | Default | 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 |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
savedSearchId
|
ID
|
|
ID of an existing saved search. The search’s query string will be used as the query argument. |
sortKey
|
ProductSortKeys
|
|
Sort the underlying list by the given key. |
shopifyPaymentsAccount
(ShopifyPaymentsAccount
)
deprecated
Shopify Payments account information, including balances and payouts.
Deprecation warning
Use QueryRoot.shopifyPaymentsAccount
instead.
storefrontUrl
(URL!
)
deprecated
The URL of the shop's storefront.
Deprecation warning
Use url
instead