Shop object

Represents the shop object.

Connections

• assignedFulfillmentOrders (FulfillmentOrderConnection!)

  Paginated list of fulfillment orders assigned to fulfillment services.

  Required access

  read_assigned_fulfillment_orders access scope.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  assignmentStatus ( FulfillmentOrderAssignmentStatus )	The assigment status of the fulfillment orders that should be returned.
  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.
  locationIds ( [ID!] )	Returns fulfillment orders only for certain locations, specified by a list of location IDs.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( FulfillmentOrderSortKeys )	Sort the underlying list by the given key. Default value: ID

• availableChannelApps (AppConnection!)

  List of sales channels not currently installed on the shop.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• currencySettings (CurrencySettingConnection!)

  The currency settings for the shop.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• customerTags (StringConnection!)

  A list of tags that have been added to customer accounts.

  Required access

  read_customers access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.

• draftOrderTags (StringConnection!)

  A list of tags that have been added to draft orders.

  Required access

  read_draft_orders access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.

• fulfillmentOrders (FulfillmentOrderConnection!)

  Paginated list of merchant-managed and third-party fulfillment orders.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  includeClosed ( Boolean )	Whether to include closed fulfillment orders. Default value: false
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: assigned_location_id status See the detailed search syntax.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( FulfillmentOrderSortKeys )	Sort the underlying list by the given key. Default value: ID

• metafields (MetafieldConnection!)

  A paginated list of metafields associated with the resource.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  namespace ( String )	Finds all metafields with a specific namespace under the resource.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• orderTags (StringConnection!)

  A list of tags that have been added to orders.

  Required access

  read_orders access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.
  sort ( ShopTagSort )	Sort type. Default value: ALPHABETICAL

• privateMetafields (PrivateMetafieldConnection!)

  List of private metafields.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  namespace ( String )	Filter the private metafields by namespace.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• productImages (ImageConnection!)

  All images of all products of the shop.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  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 )	Reverse the order of the underlying list. Default value: false
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1
  sortKey ( ProductImageSortKeys )	Sort the underlying list by the given key. Default value: CREATED_AT

• productTags (StringConnection!)

  A list of tags that have been added to products.

  Required access

  read_products access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.

• productTypes (StringConnection!)

  Types added to products.

  Required access

  read_products access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.

• productVendors (StringConnection!)

  Vendors added to products.

  Required access

  read_products access scope.

  Argument	Description
  first ( Int! ) required	Returns up to the first n elements from the list.

• search (SearchResultConnection!)

  Return admin search results.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  first ( Int! ) required	Returns up to the first n elements from the list.
  query ( String! ) required	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	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• uploadedImages (ImageConnection!)

  All images uploaded to the shop.

  Required access

  read_images access scope.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  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 )	Reverse the order of the underlying list. Default value: false
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1
  sortKey ( ShopImageSortKeys )	Sort the underlying list by the given key. Default value: CREATED_AT

Fields

• alerts ([ShopAlert!]!)

  Alert message that appears in the Shopify admin.

• analyticsToken (String!)

  The token required to query the shop's reports or dashboards.

• billingAddress (MailingAddress!)

  The shop's billing address information.

• checkoutApiSupported (Boolean!)

  Specifies whether the shop supports checkouts via Checkout API.

• contactEmail (String!)

  The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.

• countriesInShippingZones (CountriesInShippingZones!)

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

• currencyCode (CurrencyCode!)

  The three letter code for the shop's currency.

• currencyFormats (CurrencyFormats!)

  How currencies are displayed on your store.

• customerAccounts (ShopCustomerAccountsSetting!)

  The shop's customer account requirement preference.

• description (String)

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

• domains ([Domain!]!)

  The domains configured for the shop.

• email (String!)

  The shop owner's email address. Shopify will use this email address to communicate with the shop owner.

• enabledPresentmentCurrencies ([CurrencyCode!]!)

  The presentment currencies enabled for the shop.

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

• 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	Description
  key ( String! ) required	Identifier for the metafield (maximum of 30 characters).
  namespace ( String! ) required	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.

• navigationSettings ([NavigationItem!]!)

  The navigation settings of the shop.

• orderNumberFormatPrefix (String!)

  The prefix that appears before order numbers.

• orderNumberFormatSuffix (String!)

  The suffix that appears after order numbers.

• paymentSettings (PaymentSettings!)

  Settings related to payments.

• plan (ShopPlan!)

  The shop's plan.

• primaryDomain (Domain!)

  The shop's primary domain name.

• privateMetafield (PrivateMetafield)

  Returns a private metafield found by namespace and key.

  Argument	Description
  key ( String! ) required	The key for the private metafield.
  namespace ( String! ) required	The namespace for the private metafield.

• publicationCount (Int!)

  Exposes the number of publications.

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

• shopPolicies ([ShopPolicy!]!)

  A list of all policies associated with a shop.

• taxShipping (Boolean!)

  Specifies whether or not taxes are charged for shipping.

• taxesIncluded (Boolean!)

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

• timezoneAbbreviation (String!)

  The shop's time zone abbreviation.

• timezoneOffset (String!)

  The shop's time zone offset.

• timezoneOffsetMinutes (Int!)

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

• translations ([PublishedTranslation!]!)

  The translations associated with the resource.

  Argument	Description
  locale ( String! ) required	Filters translations locale.

• unitSystem (UnitSystem!)

  The shop's unit system.

