Vendure logo
vendure

Features

A tour of the core Vendure features

Case studies

How Vendure is being used in real-world projects

Plugins

Official & community plugins

Demo
Live

Try our live Vendure demo now!

Roadmap

Integrations

Compose your commerce stack

Storefront

Next.js Commerce
Vue Storefront

Payments

Braintree
Mollie

Infrastructure

Amazon S3
Elasticsearch
See more...

Support

View our paid support plans

Partners

Our network of partners

Documentation

Get started in 5 minutes!

Community

  • GitHub logo GitHub
  • GitHub logo Support Forum
  • Slack logo Slack Community
  • YouTube logo YouTube Channel
  • Star icon Sponsors & Contributors
Blog GitHub star counter
Vendure logo
Product

Features

A tour of the core Vendure features

Case studies

How Vendure is being used in real-world projects

Plugins

Official & community plugins

Integrations

Storefronts, payments, infrastructure. Compose your commerce stack

Demo
Live

Try our live Vendure demo now!

Roadmap

Services

Support

View our paid support plans

Partners

Our network of partners

Developers

Documentation

Get started in 5 minutes!

Community

  • GitHub logo GitHub
  • GitHub logo Support Forum
  • Slack logo Slack Community
  • YouTube logo YouTube Channel
  • Star icon Sponsors & Contributors

Blog

