Shop

Represents the shop object.

Show definition
# Represents the shop object.
type Shop implements Node, HasMetafields {
  # Globally unique identifier.
  id: ID!

  # The metafield associated with the resource.
  metafield(
    # Container for a set of metafields (maximum of 20 characters).
    namespace: String!

    # Identifier for the metafield (maximum of 30 characters).
    key: String!
  ): Metafield

  # A paginated list of metafields associated with the resource.
  metafields(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): MetafieldConnection!

  # Alert message that appears in the Shopify admin.
  alerts: [ShopAlert!]!

  # The token required to query the shop's reports.
  analyticsToken: String!

  # List of app installations on the shop.
  appInstallations(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: AppInstallationSortKeys = INSTALLED_AT

    # The category of app installations to fetch.
    category: AppInstallationCategory

    # The privacy level of app installations to fetch.
    privacy: AppInstallationPrivacy = PUBLIC
  ): AppInstallationConnection!

  # Return active app links on the shop.
  appLinks(
    # The type of the link resource to filter by.
    type: ResourceType!

    # The location of the link resource to filter by.
    location: ResourceLocation!

    # The ID of the link resource to filter by.
    resourceId: ID

    # Whether to include links which are in-context. By default they are excluded.
    includeInContext: Boolean
  ): [AppLink!]!

  # List of sales channels not currently installed on the shop.
  availableChannelApps(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): AppConnection!

  # Determine available template options for a shop.
  availableTemplateOptions(
    # The template resource type to filter by.
    resourceType: ShopTemplateResource!
  ): [String!]!

  # The shop's billing address information.
  billingAddress: MailingAddress!

  # List of channel app installations on the shop.
  channelAppInstallations(
    # 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 the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): SavedSearchConnection!

  # List of the shop's collections.
  collections(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: CollectionSortKeys = ID

    # Supported filter parameters:
    #  - `title`
    #  - `collection_type`
    #  - `updated_at`
    #  - `published_status`
    query: String

    # ID of an existing saved search.
    # The search’s query string will be used as the query argument.
    savedSearchId: ID
  ): CollectionConnection!

  # 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 shop's customer account requirement preference.
  customerAccounts: ShopCustomerAccountsSetting!

  # List of the shop's customer saved searches.
  customerSavedSearches(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: CustomerSavedSearchSortKeys = ID

    # Supported filter parameters:
    #  - `name`
    query: String
  ): 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: CustomerSortKeys = ID

    # Supported filter parameters:
    #  - `total_spent`
    #  - `orders_count`
    #  - `order_date`
    #  - `accepts_marketing`
    #  - `last_abandoned_order_date`
    #  - `state`
    #  - `country`
    #  - `email`
    #  - `phone`
    #  - `customer_date`
    #  - `updated_at`
    #  - `tag`
    query: String
  ): CustomerConnection!

  # The shop's meta description used in search engine results.
  description: String

  # List of the shop's draft order saved searches.
  draftOrderSavedSearches(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: DraftOrderSortKeys = ID

    # Supported filter parameters:
    #  - `status`
    #  - `updated_at`
    #  - `customer_id`
    #  - `created_at`
    #  - `tag`
    query: String
  ): DraftOrderConnection!

  # The shop's contact e-mail address.
  email: String!

  # 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!

  # List of apps that are installed on the shop.
  installedApps(
    # 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

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: AppsSortKeys = TITLE
  ): AppConnection!

  # List of the shop's inventory items.
  inventoryItems(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Supported filter parameters:
    #  - `id`
    #  - `sku`
    #  - `updated_at`
    #  - `created_at`
    query: String
  ): InventoryItemConnection!

  # List of active locations of the shop.
  locations(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: LocationSortKeys = NAME

    # Supported filter parameters:
    #  - `name`
    #  - `address1`
    #  - `address2`
    #  - `city`
    #  - `zip`
    #  - `province`
    #  - `country`
    #  - `active`
    #  - `legacy`
    query: String

    # If true, also include the legacy locations of fulfillment services.
    includeLegacy: Boolean = false

    # If true, also include the locations that are deactivated.
    includeInactive: Boolean = false
  ): LocationConnection!

  # Shop's marketing actions.
  marketingActions(
    # Resource type the marketing action will be used for.
    type: ResourceType!

    # Location where the marketing action will be used.
    location: ResourceLocation!

    # Resource ID of the item the marketing action is being used for.
    resourceId: ID
  ): [AppLink!]!

  # List of a shop's marketing activities.
  marketingEvents(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: MarketingEventSortKeys = ID

    # Supported filter parameters:
    #  - `description`
    #  - `started_at`
    #  - `type`
    #  - `app_id`
    query: String
  ): MarketingEventConnection!

  # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: OrderSortKeys = PROCESSED_AT

    # Supported filter parameters:
    #  - `status`
    #  - `financial_status`
    #  - `fulfillment_status`
    #  - `source_name`
    #  - `chargeback_status`
    #  - `risk_level`
    #  - `customer_id`
    #  - `email`
    #  - `credit_card_last4`
    #  - `processed_at`
    #  - `checkout_token`
    #  - `cart_token`
    #  - `location_id`
    #  - `channel_id`
    #  - `sales_channel`
    #  - `discount_code`
    #  - `test`
    #  - `fraud_protection_level`
    #  - `reference_location_id`
    #  - `tag`
    #  - `updated_at`
    #  - `created_at`
    query: String
  ): OrderConnection!

  # Settings related to payments.
  paymentSettings: PaymentSettings!

  # Number of pending orders on the shop.
  pendingOrderCount: Int!

  # Shop's POS links.
  posLinks(
    # The type of the link resource to filter by.
    type: PosLinkResourceType!

    # The location of the link resource to filter by.
    location: PosLinkResourceLocation!

    # The ID of the link resource to filter by.
    resourceId: ID
  ): [PosLink!]!

  # List of the shop's price rule saved searches.
  priceRuleSavedSearches(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): SavedSearchConnection!

  # List of the shop’s price rules.
  priceRules(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: PriceRuleSortKeys = ID

    # Supported filter parameters:
    #  - `starts_at`
    #  - `ends_at`
    #  - `status`
    #  - `discount_type`
    #  - `times_used`
    #  - `updated_at`
    #  - `created_at`
    query: String

    # ID of an existing saved search.
    # The search’s query string will be used as the query argument.
    savedSearchId: 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: ProductImageSortKeys = CREATED_AT

    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

    # Image height in pixels between 1 and 2048. This argument is deprecated: Use
    # `maxHeight` on `Image.transformedSrc` instead.
    maxHeight: Int

    # Crops the image according to the specified region. This argument is
    # deprecated: Use `crop` on `Image.transformedSrc` instead.
    crop: CropRegion

    # Image size multiplier for high-resolution retina displays. Must be between 1
    # and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.
    scale: Int = 1
  ): ImageConnection!

  # List of the shop's product saved searches.
  productSavedSearches(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: ProductVariantSortKeys = ID

    # Supported filter parameters:
    #  - `title`
    #  - `product_type`
    #  - `vendor`
    #  - `managed`
    #  - `managed_by`
    #  - `inventory_quantity`
    #  - `product_id`
    #  - `collection`
    #  - `gift_card`
    #  - `barcode`
    #  - `location_id`
    #  - `updated_at`
    #  - `sku`
    #  - `published_status`
    #  - `tag`
    query: String
  ): 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: ProductSortKeys = ID

    # Supported filter parameters:
    #  - `title`
    #  - `product_type`
    #  - `vendor`
    #  - `gift_card`
    #  - `sku`
    #  - `barcode`
    #  - `inventory_total`
    #  - `created_at`
    #  - `updated_at`
    #  - `out_of_stock_somewhere`
    #  - `published_status`
    #  - `tag`
    #  - `error_feedback`
    query: String

    # ID of an existing saved search.
    # The search’s query string will be used as the query argument.
    savedSearchId: ID
  ): ProductConnection!

  # Resource limits of a shop.
  resourceLimits: ShopResourceLimits!

  # The URL of the rich text editor.
  richTextEditorUrl: URL!

  # Return admin search results.
  search(
    # The search query to filter by.
    query: String!

    # The search result types to filter by.
    types: [SearchResultType!]

    # Returns up to the first `n` elements from the list.
    first: Int!

    # Returns the elements that come after the specified cursor.
    after: String
  ): 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # 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 offset.
  timezoneOffset: String!

  # The shop's time zone offset expressed in number of minutes.
  timezoneOffsetMinutes: Int!

  # All images uploaded to the shop.
  uploadedImages(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Sort the underlying list by the given key.
    sortKey: ShopImageSortKeys = CREATED_AT

    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

    # Image height in pixels between 1 and 2048. This argument is deprecated: Use
    # `maxHeight` on `Image.transformedSrc` instead.
    maxHeight: Int

    # Crops the image according to the specified region. This argument is
    # deprecated: Use `crop` on `Image.transformedSrc` instead.
    crop: CropRegion

    # Image size multiplier for high-resolution retina displays. Must be between 1
    # and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.
    scale: Int = 1
  ): 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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

