App Object

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
  identifier: String
  permissions: [Permission!]
  created: DateTime
  isActive: Boolean
  name: String
  type: AppTypeEnum
  tokens: [AppToken!]
  webhooks: [Webhook!]
  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!]!
  problems(
    limit: PositiveInt
  ): [AppProblem!]
  brand: AppBrand
  breakerState: CircuitBreakerStateEnum!
  breakerLastStateChange: DateTime
}

Fields

id ● ID!

The ID of the app.

privateMetadata ● [MetadataItem!]!

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

privateMetafield ● String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!

privateMetafields ● Metadata

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

keys ● [String!]

metadata ● [MetadataItem!]!

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

metafield ● String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!

metafields ● Metadata

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

keys ● [String!]

identifier ● String

Canonical app ID from the manifest

Added in Saleor 3.19

permissions ● [Permission!]

List of the app's permissions.

created ● DateTime

The date and time when the app was created.

isActive ● Boolean

Determine if app will be set active or not.

name ● String

Name of the app.

type ● AppTypeEnum

Type of the app.

tokens ● [AppToken!]

Last 4 characters of the tokens.

Requires one of the following permissions: MANAGE_APPSOWNER

webhooks ● [Webhook!]

List of webhooks assigned to this app.

Requires one of the following permissions: MANAGE_APPSOWNER

aboutApp ● String

Description of this app.

dataPrivacyUrl ● String

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

homepageUrl ● String

Homepage of the app.

supportUrl ● String

Support page for the app.

appUrl ● String

URL to iframe with the app.

manifestUrl ● String

URL to manifest used during app's installation.

version ● String

Version number of the app.

accessToken ● String

JWT token used to authenticate by third-party app.

author ● String

The App's author name.

extensions ● [AppExtension!]!

App's dashboard extensions.

problems ● [AppProblem!]

List of problems associated with this app.

Added in Saleor 3.22

Requires one of the following permissions: AUTHENTICATED_APPMANAGE_APPS

limit ● PositiveInt

Limit number of returned problems. Must be between 1 and 100.

brand ● AppBrand

App's brand data.

breakerState ● CircuitBreakerStateEnum!

Circuit breaker state, if open, sync webhooks operation is disrupted.

Added in Saleor 3.21

breakerLastStateChange ● DateTime

Circuit breaker last state change date.

Added in Saleor 3.21

Show deprecated

Interfaces

Node

An object with an ID

ObjectWithMetadata

Returned By

app query

Member Of

