Vendure

aid: vendure
url: https://raw.githubusercontent.com/api-evangelist/vendure/refs/heads/main/apis.yml
name: Vendure
x-type: opensource
description: >-
  Vendure is an open-source headless commerce framework built in TypeScript on top of NestJS, GraphQL, and TypeORM. A
  Vendure server exposes two GraphQL APIs — the Shop API (consumed by storefronts) and the Admin API (consumed by the
  Dashboard and back-office tooling) — plus an Asset Server REST surface for uploads and image previews, and a plugin
  system that extends data, services, jobs, and resolvers. The project is GPLv3-licensed Vendure Core, complemented by a
  commercial Vendure Platform layer of 20+ enterprise plugins, a managed Vendure Cloud offering, an official MCP server,
  and a starter ecosystem (Next.js, Remix, Qwik, SvelteKit, Angular, Gatsby).
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Commerce
- Headless Commerce
- eCommerce
- GraphQL
- Open Source
- TypeScript
- NestJS
- B2B
- B2C
- Storefront
- Plugins
created: '2026-05-23'
modified: '2026-05-25'
specificationVersion: '0.20'
apis:
- aid: vendure:shop-api
  name: Vendure Shop GraphQL API
  description: >-
    Public GraphQL API consumed by storefronts and end-customer clients — product and collection browse, faceted
    search, active order / cart, checkout, eligible shipping and payment methods, customer registration, account and
    address management, and order lookup. Mounted by default at /shop-api on the Vendure server.
  humanURL: https://docs.vendure.io/reference/graphql-api/shop/queries/
  baseURL: http://localhost:3000/shop-api
  tags:
  - GraphQL
  - Storefront
  - Shop
  - Cart
  - Checkout
  - Customer
  properties:
  - type: Documentation
    url: https://docs.vendure.io/reference/graphql-api/shop/queries/
  - type: OpenAPI
    url: openapi/vendure-shop-api-openapi.yml
  - type: JSONSchema
    url: json-schema/vendure-product-schema.json
  - type: JSONSchema
    url: json-schema/vendure-order-schema.json
  - url: graphql/vendure-graphql.md
    type: GraphQL
- aid: vendure:admin-api
  name: Vendure Admin GraphQL API
  description: >-
    Privileged GraphQL API consumed by the Vendure Dashboard and back-office tooling — catalogue, channels, orders,
    customers, customer groups, fulfillment, promotions, tax categories and rates, zones and countries, sellers, stock
    locations, payment methods, shipping methods, administrators, roles, API keys, jobs and scheduled tasks, and
    global settings. Mounted by default at /admin-api on the Vendure server.
  humanURL: https://docs.vendure.io/reference/graphql-api/admin/queries/
  baseURL: http://localhost:3000/admin-api
  tags:
  - GraphQL
  - Admin
  - Back-Office
  - Catalog
  - Orders
  - Customers
  properties:
  - type: Documentation
    url: https://docs.vendure.io/reference/graphql-api/admin/queries/
  - type: OpenAPI
    url: openapi/vendure-admin-api-openapi.yml
  - type: JSONSchema
    url: json-schema/vendure-product-schema.json
  - type: JSONSchema
    url: json-schema/vendure-order-schema.json
  - type: JSONSchema
    url: json-schema/vendure-customer-schema.json
- aid: vendure:asset-server
  name: Vendure Asset Server REST API
  description: >-
    REST surface exposed by the AssetServerPlugin. Serves images and binary assets uploaded through the Admin API;
    supports preview transforms via query parameters (preset, w, h, mode, format) and acts as the storage backend for
    product, collection, and rich-text assets.
  humanURL: https://docs.vendure.io/
  baseURL: http://localhost:3000/assets
  tags:
  - REST
  - Assets
  - Images
  - Storage
  properties:
  - type: Documentation
    url: https://docs.vendure.io/
  - type: OpenAPI
    url: openapi/vendure-asset-server-openapi.yml
tools:
- aid: vendure:core
  name: '@vendure/core'
  description: >-
    The Vendure server framework. A NestJS application with TypeORM persistence, GraphQL Shop and Admin APIs, plugin
    system, job queue, event bus, and configuration interfaces for custom payment, shipping, tax, search, and auth
    strategies. GPLv3-licensed.
  humanURL: https://docs.vendure.io/guides/getting-started/installation/
  baseURL: https://github.com/vendurehq/vendure
  tags:
  - Framework
  - Server
  - NestJS
  - TypeScript
  - TypeORM
  properties:
  - type: Repository
    url: https://github.com/vendurehq/vendure
  - type: Package
    url: https://www.npmjs.com/package/@vendure/core
  - type: Documentation
    url: https://docs.vendure.io/guides/getting-started/installation/
  - type: License
    url: https://github.com/vendurehq/vendure/blob/master/LICENSE
