AppInstallation

Version 2019-04

Represents an installed application on a shop.

Show definition
"""
Represents an installed application on a shop.
"""
type AppInstallation implements Node {
  """
  Access scopes granted to an app by a merchant during installation.
  """
  accessScopes: [AccessScope!]!
  """
  Application which is installed.
  """
  app: App!
  """
  Channel associated with the installed application.
  """
  channel: Channel
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Url used to launch the app.
  """
  launchUrl: URL!
  """
  Publication associated with the installed application.
  """
  publication: Publication
  """
  Webpage where you can uninstall the app.
  """
  uninstallUrl: URL
}

Implements

Fields

accessScopes ([AccessScope!]!)

Access scopes granted to an app by a merchant during installation.

app (App!)

Application which is installed.

id (ID!)

Globally unique identifier.

launchUrl (URL!)

Url used to launch the app.

publication (Publication)

Publication associated with the installed application.

uninstallUrl (URL)

Webpage where you can uninstall the app.

Deprecated fields

Show/Hide
channel (Channel) deprecated

Channel associated with the installed application.

Deprecation warning

Use publication instead

Version 2019-07 (Latest)

Represents an installed application on a shop.

Show definition
"""
Represents an installed application on a shop.
"""
type AppInstallation implements Node {
  """
  Access scopes granted to an app by a merchant during installation.
  """
  accessScopes: [AccessScope!]!
  """
  Active subscriptions charged to a shop on a recurring basis.
  """
  activeSubscriptions: [AppSubscription!]!
  """
  All subscriptions created for a shop.
  """
  allSubscriptions(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppSubscriptionSortKeys = CREATED_AT
  ): AppSubscriptionConnection!
  """
  Application which is installed.
  """
  app: App!
  """
  Channel associated with the installed application.
  """
  channel: Channel
  """
  Credits that can be used towards future app purchases.
  """
  credits(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppTransactionSortKeys = CREATED_AT
  ): AppCreditConnection!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Url used to launch the app.
  """
  launchUrl: URL!
  """
  One-time purchases to a shop.
  """
  oneTimePurchases(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppTransactionSortKeys = CREATED_AT
  ): AppPurchaseOneTimeConnection!
  """
  Publication associated with the installed application.
  """
  publication: Publication
  """
  Subscriptions charge to a shop on a recurring basis.
  """
  subscriptions: [AppSubscription!]!
  """
  Webpage where you can uninstall the app.
  """
  uninstallUrl: URL
}

Implements

Connections

allSubscriptions (AppSubscriptionConnection!)

All subscriptions created for a shop.

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: true

sortKey ( AppSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: true

credits (AppCreditConnection!)

Credits that can be used towards future app purchases.

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: true

sortKey ( AppTransactionSortKeys )

Sort the underlying list by the given key.
Default value: true

oneTimePurchases (AppPurchaseOneTimeConnection!)

One-time purchases to a shop.

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: true

sortKey ( AppTransactionSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

accessScopes ([AccessScope!]!)

Access scopes granted to an app by a merchant during installation.

activeSubscriptions ([AppSubscription!]!)

Active subscriptions charged to a shop on a recurring basis.

app (App!)

Application which is installed.

id (ID!)

Globally unique identifier.

launchUrl (URL!)

Url used to launch the app.

publication (Publication)

Publication associated with the installed application.

uninstallUrl (URL)

Webpage where you can uninstall the app.

Deprecated fields

Show/Hide
channel (Channel) deprecated

Channel associated with the installed application.

Deprecation warning

Use publication instead

subscriptions ([AppSubscription!]!) deprecated

Subscriptions charge to a shop on a recurring basis.

Deprecation warning

Use activeSubscriptions instead

Version 2019-10 (Release candidate)

Represents an installed application on a shop.

Show definition
"""
Represents an installed application on a shop.
"""
type AppInstallation implements Node {
  """
  Access scopes granted to an app by a merchant during installation.
  """
  accessScopes: [AccessScope!]!
  """
  Active subscriptions charged to a shop on a recurring basis.
  """
  activeSubscriptions: [AppSubscription!]!
  """
  All subscriptions created for a shop.
  """
  allSubscriptions(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppSubscriptionSortKeys = CREATED_AT
  ): AppSubscriptionConnection!
  """
  Application which is installed.
  """
  app: App!
  """
  Channel associated with the installed application.
  """
  channel: Channel
  """
  Credits that can be used towards future app purchases.
  """
  credits(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppTransactionSortKeys = CREATED_AT
  ): AppCreditConnection!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Url used to launch the app.
  """
  launchUrl: URL!
  """
  One-time purchases to a shop.
  """
  oneTimePurchases(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: AppTransactionSortKeys = CREATED_AT
  ): AppPurchaseOneTimeConnection!
  """
  Publication associated with the installed application.
  """
  publication: Publication
  """
  Subscriptions charge to a shop on a recurring basis.
  """
  subscriptions: [AppSubscription!]!
  """
  Webpage where you can uninstall the app.
  """
  uninstallUrl: URL
}

Implements

Connections

allSubscriptions (AppSubscriptionConnection!)

All subscriptions created for a shop.

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: true

sortKey ( AppSubscriptionSortKeys )

Sort the underlying list by the given key.
Default value: true

credits (AppCreditConnection!)

Credits that can be used towards future app purchases.

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: true

sortKey ( AppTransactionSortKeys )

Sort the underlying list by the given key.
Default value: true

oneTimePurchases (AppPurchaseOneTimeConnection!)

One-time purchases to a shop.

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: true

sortKey ( AppTransactionSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

accessScopes ([AccessScope!]!)

Access scopes granted to an app by a merchant during installation.

activeSubscriptions ([AppSubscription!]!)

Active subscriptions charged to a shop on a recurring basis.

app (App!)

Application which is installed.

id (ID!)

Globally unique identifier.

launchUrl (URL!)

Url used to launch the app.

publication (Publication)

Publication associated with the installed application.

uninstallUrl (URL)

Webpage where you can uninstall the app.

Deprecated fields

Show/Hide
channel (Channel) deprecated

Channel associated with the installed application.

Deprecation warning

Use publication instead

subscriptions ([AppSubscription!]!) deprecated

Subscriptions charge to a shop on a recurring basis.

Deprecation warning

Use activeSubscriptions instead

Sign up for a Partner account to get started.

Sign up