collectionSavedSearches   (SavedSearchConnection!)

List of the shop's collection saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

customerSavedSearches   (SavedSearchConnection!)

List of the shop's customer saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • name
reverse Boolean false

Reverse the order of the underlying list.

sortKey CustomerSavedSearchSortKeys ID

Sort the underlying list by the given key.

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 n elements from the list.

draftOrderSavedSearches   (SavedSearchConnection!)

List of the shop's draft order saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

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 n elements from the list.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • description
  • started_at
  • type
  • app_id
reverse Boolean false

Reverse the order of the underlying list.

sortKey MarketingEventSortKeys ID

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

orderSavedSearches   (SavedSearchConnection!)

List of the shop's order saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

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 n elements from the list.

priceRuleSavedSearches   (SavedSearchConnection!)

List of the shop's price rule saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

productImages   (ImageConnection!)

All images of all products of 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.

crop CropRegion

Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

first Int

Returns up to the first n elements from the list.

last Int

Returns up to the last n elements from the list.

maxHeight Int

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

maxWidth Int

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

reverse Boolean false

Reverse the order of the underlying list.

scale Int 1

Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.

sortKey ProductImageSortKeys CREATED_AT

Sort the underlying list by the given key.

productSavedSearches   (SavedSearchConnection!)