- aid: vendure:create
  name: '@vendure/create'
  description: >-
    Project scaffolding CLI invoked via `npx @vendure/create`. Provisions a new Vendure server project with chosen
    database, sample data, and starter plugins.
  humanURL: https://docs.vendure.io/guides/getting-started/installation/
  baseURL: https://www.npmjs.com/package/@vendure/create
  tags:
  - CLI
  - Scaffolding
  - Developer Experience
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/create
  - type: Documentation
    url: https://docs.vendure.io/guides/getting-started/installation/
- aid: vendure:cli
  name: '@vendure/cli'
  description: >-
    Developer CLI for generating plugins, entities, services, API extensions, and database migrations inside an
    existing Vendure project.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/cli
  tags:
  - CLI
  - Codegen
  - Migrations
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/cli
  - type: Documentation
    url: https://docs.vendure.io/
- aid: vendure:dashboard
  name: '@vendure/dashboard'
  description: >-
    Official React-based admin UI for Vendure, built against the Admin GraphQL API. Covers catalog, orders, customers,
    promotions, settings, and surfaces contributed by plugins.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/dashboard
  tags:
  - Dashboard
  - Admin UI
  - React
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/dashboard
  - type: Documentation
    url: https://docs.vendure.io/
- aid: vendure:asset-server-plugin
  name: '@vendure/asset-server-plugin'
  description: >-
    Plugin that turns the Vendure server into an asset host. Provides REST upload endpoints, local or S3-backed
    storage, and on-the-fly image transforms (resize, format, presets).
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/asset-server-plugin
  tags:
  - Plugin
  - Assets
  - Storage
  - Images
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/asset-server-plugin
  - type: OpenAPI
    url: openapi/vendure-asset-server-openapi.yml
- aid: vendure:email-plugin
  name: '@vendure/email-plugin'
  description: >-
    Transactional email plugin. Subscribes to Vendure events and renders Handlebars/MJML templates for order
    confirmations, password resets, account verification, and other lifecycle messages.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/email-plugin
  tags:
  - Plugin
  - Email
  - Notifications
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/email-plugin
- aid: vendure:job-queue-plugin
  name: '@vendure/job-queue-plugin'
  description: >-
    Production job queue plugin with BullMQ/Redis backends. Replaces the default in-memory queue and surfaces job
    state to the Admin API.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/job-queue-plugin
  tags:
  - Plugin
  - Jobs
  - Queue
  - Redis
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/job-queue-plugin
- aid: vendure:harden-plugin
  name: '@vendure/harden-plugin'
  description: >-
    Production hardening plugin. Disables introspection, limits query complexity and depth, hides internal error
    details, and applies additional guards to the public GraphQL endpoints.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/harden-plugin
  tags:
  - Plugin
  - Security
  - GraphQL
  - Hardening
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/harden-plugin
- aid: vendure:graphiql-plugin
  name: '@vendure/graphiql-plugin'
  description: >-
    Developer plugin that mounts a GraphiQL explorer against the Shop and Admin GraphQL endpoints for interactive
    query authoring and schema browsing.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/graphiql-plugin
  tags:
  - Plugin
  - GraphiQL
  - Developer Experience
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/graphiql-plugin
- aid: vendure:telemetry-plugin
  name: '@vendure/telemetry-plugin'
  description: >-
    OpenTelemetry instrumentation plugin emitting traces and metrics from the Vendure server, plugins, and job queue
    for production observability.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/telemetry-plugin
  tags:
  - Plugin
  - OpenTelemetry
  - Observability
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/telemetry-plugin
- aid: vendure:testing
  name: '@vendure/testing'
  description: >-
    End-to-end testing harness for Vendure servers and plugins. Bootstraps an isolated Vendure instance with seed data
    and exposes typed GraphQL clients against the Shop and Admin APIs.
  humanURL: https://docs.vendure.io/
  baseURL: https://www.npmjs.com/package/@vendure/testing
  tags:
  - Testing
  - Plugin
  - Developer Experience
  properties:
  - type: Package
    url: https://www.npmjs.com/package/@vendure/testing
- aid: vendure:storefront-remix-starter
  name: Storefront Remix Starter
  description: >-
    Reference storefront built with Remix on top of the Vendure Shop API. Demonstrates catalog browse, search, cart,
    checkout, payment, and account flows.
  humanURL: https://github.com/vendurehq/storefront-remix-starter
  baseURL: https://github.com/vendurehq/storefront-remix-starter
  tags:
  - Storefront
  - Remix
  - Starter
  properties:
  - type: Repository
    url: https://github.com/vendurehq/storefront-remix-starter
- aid: vendure:storefront-qwik-starter
  name: Storefront Qwik Starter
  description: Storefront starter built with Qwik against the Vendure Shop API.
  humanURL: https://github.com/vendurehq/storefront-qwik-starter
  baseURL: https://github.com/vendurehq/storefront-qwik-starter
  tags:
  - Storefront
  - Qwik
  - Starter
  properties:
  - type: Repository
    url: https://github.com/vendurehq/storefront-qwik-starter
