🆕 Try our new beta documentation! →

Vendure logo
vendure
documentation
Discord logo GitHub star counter
    • Getting Started
    • Administrator Guide
      • Catalog
        • Products
        • Facets
        • Collections
      • Customers
      • Orders
        • Draft Orders
      • Promotions
      • Settings
        • Administrators & Roles
        • Channels
        • Countries & Zones
        • Global Settings
        • Payment Methods
        • Shipping Methods
        • Taxes
      • Localization
    • Developer Guide
      • Architecture Overview
      • Authentication
      • Channels
      • Configuration
      • Customizing Models
      • Customizing the Order Process
      • Error Handling
      • Importing Product Data
      • Job Queue
      • Logging
      • Migrations
      • Multi-vendor Marketplaces
      • Payment Integrations
      • Promotions
      • Shipping & Fulfillment
      • Stand-alone CLI Scripts
      • Stock Control
      • Taxes
      • Testing
      • Translation
      • Updating Vendure
      • Uploading Files
      • Vendure Worker
    • Plugins
      • Plugin Architecture
      • Writing a Vendure Plugin
      • Plugin Lifecycle
      • Plugin Examples
        • Using the Job Queue
        • Adding a REST endpoint
        • Defining a new database entity
        • Defining custom permissions
        • Defining database subscribers
        • Extending the GraphQL API
        • Modifying the VendureConfig
      • Extending the Admin UI
        • Using Angular
        • Using Other Frameworks
        • Creating Detail Views
        • Creating List Views
        • Add Actions To Pages
        • Custom Form Inputs
        • Modify Navigation Items
        • Custom Detail Components
        • Custom History Timeline Components
        • Adding UI Translations
        • Admin UI Theming & Branding
        • Dashboard Widgets
    • Storefront
      • Building a Storefront
      • Managing Sessions
      • Configuring a GraphQL Client
      • Shop API Guide
      • Order Workflow
    • Deployment
      • Production configuration
      • Server resource requirements
      • Horizontal scaling
      • Using docker
      • Getting data into production
      • Deploying the Admin UI
      • Deploying to Google Cloud Run
      • Deploying to Northflank
    • Migrating from v1
      • Database Migration
      • Breaking API Changes
      • Storefront Migration
    • GraphQL API
      • Shop API
        • Queries
        • Mutations
        • Types
        • Input Objects
        • Enums
      • Admin API
        • Queries
        • Mutations
        • Types
        • Input Objects
        • Enums
    • TypeScript API
      • Assets
        • AssetNamingStrategy
        • AssetOptions
        • AssetPreviewStrategy
        • AssetStorageStrategy
        • DefaultAssetNamingStrategy
      • Auth
        • AuthenticationStrategy
        • AuthOptions
        • BcryptPasswordHashingStrategy
        • CookieOptions
        • DefaultPasswordValidationStrategy
        • ExternalAuthenticationService
        • InMemorySessionCacheStrategy
        • NativeAuthenticationStrategy
        • NoopSessionCacheStrategy
        • PasswordHashingStrategy
        • PasswordValidationStrategy
        • PermissionDefinition
        • SessionCacheStrategy
        • SuperadminCredentials
      • Common
        • AsyncQueue
        • Bootstrap
        • CurrencyCode
        • EntityRelationPaths
        • I18nService
        • ID
        • InjectableStrategy
        • Injector
        • JobState
        • JsonCompatible
        • LanguageCode
        • Middleware
        • PaginatedList
        • Permission
        • PriceCalculationResult
        • ProcessContext
        • VENDURE_VERSION
      • ConfigurableOperationDef
        • ConfigArgs
        • ConfigArgType
        • ConfigurableOperationDefOptions
        • DefaultFormComponentId
        • DefaultFormConfigHash
        • LocalizedStringArray
      • Configuration
        • ApiOptions
        • CollectionFilter
        • DefaultConfig
        • EntityIdStrategy
        • EntityOptions
        • MergeConfig
        • ProductVariantPriceSelectionStrategy
        • RuntimeVendureConfig
        • SystemOptions
        • VendureConfig
      • Core Plugins
        • AdminUiPlugin
          • AdminUiAppConfig
          • AdminUiAppDevModeConfig
          • AdminUiConfig
          • AdminUiPluginOptions
        • AssetServerPlugin
          • AssetServerOptions
          • CacheConfig
          • HashedAssetNamingStrategy
          • ImageTransformMode
          • ImageTransformPreset
          • LocalAssetStorageStrategy
          • S3AssetStorageStrategy
          • SharpAssetPreviewStrategy
        • DefaultSearchPlugin
          • DefaultSearchPluginInitOptions
        • ElasticsearchPlugin
          • ElasticsearchOptions
        • EmailPlugin
          • Custom Template Loader
          • Email Plugin Types
          • EmailEventHandler
          • EmailEventHandlerWithAsyncData
          • EmailEventListener
          • EmailGenerator
          • EmailPluginOptions
          • EmailSender
          • Transport Options
        • HardenPlugin
          • DefaultVendureComplexityEstimator
          • HardenPluginOptions
        • Job Queue Plugin
          • BullMQJobQueuePlugin
          • BullMQJobQueueStrategy
          • BullMQPluginOptions
        • Payments Plugin
          • BraintreePlugin
          • MolliePlugin
          • StripePlugin
      • CustomFields
        • CustomFieldConfig
        • CustomFieldType
        • TypedCustomSingleFieldConfig
      • Data Access
        • Calculated
        • EntityHydrator
        • GetEntityOrThrowOptions
        • HydrateOptions
        • ListQueryBuilder
        • TransactionalConnection
      • Entities
        • Address
        • Administrator
        • AnonymousSession
        • Asset
        • AuthenticatedSession
        • AuthenticationMethod
        • Channel
        • Collection
        • Country
        • Customer
        • CustomerGroup
        • CustomerHistoryEntry
        • Facet
        • FacetValue
        • Fulfillment
        • HistoryEntry
        • Interfaces
        • Order
        • OrderableAsset
        • OrderHistoryEntry
        • OrderLine
        • OrderLineReference
        • OrderModification
        • Payment
        • PaymentMethod
        • Product
        • ProductOption
        • ProductOptionGroup
        • ProductVariant
        • ProductVariantPrice
        • Promotion
        • Province
        • Region
        • Role
        • Seller
        • Session
        • ShippingLine
        • ShippingMethod
        • StockLevel
        • StockLocation
        • StockMovement
        • Surcharge
        • Tag
        • TaxCategory
        • TaxRate
        • User
        • VendureEntity
        • Zone
      • Errors
        • Error Types
        • I18nError
      • Events
        • Event Types
        • EventBus
        • VendureEntityEvent
        • VendureEvent
      • Fulfillment
        • FulfillmentHandler
        • FulfillmentProcess
        • FulfillmentState
        • FulfillmentStates
        • FulfillmentTransitionData
      • Health Check
        • HealthCheckRegistryService
        • HealthCheckStrategy
        • HttpHealthCheckStrategy
        • TypeORMHealthCheckStrategy
      • Import Export
        • AssetImporter
        • AssetImportStrategy
        • DefaultAssetImportStrategy
        • FastImporterService
        • Importer
        • ImportExportOptions
        • ImportParser
        • InitialData
        • Populate
        • Populator
      • JobQueue
        • DefaultJobQueuePlugin
        • InMemoryJobBufferStorageStrategy
        • InMemoryJobQueueStrategy
        • InspectableJobQueueStrategy
        • Job
        • JobBuffer
        • JobBufferStorageStrategy
        • JobQueueOptions
        • JobQueueService
        • JobQueueStrategy
        • PollingJobQueueStrategy
        • SqlJobQueueStrategy
        • SubscribableJob
        • Types
      • Logger
        • DefaultLogger
        • LogLevel
        • VendureLogger
      • Migration
        • GenerateMigration
        • MigrationOptions
        • RevertLastMigration
        • RunMigrations
      • Money
        • BigIntMoneyStrategy
        • DefaultMoneyStrategy
        • MoneyStrategy
        • RoundMoney
      • Orders
        • ActiveOrderService
        • ActiveOrderStrategy
        • ChangedPriceHandlingStrategy
        • CustomOrderStates
        • DefaultActiveOrderStrategy
        • DefaultGuestCheckoutStrategy
        • DefaultOrderItemPriceCalculationStrategy
        • DefaultOrderPlacedStrategy
        • DefaultStockAllocationStrategy
        • GuestCheckoutStrategy
        • Merge Strategies
        • OrderByCodeAccessStrategy
        • OrderCodeStrategy
        • OrderItemPriceCalculationStrategy
        • OrderMergeStrategy
        • OrderOptions
        • OrderPlacedStrategy
        • OrderProcess
        • OrderSellerStrategy
        • StockAllocationStrategy
      • Payment
        • DefaultPaymentProcess
        • DummyPaymentHandler
        • Payment Method Types
        • PaymentMethodConfigOptions
        • PaymentMethodEligibilityChecker
        • PaymentMethodHandler
        • PaymentOptions
        • PaymentProcess
        • PaymentState
        • PaymentStates
        • PaymentTransitionData
        • RefundState
        • RefundTransitionData
      • Plugin
        • Plugin Utilities
        • PluginCommonModule
        • VendurePlugin
        • VendurePluginMetadata
      • Products Stock
        • CatalogOptions
        • DefaultProductVariantPriceCalculationStrategy
        • DefaultStockDisplayStrategy
        • DefaultStockLocationStrategy
        • ProductVariantPriceCalculationStrategy
        • StockDisplayStrategy
        • StockLocationStrategy
      • Promotions
        • FacetValueChecker
        • Promotion Action
        • Promotion Condition
        • PromotionOptions
      • Request
        • Allow Decorator
        • Api Decorator
        • ApiType
        • Ctx Decorator
        • Relations Decorator
        • RequestContext
        • RequestContextService
        • Transaction Decorator
      • Service Helpers
        • OrderCalculator
        • OrderModifier
        • ProductPriceApplicator
        • SlugValidator
        • TranslatableSaver
      • Services
        • AdministratorService
        • AssetService
        • AuthService
        • ChannelService
        • CollectionService
        • CountryService
        • CustomerGroupService
        • CustomerService
        • FacetService
        • FacetValueService
        • FulfillmentService
        • GlobalSettingsService
        • HistoryService
        • OrderService
        • OrderTestingService
        • PaymentMethodService
        • PaymentService
        • ProductOptionGroupService
        • ProductOptionService
        • ProductService
        • ProductVariantService
        • PromotionService
        • ProvinceService
        • RoleService
        • SearchService
        • SellerService
        • SessionService
        • ShippingMethodService
        • StockLevelService
        • StockMovementService
        • TagService
        • TaxCategoryService
        • TaxRateService
        • UserService
        • ZoneService
      • Shipping
        • CheckShippingEligibilityCheckerFn
        • DefaultShippingLineAssignmentStrategy
        • ShippingCalculator
        • ShippingEligibilityChecker
        • ShippingEligibilityCheckerConfig
        • ShippingLineAssignmentStrategy
        • ShippingOptions
        • ShouldRunCheckFn
      • State Machine
        • FSM
        • StateMachineConfig
        • Transitions
      • Tax
        • DefaultTaxLineCalculationStrategy
        • DefaultTaxZoneStrategy
        • TaxLineCalculationStrategy
        • TaxOptions
        • TaxZoneStrategy
      • Testing
        • CreateErrorResultGuard
        • CreateTestEnvironment
        • ErrorResultGuard
        • GetSuperadminContext
        • RegisterInitializer
        • SimpleGraphQLClient
        • TestConfig
        • TestDbInitializer
        • TestEnvironment
        • TestingLogger
        • TestServer
        • TestServerOptions
      • Worker
        • BootstrapWorker
        • VendureWorker
        • WorkerHealthCheckConfig
    • Admin UI API
      • Action Bar
        • ActionBarItem
        • ActionBarLocationId
        • AddActionBarItem
        • OnClickContext
        • PageLocationId
      • Bulk Actions
        • BulkAction
        • RegisterBulkAction
      • Components
        • AssetPickerDialogComponent
        • ChipComponent
        • CurrencyInputComponent
        • DataTable2Component
        • DataTableComponent
        • DatetimePickerComponent
        • DropdownComponent
        • FacetValueSelectorComponent
        • ObjectTreeComponent
        • OrderStateLabelComponent
        • ProductVariantSelectorComponent
        • RichTextEditorComponent
        • ZoneSelectorComponent
      • Custom Detail Components
        • CustomDetailComponent
        • CustomDetailComponentConfig
        • CustomDetailComponentLocationId
        • RegisterCustomDetailComponent
      • Custom History Entry Components
        • CustomerHistoryEntryComponent
        • HistoryEntryComponent
        • HistoryEntryConfig
        • OrderHistoryEntryComponent
        • RegisterHistoryEntryComponent
      • Custom Input Components
        • Default Inputs
        • FormInputComponent
        • RegisterFormInputComponent
      • Directives
        • IfMultichannelDirective
        • IfPermissionsDirective
      • List Detail Views
        • BaseDetailComponent
        • BaseEntityResolver
        • BaseListComponent
        • DetailComponentWithResolver
        • TypedBaseDetailComponent
        • TypedBaseListComponent
      • Nav Menu
        • AddNavMenuItem
        • AddNavMenuSection
        • Navigation Types
        • NavMenuItem
        • NavMenuSection
      • Pipes
        • AssetPreviewPipe
        • DurationPipe
        • FileSizePipe
        • HasPermissionPipe
        • LocaleCurrencyNamePipe
        • LocaleCurrencyPipe
        • LocaleDatePipe
        • LocaleLanguageNamePipe
        • LocaleRegionNamePipe
        • TimeAgoPipe
      • Providers
        • DataService
        • ModalService
        • NotificationService
      • Tabs
        • PageTabConfig
        • RegisterPageTab
      • Ui Devkit
        • AdminUiExtension
        • CompileUiExtensions
        • Helpers
        • UiDevkitClient
        • UiExtensionCompilerOptions
        • UiExtensionCompilerProcessArgument
v2.0.3#923876cff
  1. GraphQL API
  2. Admin API

GraphQL Admin API

The Admin API is primarily used by the included Admin UI web app to perform administrative tasks such as inventory management, order tracking etc.

Explore the interactive GraphQL Admin API at demo.vendure.io/admin-api

Contents:

Enums Input Objects Mutations Queries Types
Generated on Jun 6 2023 at 17:04