Skip to main content

App

Represents app data.

type App implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  permissions: [Permission!]
  created: DateTime
  isActive: Boolean
  name: String
  type: AppTypeEnum
  aboutApp: String
  dataPrivacy: String @deprecated
  dataPrivacyUrl: String
  homepageUrl: String
  supportUrl: String
  configurationUrl: String @deprecated
  appUrl: String
  manifestUrl: String
  version: String
  accessToken: String
  author: String
  extensions: [AppExtension!]!
  brand: AppBrand
}

Fields​

App.id ● ID! non-null scalar​

App.privateMetadata ● [MetadataItem!]! non-null object​

List of private metadata items. Requires staff permissions to access.

App.privateMetafield ● String scalar​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
App.privateMetafield.key ● String! non-null scalar​

App.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
App.privateMetafields.keys ● [String!] list scalar​

App.metadata ● [MetadataItem!]! non-null object​

List of public metadata items. Can be accessed without permissions.

App.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
App.metafield.key ● String! non-null scalar​

App.metafields ● Metadata scalar​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
App.metafields.keys ● [String!] list scalar​

App.permissions ● [Permission!] list object​

List of the app's permissions.

App.created ● DateTime scalar​

The date and time when the app was created.

App.isActive ● Boolean scalar​

Determine if app will be set active or not.

App.name ● String scalar​

Name of the app.

App.type ● AppTypeEnum enum​

Type of the app.

App.aboutApp ● String scalar​

Description of this app.

App.dataPrivacy ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use dataPrivacyUrl instead.

Description of the data privacy defined for this app.

App.dataPrivacyUrl ● String scalar​

URL to details about the privacy policy on the app owner page.

App.homepageUrl ● String scalar​

Homepage of the app.

App.supportUrl ● String scalar​

Support page for the app.

App.configurationUrl ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use appUrl instead.

URL to iframe with the configuration for the app.

App.appUrl ● String scalar​

URL to iframe with the app.

App.manifestUrl ● String scalar​

URL to manifest used during app's installation.

Added in Saleor 3.5

App.version ● String scalar​

Version number of the app.

App.accessToken ● String scalar​

JWT token used to authenticate by thridparty app.

App.author ● String scalar​

The App's author name.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

App.extensions ● [AppExtension!]! non-null object​

App's dashboard extensions.

Added in Saleor 3.1

App.brand ● AppBrand object​

App's brand data.

Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

AppExtension object ● Event interface

Implemented by​

_Entity union ● IssuingPrincipal union ● UserOrApp union

Was this page helpful?