API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

AppInstallation object

Version unstable

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

purchaseConfirmation (AppPurchaseConfirmation)

Lookup an AppPurchaseConfirmation by ID.

id ( ID! ) required

AppPurchase or AppSubscription ID used to look up the AppPurchaseConfirmation.

uninstallUrl (URL)

Webpage where you can uninstall the app.

Types that return AppInstallation

Implements

Deprecated fields

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 2021-01 (Release candidate)

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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 2020-10 (Latest)

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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 2020-07

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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 2020-04

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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 2020-01

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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 (Unsupported)

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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-07 (Unsupported)

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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-04 (Unsupported)

Represents an installed application on a shop.

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

sortKey ( AppSubscriptionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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

sortKey ( AppTransactionSortKeys )

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

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.

Types that return AppInstallation

Implements

Deprecated fields

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

Samples