• uploadedImagesByIds ([Image!]!)

  Fetch list of images uploaded to shop by ids.

  Required access

  read_images access scope.

  Argument	Description
  imageIds ( [ID!]! ) required	The ids of uploaded images.

• url (URL!)

  The URL of the shop's storefront.

• weightUnit (WeightUnit!)

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

Types that return Shop

• QueryRoot.shop

Implements

• HasMetafields
• HasPublishedTranslations
• Node

Deprecated fields

• 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	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• collectionByHandle (Collection) deprecated

  Return a collection by its handle.

  Deprecation warning

  Use QueryRoot.collectionByHandle instead.

  Argument	Description
  handle ( String! ) required	The handle of the collection.

• collectionSavedSearches (SavedSearchConnection!) deprecated

  List of the shop's collection saved searches.

  Deprecation warning

  Use QueryRoot.collectionSavedSearches instead.

  Required access

  read_products access scope.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• collections (CollectionConnection!) deprecated

  List of the shop's collections.

  Deprecation warning

  Use QueryRoot.collections instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: collection_type publishable_status published_status title updated_at See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  savedSearchId ( ID )	ID of an existing saved search. The search’s query string is used as the query argument.
  sortKey ( CollectionSortKeys )	Sort the underlying list by the given key. Default value: ID

• customerSavedSearches (SavedSearchConnection!) deprecated

  List of the shop's customer saved searches.

  Deprecation warning

  Use QueryRoot.customerSavedSearches instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: name See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( CustomerSavedSearchSortKeys )	Sort the underlying list by the given key. Default value: ID

• customers (CustomerConnection!) deprecated

  Customer accounts associated to the shop.

  Deprecation warning

  Use QueryRoot.customers instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: accepts_marketing country customer_date email last_abandoned_order_date order_date orders_count phone state tag total_spent updated_at See the detailed search syntax.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( CustomerSortKeys )	Sort the underlying list by the given key. Default value: ID

• 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	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• draftOrders (DraftOrderConnection!) deprecated

  List of saved draft orders on the shop.

  Deprecation warning

  Use QueryRoot.draftOrders instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: created_at customer_id status tag updated_at See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( DraftOrderSortKeys )	Sort the underlying list by the given key. Default value: ID

• inventoryItems (InventoryItemConnection!) deprecated

  List of the shop's inventory items.

  Deprecation warning

  Use QueryRoot.inventoryItems instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: created_at id sku updated_at See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• locations (LocationConnection!) deprecated

  List of active locations of the shop.

  Deprecation warning

  Use QueryRoot.locations instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  includeInactive ( Boolean )	If true, also include the locations that are deactivated. Default value: false
  includeLegacy ( Boolean )	If true, also include the legacy locations of fulfillment services. Default value: false
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: active address1 address2 city country legacy name province zip See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( LocationSortKeys )	Sort the underlying list by the given key. Default value: NAME

• marketingEvents (MarketingEventConnection!) deprecated

  List of a shop's marketing events.

  Deprecation warning

  Use QueryRoot.marketingEvents instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: app_id description started_at type See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( MarketingEventSortKeys )	Sort the underlying list by the given key. Default value: ID

• orderSavedSearches (SavedSearchConnection!) deprecated

  List of the shop's order saved searches.

  Deprecation warning

  Use QueryRoot.orderSavedSearches instead.

  Required access

  read_orders access scope.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• orders (OrderConnection!) deprecated

  List of orders placed on the shop.

  Deprecation warning

  Use QueryRoot.orders instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: cart_token channel_id chargeback_status checkout_token created_at credit_card_last4 customer_id delivery_method discount_code email financial_status fraud_protection_level fulfillment_location_id fulfillment_status location_id name processed_at reference_location_id return_status risk_level sales_channel source_identifier source_name status tag test updated_at See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( OrderSortKeys )	Sort the underlying list by the given key. Default value: PROCESSED_AT

• 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	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• priceRules (PriceRuleConnection!) deprecated

  List of the shop’s price rules.

  Deprecation warning

  Use QueryRoot.priceRules instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: created_at discount_type ends_at starts_at status times_used updated_at See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  savedSearchId ( ID )	ID of an existing saved search. The search’s query string is used as the query argument.
  sortKey ( PriceRuleSortKeys )	Sort the underlying list by the given key. Default value: ID

• productByHandle (Product) deprecated

  Return a product by its handle.

  Deprecation warning

  Use QueryRoot.productByHandle instead.

  Argument	Description
  handle ( String! ) required	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	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• productVariants (ProductVariantConnection!) deprecated

  List of the shop's product variants.

  Deprecation warning

  Use QueryRoot.productVariants instead.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: barcode collection delivery_profile_id gift_card inventory_quantity location_id managed managed_by product_id product_status product_type publishable_status published_status sku tag taxable title updated_at vendor See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductVariantSortKeys )	Sort the underlying list by the given key. Default value: ID

• products (ProductConnection!) deprecated

  List of the shop's products.

  Deprecation warning

  Use QueryRoot.products.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  query ( String )	Supported filter parameters: barcode created_at delivery_profile_id error_feedback gift_card inventory_total is_price_reduced out_of_stock_somewhere price product_type publishable_status published_status sku status tag title updated_at vendor See the detailed search syntax for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  savedSearchId ( ID )	ID of an existing saved search. The search’s query string is used as the query argument.
  sortKey ( ProductSortKeys )	Sort the underlying list by the given key. Default value: ID

• 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