Medusa
Medusa is an open-source, MIT-licensed digital commerce platform built around a modular architecture: a suite of Commerce Modules (cart, products, orders, pricing, promotions, tax, inventory, fulfillment, payment), a Framework for building custom API routes, data models, workflows and integrations, and a customizable Medusa Admin dashboard. Medusa ships two first-party REST APIs — a Store API for storefronts and an Admin API for merchant operations — both documented with published OpenAPI 3.0 specifications generated from the codebase. Medusa is self-hosted by default; MedusaJS, Inc. also operates Medusa Cloud, a managed PaaS, and a remote MCP server plus published Claude Code agent skills for agentic development.
Medusa publishes 73 APIs on the APIs.io network, including Api Keys API, Auth API, [auth Provider] API, and 70 more. Tagged areas include E-Commerce, Headless Commerce, Open-Source, Commerce, and Storefront.
The Medusa catalog on APIs.io includes 1 event-driven AsyncAPI specification.
Medusa’s developer surface includes documentation, API reference, getting-started guide, support, engineering blog, pricing, signup flow, and 38 more developer resources.
2 APIs
1 MCP Servers
Business capabilities this provider's published APIs can perform, derived from its own
contracts. Browse all capabilities →
Individual APIs this provider publishes, each with its own machine-readable definition.
Medusa's GraphQL surface over the store data core. The schema in this repo was derived from the OAS output schemas published in the medusajs/medusa repository; Medusa does not p...
Medusa hosts a Streamable HTTP Model Context Protocol server at https://docs.medusajs.com/mcp. It exposes the Medusa documentation to coding agents plus curated implementation-g...
API keys can be used for authentication or resource-scoping. A secret API key can be used to authenticate admin users. A publishable API key can be used to scope client requests...
Auth API routes allow you to manage an admin user's authentication.
The [auth_provider] API from Medusa — 1 operation(s) for [auth_provider].
A campaign is a group of promotions that have the same conditions, such as start and end dates. These API routes allow admin users to manage campaigns, their conditions, and pro...
A cart is a virtual shopping bag that customers can use to add items they want to purchase. A cart is then used to checkout and place an order. These API routes allow customers ...
An admin creates a claim for an order when a customer reports that an item is defective or incorrect. Using these API routes, admin users manage order claims, their items, and m...
A product collection organizes products into a collection for marketing purposes. For example, a summer collection. These API routes allow admin users to manage collections and ...
A store can use unlimited currencies, and each region must be associated with at least one currency. Currencies are defined by the Currency Module. Currency API Routes allow adm...
Customers can be organized into groups. These groups are useful for segregation and marketing purposes. For example, you can provide different prices for specific customers by c...
Customers can either be created when they register through the Store APIs, or created by the admin using the Admin APIs. These API routes allow admin users to manage customers i...
A draft order is an order created by the admin user. This is useful for orders created offline or from clients other than a storefront, such as a third-party integration. These ...
An exchange is the replacement of an item that the customer ordered with another. These API routes allow admin users to create and manage exchanges.
Feature flags are used to enable or disable certain features in your Medusa application. These API routes allow admin users to view feature flags.
A fulfillment provider is a third-party integration or custom logic used to fulfill an order's items. Fulfillment providers are installed as module providers.
A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up". All fulfillment-related configurations in a store are related to a fulfillment set. T...
A fulfillment is created for items in an order, return, exchanges, or claims to deliver items to/from the customer. These API routes allow admin users to manage fulfillments.
A gift card is a prepaid card that can be used to pay for items during checkout. Gift cards can be purchased by customers, or created by admin users. When a gift card is redeeme...
The Index Module is a tool to perform high-performance queries across modules, for example, to filter linked modules. The Index Module is currently experimental and is hidden be...
An inventory item is a stock-kept product whose inventory is managed. These API routes allow admin users to manage inventory items.
An admin can invite new users to manage their team. This allows new users to authenticate as admins and perform admin functionalities. These API routes allow admin users to mana...
An admin can modify the layout of their admin dashboard. This allows admins to customize their dashboard to their preferences and needs. These API routes allow admin users to ma...
A locale is a language that content is translated into for customers to view in a storefront. Medusa installs locales by default. These API routes allow admin users to retrieve ...
Multi-factor authentication (MFA) adds an extra layer of security to admin accounts by requiring additional verification factors during login, such as a TOTP code or a recovery ...
Multi-factor authentication (MFA) factors are additional ways to verify a customer's identity during login, in addition to their password. Examples of MFA factors include authen...
A notification informs an admin user of store changes or status changes of background tasks. These API routes allow admin users to view and manage notifications.
An order change is a proposed change to an order, such as adding or removing items, changing shipping methods, and more. They can be associated with order edits, claims, or exch...
An order edit is a change to an order's details, such as items, shipping methods, and more. Changes made by an order edit are only applied on the order once they're confirmed. T...
An order is a purchase made by a customer through a storefront. Orders can also originally be created as draft orders. These API routes allow admin users to view and manage orders.
A payment collection is one or more payments of an order. They're also used for outstanding payments due to order exchanges or claims. Every purchase or request for payment star...
Each region has a set of payment providers enabled. During checkout, you retrieve the available payment providers in the customer's region to show them to the customer. Customer...
A payment is created when a payment amount is authorized. The payment can then be captured or refunded. A payment is created from the payment session that was authorized, and it...
A plugin is a package of reusable Medusa customizations that you can install in any Medusa application. Plugins can be used to add new functionality, such as wishlists, or integ...
A price list is a group of prices applied if the specified conditions and rules are satisfied. Price lists are useful for sales or special prices for special conditions, such as...
A price preference is used to specify whether tax-inclusiveness is enabled for a context, such as a region or currency code. These API routes allow admin users to manage whether...
Products can be categorized into categories. Categories are nested and their heirarchy can be managed, giving admin users flexibility in how they categorize their products. Thes...
A product option is a way to define different options for a product, such as "Size" or "Color". Product options can be created globally and used by multiple products, or they ca...
A tag is another way of organizing a product. Each tag has a name and a value. Products are organized into the same tag if they have the same value. These API routes allow admin...
Products can be organized into types. Each type has a name and a value. Products are organized into the same type if they have the same value. These API routes allow admin users...
A product variant is a saleable form of the product. Each variant has different option values. For example, a "Shirt" product may have a "Blue" variant and a "Green" variant. Cu...
A product is a set of variants that the customer chooses from when making a purchase. A product can be organized into categories or collections. A product can have many options,...
A promotion discounts an amount or percentage off a cart's items, shipping methods, or the entire order. Promotions have different types, such as a `standard` promotion that jus...
The Property Labels API from Medusa — 3 operation(s) for property labels.
A refund reason is a possible reason used when issuing a refund to the customer, such as when returning an item and refunding the customer. These API routes allow admin users to...
Regions are different countries or geographical regions that the commerce store serves customers in. These API routes allow admin users to manage regions, their providers, and m...
A reservation is unavailable quantity of an inventory item in a location. A reservation is created automatically for variants in an order whose `manage_inventory` is enabled. Ad...
A return reason is a possible reason that an item is returned from the customer, such as when returning an item. These API routes allow admin users to manage return reasons.
Admin users create a return when a customer returns an item to them. Returns can also be created by customers through the storefront, and admins will be able to manage them and ...
A sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app. These API routes allow admins to manage sales channels and the product...
The Search API from Medusa — 1 operation(s) for search.
Shipping option types define a group of shipping options with shared shipping characterstics. For example, you may have "Standard" and "Express" shipping option types. These API...
A shipping option is a way of shipping an item to or from the customer. Shipping options are associated with the fulfillment provider used to handle their fulfillment. Shipping ...
A shipping profile defines a type of items that are shipping in a similar manner. For example, digital products may have a `digital` shipping profile. These API routes allow adm...
A stock location is where stock-kept items (products) are kept. Stock locations are linked to fulfillment providers used to fulfill items from this location. A stock location is...
A store credit account is a ledger of store credit transactions for a customer. They hold the customer's store credit balance, including their credit and debit amounts. Store cr...
A store holds the main configuration and information of your commerce store, such as supported currencies or default sales channel. By default, the Medusa application has one de...
A tax provider is a third-party integration or custom logic used to calculate taxes for a cart or an order. These API routes allow admin users to manage tax providers installed ...
A tax rate is a percentage amount used to calculate the tax amount of each taxable item's price, such as line items or shipping methods. Each tax region has a default tax rate. ...
A tax region is a region's tax settings. It has tax rates and rules. So, after you create a region, you must create a tax region for it. A tax region can extend settings from a ...
A translation is a localized version of content in a specific locale. For example, a product description in French. These API routes allow admin users to manage translations for...
Use these API routes to upload files to your Medusa application using the installed file module provider. You can upload public files, such as product images, or private files, ...
A user is an admin user that can authenticate and perform functionalities as an admin user. An admin user can invite other users to join their team. Once they accept the invite,...
A view configuration is a saved data-table view for an entity, such as products or orders. It lets admin users customize how a table shows its data, then save that customization...
These API routes allow you to track workflow executions in your Medusa application. Depending on the workflow engine you use, executions may only be retained for a short while, ...
Official TypeScript / JavaScript SDK wrapping the Store and Admin REST APIs - typed clients, auth helpers, and ergonomic resource methods. Distributed via npm as @medusajs/js-sd...
Server-side framework primitives for extending Medusa - custom API Routes, Modules with their own data models (DML), Module Links, Workflows for transactional business logic, Su...
First-party domain modules that compose into a Medusa application - Cart, Payment, Customer, Pricing, Promotion, Product, Order, Inventory, Fulfillment, Stock Location, Region, ...
Command-line tooling for scaffolding new Medusa projects, generating modules and migrations, running the server in dev, and managing common project tasks.
Reference Next.js storefront talking to the Medusa Store API - cart, checkout, account, product browse, payments, and search. Used as the canonical starting point for headless s...
Remote Model Context Protocol server exposing the Medusa documentation to LLM-powered coding assistants - lets agents look up commerce modules, framework concepts, and APIs whil...
Monorepo with the Medusa server, Admin, Commerce Modules, Framework, and packages. MIT-licensed reference for self-hosting and for building modules and plugins.
The Auth API from Medusa — 2 operation(s) for auth.
The Carts API from Medusa — 3 operation(s) for carts.
The Categories API from Medusa — 1 operation(s) for categories.
The Collections API from Medusa — 1 operation(s) for collections.
The Customers API from Medusa — 2 operation(s) for customers.
The Orders API from Medusa — 2 operation(s) for orders.
The Payments API from Medusa — 1 operation(s) for payments.
The Products API from Medusa — 2 operation(s) for products.
The Regions API from Medusa — 2 operation(s) for regions.
The Shipping API from Medusa — 1 operation(s) for shipping.
Model Context Protocol servers that expose these APIs to AI agents.
GraphQL schemas published by this provider.
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
aid: medusa
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: false
label: Hosted service · you call their endpoint
confidence: medium
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
specificationVersion: '0.23'
accessModel:
pricing: paid
onboarding: self-serve
trial: false
try_now: false
public: false
label: Paid · Self-serve signup
confidence: high
source:
- plans
- authentication
- scopes
- rate-limits
- security
- sandbox
generated: '2026-08-26'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/medusa.png
url: https://raw.githubusercontent.com/api-evangelist/medusa/refs/heads/main/apis.yml
name: Medusa
type: Index
tags:
- E-Commerce
- Headless Commerce
- Open-Source
- Commerce
- Storefront
- Order Management
- Node.js
- GraphQL
- Agentic Commerce
- MCP
tags_raw:
- E-Commerce
- Headless Commerce
- Open Source
- Commerce
- Storefront
- Order Management
- Node.js
- GraphQL
- Agentic Commerce
- MCP
description: 'Medusa is an open-source, MIT-licensed digital commerce platform built around a modular architecture: a suite
of Commerce Modules (cart, products, orders, pricing, promotions, tax, inventory, fulfillment, payment), a Framework for
building custom API routes, data models, workflows and integrations, and a customizable Medusa Admin dashboard. Medusa ships
two first-party REST APIs — a Store API for storefronts and an Admin API for merchant operations — both documented with
published OpenAPI 3.0 specifications generated from the codebase. Medusa is self-hosted by default; MedusaJS, Inc. also
operates Medusa Cloud, a managed PaaS, and a remote MCP server plus published Claude Code agent skills for agentic development.'
apis:
- aid: medusa:medusa-graphql-api
name: Medusa GraphQL API
tags:
- GraphQL
- E-Commerce
- Headless
humanURL: https://docs.medusajs.com
baseURL: https://{medusa-backend-domain}/store/graphql
properties:
- url: graphql/medusa-graphql.md
type: GraphQL
description: Medusa's GraphQL surface over the store data core. The schema in this repo was derived from the OAS output
schemas published in the medusajs/medusa repository; Medusa does not publish a hosted, introspectable GraphQL endpoint
of its own because every Medusa application is self-hosted.
- aid: medusa:medusa-mcp-server
name: Medusa MCP Remote Server
description: Medusa hosts a Streamable HTTP Model Context Protocol server at https://docs.medusajs.com/mcp. It exposes the
Medusa documentation to coding agents plus curated implementation-guide tools for data migration from Shopify/WooCommerce/Magento,
payment and fulfillment provider integration, product extension, version upgrades and feedback submission. Access is limited
to Medusa Cloud accounts and is authenticated with OAuth 2.1 (RFC 9728 protected resource) or a Cloud personal access
key.
tags:
- MCP
- Agentic Commerce
- Documentation
- Artificial Intelligence
tags_raw:
- MCP
- Agentic Commerce
- Documentation
- AI
humanURL: https://docs.medusajs.com/learn/introduction/build-with-llms-ai/mcp-server
baseURL: https://docs.medusajs.com/mcp
properties:
- type: Documentation
url: https://docs.medusajs.com/learn/introduction/build-with-llms-ai/mcp-server
- type: MCPServer
url: mcp/medusa-mcp.yml
- type: ToolCrosswalk
url: mcp/medusa-tool-crosswalk.yml
- aid: medusa:medusa-api-keys-api
name: Medusa Api Keys API
description: 'API keys can be used for authentication or resource-scoping.
A secret API key can be used to authenticate admin users. A publishable API key can be used to scope client requests
to one or more sales channels.
These API routes allow admin users to manage both publishable and secret API keys.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- APIKeys
tags_raw:
- Api Keys
properties:
- type: OpenAPI
url: openapi/medusa-api-keys-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-auth-api
name: Medusa Auth API
description: Auth API routes allow you to manage an admin user's authentication.
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Authentication
tags_raw:
- Auth
properties:
- type: OpenAPI
url: openapi/medusa-auth-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-auth-provider-api
name: Medusa [auth Provider] API
description: The [auth_provider] API from Medusa — 1 operation(s) for [auth_provider].
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- '[auth_provider]'
properties:
- type: OpenAPI
url: openapi/medusa-auth-provider-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-campaigns-api
name: Medusa Campaigns API
description: 'A campaign is a group of promotions that have the same conditions, such as start and end dates.
These API routes allow admin users to manage campaigns, their conditions, and promotions that belong to them.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Campaigns
properties:
- type: OpenAPI
url: openapi/medusa-campaigns-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-carts-api
name: Medusa Carts API
description: 'A cart is a virtual shopping bag that customers can use to add items they want to purchase.
A cart is then used to checkout and place an order.
These API routes allow customers to create and manage their cart, and place an order.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Cart
tags_raw:
- Carts
properties:
- type: OpenAPI
url: openapi/medusa-carts-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-claims-api
name: Medusa Claims API
description: 'An admin creates a claim for an order when a customer reports that an item is defective or incorrect.
Using these API routes, admin users manage order claims, their items, and more.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Claims
properties:
- type: OpenAPI
url: openapi/medusa-claims-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-collections-api
name: Medusa Collections API
description: 'A product collection organizes products into a collection for marketing purposes. For example, a summer collection.
These API routes allow admin users to manage collections and the products in them.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Collection
tags_raw:
- Collections
properties:
- type: OpenAPI
url: openapi/medusa-collections-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-currencies-api
name: Medusa Currencies API
description: 'A store can use unlimited currencies, and each region must be associated with at least one currency.
Currencies are defined by the Currency Module. Currency API Routes allow admins to list and update currencies.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Currency
tags_raw:
- Currencies
properties:
- type: OpenAPI
url: openapi/medusa-currencies-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-customer-groups-api
name: Medusa Customer Groups API
description: 'Customers can be organized into groups. These groups are useful for segregation and marketing purposes.
For example, you can provide different prices for specific customers by creating a price list conditioned to their group.
These API routes allow admin users to manage groups and the customers in them.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Customer Groups
properties:
- type: OpenAPI
url: openapi/medusa-customer-groups-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-customers-api
name: Medusa Customers API
description: 'Customers can either be created when they register through the Store APIs, or created by the admin using the
Admin APIs.
These API routes allow admin users to manage customers in their store.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Customers
properties:
- type: OpenAPI
url: openapi/medusa-customers-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-draft-orders-api
name: Medusa Draft Orders API
description: 'A draft order is an order created by the admin user. This is useful for orders created offline or from clients
other than a storefront, such as a third-party integration.
These API routes allow admin users to create and manage draft orders.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Draft Orders
properties:
- type: OpenAPI
url: openapi/medusa-draft-orders-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-exchanges-api
name: Medusa Exchanges API
description: 'An exchange is the replacement of an item that the customer ordered with another.
These API routes allow admin users to create and manage exchanges.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Exchanges
properties:
- type: OpenAPI
url: openapi/medusa-exchanges-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-feature-flags-api
name: Medusa Feature Flags API
description: 'Feature flags are used to enable or disable certain features in your Medusa application.
These API routes allow admin users to view feature flags.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Feature Flags
properties:
- type: OpenAPI
url: openapi/medusa-feature-flags-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-fulfillment-providers-api
name: Medusa Fulfillment Providers API
description: 'A fulfillment provider is a third-party integration or custom logic used to fulfill an order''s items.
Fulfillment providers are installed as module providers.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Fulfillment Providers
properties:
- type: OpenAPI
url: openapi/medusa-fulfillment-providers-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-fulfillment-sets-api
name: Medusa Fulfillment Sets API
description: 'A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up".
All fulfillment-related configurations in a store are related to a fulfillment set.
These API routes allow admin users to manage fulfillment sets.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Fulfillment Sets
properties:
- type: OpenAPI
url: openapi/medusa-fulfillment-sets-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-fulfillments-api
name: Medusa Fulfillments API
description: 'A fulfillment is created for items in an order, return, exchanges, or claims to deliver items to/from the
customer.
These API routes allow admin users to manage fulfillments.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Fulfillments
properties:
- type: OpenAPI
url: openapi/medusa-fulfillments-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-gift-cards-api
name: Medusa Gift Cards API
description: 'A gift card is a prepaid card that can be used to pay for items during checkout.
Gift cards can be purchased by customers, or created by admin users. When a gift card is redeemed, its amount is added
to the customer''s store credit account, which can then be used to pay for items during checkout.
These API routes allow admin users to manage gift cards, transfer gift cards between customers, and more.
<Note>
Gift Card routes are only available through the [Loyalty Plugin](https://docs.medusajs.com/resources/commerce-modules/loyalty).
</Note>'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Gift Cards
properties:
- type: OpenAPI
url: openapi/medusa-gift-cards-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-index-api
name: Medusa Index API
description: 'The Index Module is a tool to perform high-performance queries across modules, for example, to filter linked
modules.
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how to enable
it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Index
properties:
- type: OpenAPI
url: openapi/medusa-index-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-inventory-items-api
name: Medusa Inventory Items API
description: 'An inventory item is a stock-kept product whose inventory is managed.
These API routes allow admin users to manage inventory items.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Inventory Items
properties:
- type: OpenAPI
url: openapi/medusa-inventory-items-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-invites-api
name: Medusa Invites API
description: 'An admin can invite new users to manage their team. This allows new users to authenticate as admins and perform
admin functionalities.
These API routes allow admin users to manage invites.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Invites
properties:
- type: OpenAPI
url: openapi/medusa-invites-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-layouts-api
name: Medusa Layouts API
description: 'An admin can modify the layout of their admin dashboard. This allows admins to customize their dashboard to
their preferences and needs.
These API routes allow admin users to manage layouts.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Layouts
properties:
- type: OpenAPI
url: openapi/medusa-layouts-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-locales-api
name: Medusa Locales API
description: 'A locale is a language that content is translated into for customers to view in a storefront.
Medusa installs locales by default. These API routes allow admin users to retrieve and view locales.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Locales
properties:
- type: OpenAPI
url: openapi/medusa-locales-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-multi-factor-authentication-api
name: Medusa Multi-Factor Authentication API
description: 'Multi-factor authentication (MFA) adds an extra layer of security to admin accounts by requiring additional
verification factors during login, such as a TOTP code or a recovery code.
These API routes allow admin users to manage their MFA factors, challenges, and recovery codes.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
tags:
- Multi-Factor Authentication
properties:
- type: OpenAPI
url: openapi/medusa-multi-factor-authentication-api-openapi.yml
- type: Documentation
url: https://docs.medusajs.com/api/store
- type: APIReference
url: https://docs.medusajs.com/api/store
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/store/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/store#authentication
- type: Documentation
url: https://docs.medusajs.com/api/admin
- type: APIReference
url: https://docs.medusajs.com/api/admin
- type: OpenAPI Source
url: https://raw.githubusercontent.com/medusajs/medusa/develop/www/apps/api-reference/specs/admin/openapi.full.yaml
- type: Authentication
url: https://docs.medusajs.com/api/admin#authentication
- aid: medusa:medusa-multi-factor-authentication-mfa-factors-api
name: Medusa Multi-Factor Authentication (MFA) Factors API
description: 'Multi-factor authentication (MFA) factors are additional ways to verify a customer''s identity during login,
in addition to their password. Examples of MFA factors include authenticator apps, SMS messages, and email.
These API routes allow customers to manage their MFA factors, such as enabling an authenticator app or generating recovery
codes.'
humanURL: https://docs.medusajs.com/api/store
baseURL: https://{medusa-backend-domain}
# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/medusa/refs/heads/main/apis.yml
Every provider here is available over the APIs.io API and to AI agents over MCP.
Kin Score
How this is scored →