Skip to main content

Plugin

Plugin.

type Plugin implements Node {
id: ID!
identifier: String!
name: String!
description: String!
active: Boolean!
company: String
descriptionShort: String!
logoUrl: String
created: DateTime!
externalUrl: String
supportUrl: String
allowManyActivePluginsInCategory: Boolean!
allowSwitchingBetweenPluginsInCategory: Boolean!
customFieldMappings: JSONString
metadata: JSON!
privateMetadata: JSON!
seller: Seller
tenant: Tenant!
category: PluginConfigurationCategory
configuration: [ConfigurationItem!]!
defaultConfiguration: [ConfigurationItem!]!
supportSellerConfiguration: Boolean!
version: String!
}
Show more ↓

Fields

Plugin.id ● ID! non-null scalar

The ID of the object.

Plugin.identifier ● String! non-null scalar

Plugin identifier

Plugin.name ● String! non-null scalar

Plugin name

Plugin.description ● String! non-null scalar

Plugin description

Plugin.active ● Boolean! non-null scalar

Whether the plugin is active

Plugin.company ● String scalar

Company name

Plugin.descriptionShort ● String! non-null scalar

Short description

Plugin.logoUrl ● String scalar

Logo URL

Plugin.created ● DateTime! non-null scalar

Creation date

Plugin.externalUrl ● String scalar

External URL

Plugin.supportUrl ● String scalar

Support URL

Plugin.allowManyActivePluginsInCategory ● Boolean! non-null scalar

Allow multiple active plugins in category

Plugin.allowSwitchingBetweenPluginsInCategory ● Boolean! non-null scalar

Allow switching between plugins in category

Plugin.customFieldMappings ● JSONString scalar

Optional custom field mappings for webhook ingestion. Format: {'product': [...], 'variant': [...], 'image': [...]} where each list contains FieldMapping configurations. If null, uses default mappings from plugin.

Plugin.metadata ● JSON! non-null scalar

Public metadata

Plugin.privateMetadata ● JSON! non-null scalar

Private metadata

Plugin.seller ● Seller object

Seller for this plugin configuration

Plugin.tenant ● Tenant! non-null object

Tenant for this plugin configuration

Plugin.category ● PluginConfigurationCategory enum

Plugin category

Plugin.configuration ● [ConfigurationItem!]! non-null object

Plugin configuration

Plugin.defaultConfiguration ● [ConfigurationItem!]! non-null object

Default plugin configuration

Plugin.supportSellerConfiguration ● Boolean! non-null scalar

Whether this plugin supports seller-level configuration

Plugin.version ● String! non-null scalar

Plugin version

Interfaces

Node interface

An object with a Globally Unique ID

Returned By

plugin query

Member Of

PluginCountableEdge object ● PluginUpdate object ● Shop object

Was this page helpful?