- aid: vendure:nextjs-starter
  name: Next.js Starter
  description: >-
    Official Next.js 16 storefront starter for Vendure. Includes catalog, cart, checkout, and account flows on top of
    the Shop GraphQL API.
  humanURL: https://github.com/vendurehq/nextjs-starter-vendure
  baseURL: https://github.com/vendurehq/nextjs-starter-vendure
  tags:
  - Storefront
  - Next.js
  - Starter
  properties:
  - type: Repository
    url: https://github.com/vendurehq/nextjs-starter-vendure
- aid: vendure:storefront-angular-starter
  name: Storefront Angular Starter
  description: Angular PWA storefront example for Vendure.
  humanURL: https://github.com/vendurehq/storefront-angular-starter
  baseURL: https://github.com/vendurehq/storefront-angular-starter
  tags:
  - Storefront
  - Angular
  - Starter
  properties:
  - type: Repository
    url: https://github.com/vendurehq/storefront-angular-starter
- aid: vendure:storefront-sveltekit-starter
  name: Storefront SvelteKit Starter
  description: SvelteKit storefront starter for Vendure.
  humanURL: https://github.com/vendurehq/storefront-sveltekit-starter
  baseURL: https://github.com/vendurehq/storefront-sveltekit-starter
  tags:
  - Storefront
  - SvelteKit
  - Starter
  properties:
  - type: Repository
    url: https://github.com/vendurehq/storefront-sveltekit-starter
- aid: vendure:community-plugins
  name: Community Plugins
  description: >-
    Community-maintained plugins extending Vendure with payments (Braintree, Stripe), search (Algolia, Elasticsearch,
    Typesense), email providers, asset storage backends, ERP and CRM integrations, and country/region specialisations.
  humanURL: https://github.com/vendurehq/community-plugins
  baseURL: https://github.com/vendurehq/community-plugins
  tags:
  - Plugins
  - Extensions
  - Integrations
  - Community
  properties:
  - type: Repository
    url: https://github.com/vendurehq/community-plugins
  - type: Documentation
    url: https://docs.vendure.io/current/community-plugins/braintree-plugin
- aid: vendure:platform
  name: Vendure Platform
  description: >-
    Commercial enterprise capability layer on top of Vendure Core. Adds 20+ enterprise plugins (advanced B2B, contract
    pricing, SSO, audit, governance), a production-ready Next.js storefront, AI tooling, dedicated support, and a
    commercial license alternative to GPLv3.
  humanURL: https://docs.vendure.io/current/platform/getting-started/introduction
  baseURL: https://vendure.io/platform
  tags:
  - Commercial
  - Enterprise
  - Platform
  - B2B
  properties:
  - type: Documentation
    url: https://docs.vendure.io/current/platform/getting-started/introduction
  - type: ProductPage
    url: https://vendure.io/platform
  - type: Pricing
    url: https://vendure.io/pricing
- aid: vendure:cloud
  name: Vendure Cloud
  description: >-
    Managed hosting for Vendure (Core or Platform). Provides auto-scaling, automated backups, multi-region
    deployments, EU data residency, monitoring and observability. Available for design partners with GA Q4 2026.
  humanURL: https://vendure.io/cloud
  baseURL: https://vendure.io/cloud
  tags:
  - Hosted
  - Managed
  - Cloud
  - SaaS
  properties:
  - type: ProductPage
    url: https://vendure.io/cloud
  - type: Pricing
    url: https://vendure.io/pricing
- aid: vendure:docs-mcp
  name: Vendure Docs MCP Server
  description: >-
    Official remote Model Context Protocol server exposing the Vendure documentation to LLM coding assistants (Claude
    Code, Cursor, VS Code, Windsurf) for grounded code generation against Vendure APIs and plugin patterns.
  humanURL: https://docs.vendure.io/mcp
  baseURL: https://docs.vendure.io/mcp
  tags:
  - MCP
  - AI
  - LLM
  - Documentation
  properties:
  - type: Endpoint
    url: https://docs.vendure.io/mcp
  - type: Repository
    url: https://github.com/vendurehq/mcp
common:
- type: Website
  url: https://vendure.io/
- type: Documentation
  url: https://docs.vendure.io/
- type: GitHub
  url: https://github.com/vendurehq
- type: Repository
  url: https://github.com/vendurehq/vendure
- type: Platform
  url: https://vendure.io/platform
- type: Cloud
  url: https://vendure.io/cloud
- type: Pricing
  url: https://vendure.io/pricing
- type: Hub
  url: https://vendure.io/hub
- type: LinkedIn
  url: https://www.linkedin.com/company/vendure
- type: LLMsTxt
  url: https://docs.vendure.io/llms.txt
- type: MCP
  url: https://docs.vendure.io/mcp
- type: License
  url: https://github.com/vendurehq/vendure/blob/master/LICENSE
- type: Plans
  url: plans/vendure-plans-pricing.yml
- type: RateLimits
  url: rate-limits/vendure-rate-limits.yml
- type: FinOps
  url: finops/vendure-finops.yml
- type: JSONLD
  url: json-ld/vendure-context.jsonld
- type: Vocabulary
  url: vocabulary/vendure-vocabulary.yml
- type: Rules
  url: rules/vendure-rules.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com