List of the shop's product saved searches.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

productTags   (StringConnection!)

Tags added to products.

Required access

read_products access scope

Argument Type Default Description
first required Int!

Returns up to the first n elements from the list.

productTypes   (StringConnection!)

Types added to products.

Required access

read_products access scope

Argument Type Default Description
first required Int!

Returns up to the first n elements from the list.

productVendors   (StringConnection!)

Vendors added to products.

Required access

read_products access scope

Argument Type Default Description
first required Int!

Returns up to the first n elements from the list.

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 n elements from the list.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

uploadedImages   (ImageConnection!)

All images uploaded to 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.

crop CropRegion

Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

first Int

Returns up to the first n elements from the list.

last Int

Returns up to the last n elements from the list.

maxHeight Int

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

maxWidth Int

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

reverse Boolean false

Reverse the order of the underlying list.

scale Int 1

Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.

sortKey ShopImageSortKeys CREATED_AT

Sort the underlying list by the given key.

Fields

alerts   ([ShopAlert!]!)

Alert message that appears in the Shopify admin.

analyticsToken   (String!)

The token required to query the shop's reports.

Return active app links on the shop.

Argument Type Default Description
includeInContext Boolean

Whether to include links which are in-context. By default they are excluded.

location required ResourceLocation!

The location of the link resource to filter by.

resourceId ID

The ID of the link resource to filter by.

type required ResourceType!

The type of the link resource to filter by.

availableTemplateOptions   ([String!]!)

Determine available template options for a shop.

Argument Type Default Description
resourceType required ShopTemplateResource!

The template resource type to filter by.

billingAddress   (MailingAddress!)

The shop's billing address information.

channelCount   (Int!)

Exposes the number of channels.

checkoutApiSupported   (Boolean!)

Specifies whether the shop supports checkouts via Checkout API.

countriesInShippingZones   (CountriesInShippingZones!)

Countries that have been defined in shipping zones for the shop.

currencyCode   (CurrencyCode!)

The three letter code for the shop's currency.

customerAccounts   (ShopCustomerAccountsSetting!)

The shop's customer account requirement preference.

description   (String)

The shop's meta description used in search engine results.

email   (String!)

The shop's contact e-mail address.

features   (ShopFeatures!)

The shop's features.

fulfillmentServices   ([FulfillmentService!]!)

List of the shop's installed fulfillment services.

ianaTimezone   (String!)

The shop's time zone as defined by the IANA.

id   (ID!)

Globally unique identifier.

marketingActions   ([AppLink!]!)

Shop's marketing actions.

Argument Type Default Description
location required ResourceLocation!

Location where the marketing action will be used.

resourceId ID

Resource ID of the item the marketing action is being used for.

type required ResourceType!

Resource type the marketing action will be used for.

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).

myshopifyDomain   (String!)

The shop's .myshopify.com domain name.

name   (String!)

The shop's name.

The navigation settings of the shop.

paymentSettings   (PaymentSettings!)

Settings related to payments.

pendingOrderCount   (Int!)