News and technical articles

  • Getting Started
  • Administrator Guide
    • Catalog
      • Products
      • Facets
      • Collections
    • Customers
    • 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
    • Deployment
    • Error Handling
    • Importing Product Data
    • Job Queue
    • Migrations
    • Multi-Tenant
    • 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
      • Adding Navigation Items
      • Custom Form Inputs
      • Custom Detail 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
  • GraphQL API
    • Shop API
      • Queries
      • Mutations
      • Types
      • Input Objects
      • Enums
    • Admin API
      • Queries
      • Mutations
      • Types
      • Input Objects
      • Enums
  • TypeScript API
    • AdminUiPlugin
      • AdminUiConfig
      • AdminUiPluginOptions
    • Assets
      • AssetNamingStrategy
      • AssetOptions
      • AssetPreviewStrategy
      • AssetStorageStrategy
      • DefaultAssetNamingStrategy
    • AssetServerPlugin
      • AssetServerOptions
      • HashedAssetNamingStrategy
      • ImageTransformMode
      • ImageTransformPreset
      • LocalAssetStorageStrategy
      • S3AssetStorageStrategy
    • Auth
      • AuthenticationStrategy
      • AuthOptions
      • BcryptPasswordHashingStrategy
      • CookieOptions
      • DefaultPasswordValidationStrategy
      • ExternalAuthenticationService
      • InMemorySessionCacheStrategy
      • NativeAuthenticationStrategy
      • NoopSessionCacheStrategy
      • PasswordHashingStrategy
      • PasswordValidationStrategy
      • PermissionDefinition
      • SessionCacheStrategy
      • SuperadminCredentials
    • Bootstrap
    • Common
      • AdminUiAppConfig
      • AdminUiAppDevModeConfig
      • AsyncQueue
      • CurrencyCode
      • EntityRelationPaths
      • ID
      • InjectableStrategy
      • Injector
      • JobState
      • JsonCompatible
      • LanguageCode
      • Middleware
      • PaginatedList
      • Permission
      • PriceCalculationResult
      • ProcessContext
    • ConfigurableOperationDef
      • ConfigArgs
      • ConfigArgType
      • ConfigurableOperationDefOptions
      • DefaultFormComponentId
      • DefaultFormConfigHash
      • LocalizedStringArray
    • Configuration
      • ApiOptions
      • CatalogOptions
      • CollectionFilter
      • DefaultConfig
      • DefaultStockDisplayStrategy
      • EntityIdStrategy
      • EntityOptions
      • MergeConfig
      • ProductVariantPriceCalculationStrategy
      • RuntimeVendureConfig
      • StockDisplayStrategy
      • SystemOptions
      • VendureConfig
    • CustomFields
      • CustomFieldConfig
      • CustomFieldType
      • TypedCustomSingleFieldConfig
    • Data Access
      • Calculated
      • EntityHydrator
      • GetEntityOrThrowOptions
      • HydrateOptions
      • ListQueryBuilder
      • TransactionalConnection
    • DefaultSearchPlugin
      • DefaultSearchPluginInitOptions
    • ElasticsearchPlugin
      • ElasticsearchOptions
    • EmailPlugin
      • Email Plugin Types
      • EmailEventHandler
      • EmailEventHandlerWithAsyncData
      • EmailEventListener
      • EmailGenerator
      • EmailPluginOptions
      • EmailSender
      • Transport Options
    • Entities
      • Address
      • Administrator
      • AnonymousSession
      • Asset
      • AuthenticatedSession
      • AuthenticationMethod
      • Channel
      • Collection
      • Country
      • Customer
      • CustomerGroup
      • CustomerHistoryEntry
      • Facet
      • FacetValue
      • Fulfillment
      • HistoryEntry
      • Interfaces
      • Order
      • OrderableAsset
      • OrderHistoryEntry
      • OrderItem
      • OrderLine
      • OrderModification
      • Payment
      • PaymentMethod
      • Product
      • ProductOption
      • ProductOptionGroup
      • ProductVariant
      • ProductVariantPrice
      • Promotion
      • Role
      • Session
      • ShippingMethod
      • StockMovement
      • Surcharge
      • Tag
      • TaxCategory
      • TaxRate
      • User
      • VendureEntity
      • Zone
    • Errors
      • Error Types
      • I18nError
    • Events
      • Event Types
      • EventBus
      • VendureEntityEvent
      • VendureEvent
    • Fulfillment
      • CustomFulfillmentProcess
      • CustomPaymentProcess
      • FulfillmentHandler
      • FulfillmentState
      • FulfillmentTransitionData
    • Health Check
      • HealthCheckRegistryService
      • HealthCheckStrategy
      • HttpHealthCheckStrategy
      • TypeORMHealthCheckStrategy
    • Import Export
      • AssetImporter
      • FastImporterService
      • Importer
      • ImportExportOptions
      • ImportParser
      • InitialData
      • Populate
      • Populator
    • Job Queue Plugin
      • BullMQJobQueuePlugin
      • BullMQJobQueueStrategy
      • BullMQPluginOptions
    • JobQueue
      • DefaultJobQueuePlugin
      • InMemoryJobBufferStorageStrategy
      • InMemoryJobQueueStrategy
      • InspectableJobQueueStrategy
      • Job
      • JobBuffer
      • JobBufferStorageStrategy
      • JobQueueOptions
      • JobQueueService
      • JobQueueStrategy
      • PollingJobQueueStrategy
      • SqlJobQueueStrategy
      • SubscribableJob
      • Types
    • Logger
      • DefaultLogger
      • LogLevel
      • VendureLogger
    • Migration
      • GenerateMigration
      • MigrationOptions
      • RevertLastMigration
      • RunMigrations
    • Orders
      • ActiveOrderService
      • ChangedPriceHandlingStrategy
      • CustomOrderProcess
      • DefaultOrderItemPriceCalculationStrategy
      • DefaultOrderPlacedStrategy
      • DefaultStockAllocationStrategy
      • Merge Strategies
      • OrderByCodeAccessStrategy
      • OrderCodeStrategy
      • OrderItemPriceCalculationStrategy
      • OrderMergeStrategy
      • OrderOptions
      • OrderPlacedStrategy
      • OrderState
      • StockAllocationStrategy
    • Payment
      • DummyPaymentHandler
      • Payment Method Types
      • PaymentMethodConfigOptions
      • PaymentMethodEligibilityChecker
      • PaymentMethodHandler
      • PaymentOptions
      • PaymentState
      • PaymentTransitionData
      • RefundState
      • RefundTransitionData
    • Payments Plugin
      • BraintreePlugin
      • MolliePlugin
      • StripePlugin
    • Plugin
      • Plugin Utilities
      • PluginCommonModule
      • VendurePlugin
      • VendurePluginMetadata
    • Promotions
      • FacetValueChecker
      • Promotion Action
      • Promotion Condition
      • PromotionOptions
    • Request
      • Allow Decorator
      • Api Decorator
      • ApiType
      • Ctx Decorator
      • RequestContext
      • RequestContextService
      • Transaction Decorator
    • Services
      • AdministratorService
      • AssetService
      • AuthService
      • ChannelService
      • CollectionService
      • CountryService
      • CustomerGroupService
      • CustomerService
      • FacetService
      • FacetValueService
      • FulfillmentService
      • GlobalSettingsService
      • HistoryService
      • OrderService
      • OrderTestingService
      • PaymentMethodService
      • PaymentService
      • ProductOptionGroupService
      • ProductOptionService
      • ProductService
      • ProductVariantService
      • PromotionService
      • RoleService
      • SearchService
      • SessionService
      • ShippingMethodService
      • StockMovementService
      • TagService
      • TaxCategoryService
      • TaxRateService
      • UserService
      • ZoneService
    • Shipping
      • CheckShippingEligibilityCheckerFn
      • ShippingCalculator
      • ShippingEligibilityChecker
      • ShippingEligibilityCheckerConfig
      • ShippingOptions
      • ShouldRunCheckFn
    • State Machine
      • FSM
      • StateMachineConfig
      • Transitions
    • Tax
      • DefaultProductVariantPriceCalculationStrategy
      • DefaultTaxLineCalculationStrategy
      • DefaultTaxZoneStrategy
      • TaxLineCalculationStrategy
      • TaxOptions
      • TaxZoneStrategy
    • Testing
      • CreateErrorResultGuard
      • CreateTestEnvironment
      • ErrorResultGuard
      • GetSuperadminContext
      • RegisterInitializer
      • SimpleGraphQLClient
      • TestConfig
      • TestDbInitializer
      • TestEnvironment
      • TestingLogger
      • TestServer
      • TestServerOptions
    • Translation
      • I18nService
      • VendureTranslationResources
    • Worker
      • BootstrapWorker
      • VendureWorker
      • WorkerHealthCheckConfig
  • Admin UI API
    • Action Bar
      • ActionBarItem
      • ActionBarLocationId
      • AddActionBarItem
      • OnClickContext
    • Components
      • AssetPickerDialogComponent
      • ChipComponent
      • CurrencyInputComponent
      • DataTableComponent
      • DatetimePickerComponent
      • DropdownComponent
      • FacetValueSelectorComponent
      • ObjectTreeComponent
      • OrderStateLabelComponent
      • ProductSelectorComponent
      • RichTextEditorComponent
    • Custom Detail Components
      • CustomDetailComponent
      • CustomDetailComponentConfig
      • CustomDetailComponentLocationId
      • RegisterCustomDetailComponent
    • Custom Input Components
      • Default Inputs
      • FormInputComponent
      • RegisterCustomFieldComponent
      • RegisterFormInputComponent
    • Directives
      • IfMultichannelDirective
      • IfPermissionsDirective
    • List Detail Views
      • BaseDetailComponent
      • BaseEntityResolver
      • BaseListComponent
    • Nav Menu
      • AddNavMenuItem
      • AddNavMenuSection
      • Navigation Types
      • NavMenuItem
      • NavMenuSection
    • Pipes
      • AssetPreviewPipe
      • DurationPipe
      • FileSizePipe
      • HasPermissionPipe
      • LocaleCurrencyNamePipe
      • LocaleCurrencyPipe
      • LocaleDatePipe
      • LocaleLanguageNamePipe
      • LocaleRegionNamePipe
      • TimeAgoPipe
    • Providers
      • DataService
      • ModalService
      • NotificationService
    • Ui Devkit
      • AdminUiExtension
      • CompileUiExtensions
      • Helpers
      • UiDevkitClient
      • UiExtensionCompilerOptions
      • UiExtensionCompilerProcessArgument
v1.6.1#c2ab6f660
  1. Docs
  2. TypeScript API
  3. Common
  4. ID

ID

ID

Package: @vendure/common File: shared-types.ts

An entity ID. Depending on the configured EntityIdStrategy, it will be either a string or a number;

Signature

type ID = string | number
Generated on May 19 2022 at 17:39
Contents
  • ID
  • ID
    • Signature