Shop

Also in this section

Required access

unauthenticated_read_product_listings access scope

Shop represents a collection of the general settings and information about the shop.

Show definition

# Shop represents a collection of the general settings and information about the shop.
type Shop {
  # List of the shop' articles.
  articles(
    # 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:
    #  - `author`
    #  - `blog_title`
    #  - `created_at`
    #  - `tag`
    #  - `updated_at`
    #
    # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    query: String

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

    # Sort the underlying list by the given key.
    sortKey: ArticleSortKeys = ID
  ): ArticleConnection!

  # List of the shop' blogs.
  blogs(
    # 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`
    #  - `handle`
    #  - `title`
    #  - `updated_at`
    #
    # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    query: String

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

    # Sort the underlying list by the given key.
    sortKey: BlogSortKeys = ID
  ): BlogConnection!

  # The url pointing to the endpoint to vault credit cards.
  cardVaultUrl: URL!

  # Find a collection by its handle.
  collectionByHandle(
    # The handle of the collection.
    handle: String!
  ): Collection

  # 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`
    #  - `title`
    #  - `updated_at`
    #
    # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    query: String

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

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

  # The three-letter code for the currency that the shop accepts.
  currencyCode: CurrencyCode!

  # A description of the shop.
  description: String

  # A string representing the way currency is formatted when the currency isn’t specified.
  moneyFormat: String!

  # The shop’s name.
  name: String!

  # Settings related to payments.
  paymentSettings: PaymentSettings!

  # The shop’s primary domain.
  primaryDomain: Domain!

  # The shop’s privacy policy.
  privacyPolicy: ShopPolicy

  # Find a product by its handle.
  productByHandle(
    # The handle of the product.
    handle: String!
  ): Product

  # Tags added to products.
  # Additional access scope required: unauthenticated_read_product_tags.
  productTags(
    # Returns up to the first `n` elements from the list.
    first: Int!
  ): StringConnection!

  # List of the shop’s product types.
  productTypes(
    # 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:
    #  - `created_at`
    #  - `product_type`
    #  - `tag`
    #  - `title`
    #  - `updated_at`
    #  - `variants.price`
    #  - `vendor`
    #
    # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    query: String

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

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

  # The shop’s refund policy.
  refundPolicy: ShopPolicy

  # Countries that the shop ships to.
  shipsToCountries: [CountryCode!]!

  # The shop’s Shopify Payments account id.
  shopifyPaymentsAccountId: String

  # The shop’s terms of service.
  termsOfService: ShopPolicy
}

Connections

collections   (CollectionConnection!)

List of the shop’s collections.

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: collection_type title updated_at See the detailed search syntax.
reverse	Boolean	false	Reverse the order of the underlying list.
sortKey	CollectionSortKeys	ID	Sort the underlying list by the given key.

productTags   (StringConnection!)

Tags added to products. Additional access scope required: unauthenticated_read_product_tags.

Required access

unauthenticated_read_product_tags access scope

Argument	Type	Default	Description
first required	Int!		Returns up to the first n elements from the list.

productTypes   (StringConnection!)

List of the shop’s product types.

Required access

unauthenticated_read_product_listings access scope

Argument	Type	Default	Description
first required	Int!		Returns up to the first n elements from the list.

products   (ProductConnection!)

List of the shop’s 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: created_at product_type tag title updated_at variants.price vendor See the detailed search syntax.
reverse	Boolean	false	Reverse the order of the underlying list.
sortKey	ProductSortKeys	ID	Sort the underlying list by the given key.

Fields

collectionByHandle   (Collection)

Find a collection by its handle.

Argument	Type	Default	Description
handle required	String!		The handle of the collection.

description   (String)

A description of the shop.

moneyFormat   (String!)

A string representing the way currency is formatted when the currency isn’t specified.

name   (String!)

The shop’s name.

paymentSettings   (PaymentSettings!)

Settings related to payments.

primaryDomain   (Domain!)

The shop’s primary domain.

privacyPolicy   (ShopPolicy)

The shop’s privacy policy.

productByHandle   (Product)

Find a product by its handle.

Argument	Type	Default	Description
handle required	String!		The handle of the product.

refundPolicy   (ShopPolicy)

The shop’s refund policy.

shipsToCountries   ([CountryCode!]!)

Countries that the shop ships to.

termsOfService   (ShopPolicy)

The shop’s terms of service.

Deprecated fields

Show/Hide

articles   (ArticleConnection!)

deprecated

List of the shop' articles.

Deprecation warning

Use QueryRoot.articles 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: author blog_title created_at tag updated_at See the detailed search syntax.
reverse	Boolean	false	Reverse the order of the underlying list.
sortKey	ArticleSortKeys	ID	Sort the underlying list by the given key.

blogs   (BlogConnection!)

deprecated

List of the shop' blogs.

Deprecation warning

Use QueryRoot.blogs 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: created_at handle title updated_at See the detailed search syntax.
reverse	Boolean	false	Reverse the order of the underlying list.
sortKey	BlogSortKeys	ID	Sort the underlying list by the given key.

cardVaultUrl   (URL!)

deprecated

The url pointing to the endpoint to vault credit cards.

Deprecation warning

Use paymentSettings instead

currencyCode   (CurrencyCode!)

deprecated

The three-letter code for the currency that the shop accepts.

Deprecation warning

Use paymentSettings instead

shopifyPaymentsAccountId   (String)

deprecated

The shop’s Shopify Payments account id.

Deprecation warning

Use paymentSettings instead