AccountChangeEmailRequested object ● AccountConfirmationRequested object ● AccountConfirmed object ● AccountDeleted object ● AccountDeleteRequested object ● AccountEmailChanged object ● AccountSetPasswordRequested object ● AddressCreated object ● AddressDeleted object ● AddressUpdated object ● AppActivate object ● AppCountableEdge object ● AppCreate object ● AppDeactivate object ● AppDelete object ● AppDeleted object ● AppExtension object ● AppInstalled object ● AppReenableSyncWebhooks object ● AppStatusChanged object ● AppUpdate object ● AppUpdated object ● AttributeCreated object ● AttributeDeleted object ● AttributeUpdated object ● AttributeValueCreated object ● AttributeValueDeleted object ● AttributeValueUpdated object ● CalculateTaxes object ● CategoryCreated object ● CategoryDeleted object ● CategoryUpdated object ● ChannelCreated object ● ChannelDeleted object ● ChannelMetadataUpdated object ● ChannelStatusChanged object ● ChannelUpdated object ● CheckoutCreated object ● CheckoutFilterShippingMethods object ● CheckoutFullyAuthorized object ● CheckoutFullyPaid object ● CheckoutMetadataUpdated object ● CheckoutUpdated object ● CollectionCreated object ● CollectionDeleted object ● CollectionMetadataUpdated object ● CollectionUpdated object ● CustomerCreated object ● CustomerEvent object ● CustomerMetadataUpdated object ● CustomerUpdated object ● DraftOrderCreated object ● DraftOrderDeleted object ● DraftOrderUpdated object ● Event interface ● ExportEvent object ● ExportFile object ● FulfillmentApproved object ● FulfillmentCanceled object ● FulfillmentCreated object ● FulfillmentMetadataUpdated object ● FulfillmentTrackingNumberUpdated object ● GiftCard object ● GiftCardCreated object ● GiftCardDeleted object ● GiftCardEvent object ● GiftCardExportCompleted object ● GiftCardMetadataUpdated object ● GiftCardSent object ● GiftCardStatusChanged object ● GiftCardUpdated object ● InvoiceDeleted object ● InvoiceRequested object ● InvoiceSent object ● ListStoredPaymentMethods object ● MenuCreated object ● MenuDeleted object ● MenuItemCreated object ● MenuItemDeleted object ● MenuItemUpdated object ● MenuUpdated object ● OrderBulkCreated object ● OrderCancelled object ● OrderConfirmed object ● OrderCreated object ● OrderEvent object ● OrderExpired object ● OrderFilterShippingMethods object ● OrderFulfilled object ● OrderFullyPaid object ● OrderFullyRefunded object ● OrderGrantedRefund object ● OrderMetadataUpdated object ● OrderPaid object ● OrderRefunded object ● OrderUpdated object ● PageCreated object ● PageDeleted object ● PageTypeCreated object ● PageTypeDeleted object ● PageTypeUpdated object ● PageUpdated object ● PaymentAuthorize object ● PaymentCaptureEvent object ● PaymentConfirmEvent object ● PaymentGatewayInitializeSession object ● PaymentGatewayInitializeTokenizationSession object ● PaymentListGateways object ● PaymentMethodInitializeTokenizationSession object ● PaymentMethodProcessTokenizationSession object ● PaymentProcessEvent object ● PaymentRefundEvent object ● PaymentVoidEvent object ● PermissionGroupCreated object ● PermissionGroupDeleted object ● PermissionGroupUpdated object ● ProductCreated object ● ProductDeleted object ● ProductExportCompleted object ● ProductMediaCreated object ● ProductMediaDeleted object ● ProductMediaUpdated object ● ProductMetadataUpdated object ● ProductUpdated object ● ProductVariantBackInStock object ● ProductVariantCreated object ● ProductVariantDeleted object ● ProductVariantMetadataUpdated object ● ProductVariantOutOfStock object ● ProductVariantStockUpdated object ● ProductVariantUpdated object ● PromotionCreated object ● PromotionDeleted object ● PromotionEnded object ● PromotionRuleCreated object ● PromotionRuleDeleted object ● PromotionRuleUpdated object ● PromotionStarted object ● PromotionUpdated object ● SaleCreated object ● SaleDeleted object ● SaleToggle object ● SaleUpdated object ● ShippingListMethodsForCheckout object ● ShippingPriceCreated object ● ShippingPriceDeleted object ● ShippingPriceUpdated object ● ShippingZoneCreated object ● ShippingZoneDeleted object ● ShippingZoneMetadataUpdated object ● ShippingZoneUpdated object ● Shop object ● ShopMetadataUpdated object ● StaffCreated object ● StaffDeleted object ● StaffSetPasswordRequested object ● StaffUpdated object ● StoredPaymentMethodDeleteRequested object ● ThumbnailCreated object ● TransactionCancelationRequested object ● TransactionChargeRequested object ● TransactionInitializeSession object ● TransactionItemMetadataUpdated object ● TransactionProcessSession object ● TransactionRefundRequested object ● TranslationCreated object ● TranslationUpdated object ● VoucherCodeExportCompleted object ● VoucherCodesCreated object ● VoucherCodesDeleted object ● VoucherCreated object ● VoucherDeleted object ● VoucherMetadataUpdated object ● VoucherUpdated object ● WarehouseCreated object ● WarehouseDeleted object ● WarehouseMetadataUpdated object ● WarehouseUpdated object ● Webhook object

Implemented By

_Entity union ● IssuingPrincipal union ● UserOrApp union