Shop

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 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: ArticleSortKeys = ID

    # Supported filter parameters:
    #  - `author`
    #  - `updated_at`
    #  - `created_at`
    #  - `blog_title`
    #  - `tag`
    query: String
  ): ArticleConnection!

  # List of the shop' blogs.
  blogs(
    # 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: BlogSortKeys = ID

    # Supported filter parameters:
    #  - `handle`
    #  - `title`
    #  - `updated_at`
    #  - `created_at`
    query: String
  ): BlogConnection!

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

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

  # 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`
    query: String
  ): 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(handle: String!): Product

  # 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 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`
    #  - `created_at`
    #  - `updated_at`
    #  - `tag`
    query: String
  ): ProductConnection!

  # The shop’s refund policy.
  refundPolicy: ShopPolicy

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

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

Connections

articles   (ArticleConnection!)

List of the shop' articles.

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
  • updated_at
  • created_at
  • blog_title
  • tag
reverse Boolean false

Reverse the order of the underlying list.

sortKey ArticleSortKeys ID

Sort the underlying list by the given key.

blogs   (BlogConnection!)

List of the shop' blogs.

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:

  • handle
  • title
  • updated_at
  • created_at
reverse Boolean false

Reverse the order of the underlying list.

sortKey BlogSortKeys ID

Sort the underlying list by the given key.

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:

  • title
  • collection_type
  • updated_at
reverse Boolean false

Reverse the order of the underlying list.

sortKey CollectionSortKeys ID

Sort the underlying list by the given key.

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:

  • title
  • product_type
  • vendor
  • created_at
  • updated_at
  • tag
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!

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!

refundPolicy   (ShopPolicy)

The shop’s refund policy.

termsOfService   (ShopPolicy)

The shop’s terms of service.

Deprecated fields

Show/Hide

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