Number of pending orders on the shop.

Required access

read_orders access scope

Shop's POS links.

Argument Type Default Description
location required PosLinkResourceLocation!

The location of the link resource to filter by.

resourceId ID

The ID of the link resource to filter by.

type required PosLinkResourceType!

The type of the link resource to filter by.

primaryDomain   (Domain!)

The shop's primary domain name.

resourceLimits   (ShopResourceLimits!)

Resource limits of a shop.

richTextEditorUrl   (URL!)

The URL of the rich text editor.

searchFilters   (SearchFilterOptions!)

List of search filter options.

setupRequired   (Boolean!)

Whether the shop has outstanding setup steps.

shipsToCountries   ([CountryCode!]!)

Countries that the shop ships to.

shopifyPaymentsAccount   (ShopifyPaymentsAccount)

Shopify Payments account information, including balances and payouts.

taxShipping   (Boolean!)

Specifies whether or not taxes are charged for shipping.

taxesIncluded   (Boolean!)

The setting for whether applicable taxes are included in product prices.

timezoneOffset   (String!)

The shop's time zone offset.

timezoneOffsetMinutes   (Int!)

The shop's time zone offset expressed in number of minutes.

url   (URL!)

The URL of the shop's storefront.

weightUnit   (WeightUnit!)

The shop's primary unit of weight for products and shipping.

Deprecated fields

Show/Hide

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

privacy AppInstallationPrivacy PUBLIC

The privacy level of app installations to fetch.

reverse Boolean false

Reverse the order of the underlying list.

sortKey AppInstallationSortKeys INSTALLED_AT

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 true

If true, don't include private channel app installations.

first Int

Returns up to the first n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

sortKey AppInstallationSortKeys INSTALLED_AT

Sort the underlying list by the given key.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

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.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • title
  • collection_type
  • updated_at
  • published_status
reverse Boolean false

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 ID

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • total_spent
  • orders_count
  • order_date
  • accepts_marketing
  • last_abandoned_order_date
  • state
  • country
  • email
  • phone
  • customer_date
  • updated_at
  • tag
reverse Boolean false

Reverse the order of the underlying list.

sortKey CustomerSortKeys ID

Sort the underlying list by the given key.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • status
  • updated_at
  • customer_id
  • created_at
  • tag
reverse Boolean false

Reverse the order of the underlying list.

sortKey DraftOrderSortKeys ID

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

reverse Boolean false

Reverse the order of the underlying list.

sortKey AppsSortKeys TITLE

Sort the underlying list by the given key.

visibleOnly Boolean true

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.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • id
  • sku
  • updated_at
  • created_at
reverse Boolean false

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 n elements from the list.

includeInactive Boolean false

If true, also include the locations that are deactivated.

includeLegacy Boolean false

If true, also include the legacy locations of fulfillment services.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • name
  • address1
  • address2
  • city
  • zip
  • province
  • country
  • active
  • legacy
reverse Boolean false

Reverse the order of the underlying list.

sortKey LocationSortKeys NAME

Sort the underlying list by the given key.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • status
  • financial_status
  • fulfillment_status
  • source_name
  • chargeback_status
  • risk_level
  • customer_id
  • email
  • credit_card_last4
  • processed_at
  • checkout_token
  • cart_token
  • location_id
  • channel_id
  • sales_channel
  • discount_code
  • test
  • fraud_protection_level
  • reference_location_id
  • tag
  • updated_at
  • created_at
reverse Boolean false

Reverse the order of the underlying list.

sortKey OrderSortKeys PROCESSED_AT

Sort the underlying list by the given key.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • starts_at
  • ends_at
  • status
  • discount_type
  • times_used
  • updated_at
  • created_at
reverse Boolean false

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 ID

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.

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • title
  • product_type
  • vendor
  • managed
  • managed_by
  • inventory_quantity
  • product_id
  • collection
  • gift_card
  • barcode
  • location_id
  • updated_at
  • sku
  • published_status
  • tag
reverse Boolean false

Reverse the order of the underlying list.

sortKey ProductVariantSortKeys ID

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 n elements from the list.

last Int

Returns up to the last n elements from the list.

query String

Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • sku
  • barcode
  • inventory_total
  • created_at
  • updated_at
  • out_of_stock_somewhere
  • published_status
  • tag
  • error_feedback
reverse Boolean false

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 ID

Sort the underlying list by the given key.

storefrontUrl   (URL!) deprecated

The URL of the shop's storefront.

Deprecation warning

Use url instead