How do AI agents use Medusa Admin through Open Connector?

Your user connects Medusa Admin once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Medusa Admin tools to your agent over MCP or a typed API, with credentials injected server-side on each call.

Is this a Medusa Admin MCP server?

Yes. Open Connector can serve Medusa Admin as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Medusa Admin actions with credentials injected server-side.

Where do Medusa Admin credentials live?

In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Medusa Admin integration

Medusa Admin integration for AI agents.

Medusa Admin integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Medusa Admin tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHub All integrations →

What your agents can do

Real Medusa Admin actions, managed and audited.

Your user connects Medusa Admin once; your agent can then manage Medusa commerce stores through the v2 Admin API — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

1
Your user grants Medusa Admin access once (OAuth) — the token lands in the vault.
2
Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.
3
Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Medusa Admin tools.

384 tools are generated from the published Medusa Admin catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 384 tools. All published catalog entries are included in this page's server-rendered HTML.

Delete a Campaign: Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign.; Campaigns
Remove a Claim Item from a Claim: Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Remove an Inbound Item from Claim: Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Remove Inbound Shipping Method from Claim: Remove the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Remove an Outbound Item from Claim: Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Remove Outbound Shipping Method from Claim: Remove the shipping method for delivering outbound items in the claim using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Cancel Claim Request: Cancel a requested claim.; Claims
Delete a Collection: Delete a product collection.; Collections
Delete a Customer Group: Delete a customer group. Customers in the group aren't deleted.; Customer Groups
Delete a Customer: Delete a customer.; Customers
Remove an Address from Customer: Remove a customer's address.; Customers
Delete a Draft Order: Delete a draft order.; Draft Orders
Cancel Edit on Draft Order: Cancel an unconfirmed edit on a draft order.; Draft Orders
Remove Item from Draft Order Edit: Remove an order item from a draft order edit by the ID of the item's `ITEM_ADD` or `ITEM_UPDATE` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Draft Orders
Remove Promotions from Draft Order Edit: Remove specified promotions from a draft order edit.; Draft Orders
Remove New Shipping Method from Draft Order: Remove a shipping method that was added to a draft order edit using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Draft Orders
Remove Shipping Method from Draft Order Edit: Remove an existing shipping method from a draft order edit.; Draft Orders
Remove Inbound Item from Exchange: Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Remove Inbound Shipping Method from Exchange: Remove the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Remove Outbound Item from Exchange: Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Remove Outbound Shipping Method from Exchange: Remove the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Cancel Exchange Request: Cancel a requested exchange.; Exchanges
Delete Fulfillment Set: Delete a fulfillment set.; Fulfillment Sets
Remove a Service Zone from Fulfillment Set: Remove a service zone that belongs to a fulfillment set.; Fulfillment Sets
Delete Inventory Item: Delete an inventory item.; Inventory Items
Remove Inventory Level of Inventory Item: Remove the inventory level of an inventory item. If the inventory level has reserved quantity greater than `0`, an error is thrown.; Inventory Items
Delete Invite: Delete an invite.; Invites
Clear Configuration of Layout: Clears all user layout configurations for a given zone. This action will remove any customizations made by the user and revert to the system defaults.; Layouts
Cancel Order Edit: Cancel a requested order edit.; Order Edits
Remove Item from Order Edit: Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Order Edits
Remove Shipping Method from Order Edit: Remove a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Order Edits
Delete a Payment Collection: Delete a payment collection.; Payment Collections
Delete a Price List: Delete a price list.; Price Lists
Delete a Price Preference: Delete a price preference.; Price Preferences
Delete a Product Category: Delete a product category. This doesn't delete the products in that category. A product category that has child categories can't be deleted, so you must delete its child categories first.; Product Categories
Delete a Product Option: Delete a product option.; Product Options
Remove Value from Product Option: Remove a Value from a product option.; Product Options
Delete a Product Tag: Delete a product tag. This doesn't delete products using the tag.; Product Tags
Delete a Product Type: Delete a product type. This doesn't delete products of this type.; Product Types
Delete a Product: Delete a product.; Products
Delete Product Variant: Delete a variant of a product.; Products
Remove Inventory Item Association with Product Variant: Remove the association between an inventory item and its product variant.; Products
Delete a Promotion: Delete a promotion.; Promotions
Delete a Property Label: Delete a property label.; Property Labels
Delete a Refund Reason: Delete a refund reason.; Refund Reasons
Delete a Region: Delete a region.; Regions
Delete a Reservation: Delete a reservation.; Reservations
Delete a Return Reason: Delete a return reason.; Return Reasons
Remove Damaged Item from Return: Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Cancel Return Receival: Cancel the receival process previously started, and hasn't been confirmed, of a return.; Returns
Remove a Received Item from Return: Remove a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Cancel Return Request: Cancel a requested return.; Returns
Remove Item from Return: Remove a requested item to be returned by the ID of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Remove Shipping Method from Return: Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Returns
Delete a Sales Channel: Delete a sales channel.; Sales Channels
Delete a Shipping Option Type: Delete a shipping option type.; Shipping Option Types
Delete a Shipping Option: Delete a shipping option.; Shipping Options
Delete a Shipping Profile: Delete a shipping profile.; Shipping Profiles
Delete a Stock Location: Delete a stock location.; Stock Locations
Delete a Tax Rate: Delete a tax rate.; Tax Rates
Remove Rule of Tax Rate: Remove a tax rate's rule.; Tax Rates
Delete a Tax Region: Delete a tax region.; Tax Regions
Delete a File: Delete a file. Uses the installed file module provider to delete the file.; Uploads
Delete a User: Delete a user.; Users
Remove View Configurations: Remove view configurations of an entity. An admin user can only delete their own configurations.; Views
List Campaigns: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated.; Campaigns
Get a Campaign: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned using the query parameters.; Campaigns
List Claims: Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated.; Claims
Get a Claim: Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned using the query parameters.; Claims
List Collections: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated.; Collections
Get a Collection: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned using the query parameters.; Collections
List Currencies: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated.; Currencies
Get a Currency: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters.; Currencies
List Customer Groups: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated.; Customer Groups
Get a Customer Group: Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned.; Customer Groups
List Customers: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated.; Customers
Get a Customer: Retrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned.; Customers
List Addresses: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like `query`. The addresses can also be paginated.; Customers
List Addresses: Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated.; Customers
List Draft Orders: Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated.; Draft Orders
Get a Draft Order: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned using the query parameters.; Draft Orders
List Exchanges: Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated.; Exchanges
Get an Exchange: Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.; Exchanges
List Feature Flags: Retrieve a list of feature flags. The feature flags can be filtered by fields such as `id`. The feature flags can also be sorted or paginated.; Feature Flags
List Fulfillment Providers: Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated.; Fulfillment Providers
List Fulfillment Options: Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.; Fulfillment Providers
Get a Service Zone in a Fulfillment Set: Retrieve a service zone that belongs to a fulfillment set. be paginated.; Fulfillment Sets
List Gift Cards: Retrieve a list of gift cards. The gift cards can be filtered by fields such as `id`. The gift cards can also be sorted or paginated.; Gift Cards
Get a Gift Card: Retrieve a gift card by its ID. You can expand the gift card's relations or select the fields that should be returned.; Gift Cards
List Gift Card's Orders: Retrieve the list of orders that a gift card was used in.; Gift Cards
Get Index Details: Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp.; Index
List Inventory Items: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated.; Inventory Items
Get a Inventory Item: Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned.; Inventory Items
List Inventory Levels: Retrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like `location_id`. The inventory levels can also be paginated.; Inventory Items
List Invites: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated.; Invites
Get an Invite: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned.; Invites
List Layout Configurations: Retrieve a list of layout configurations made by admin users. The layouts can be filtered by fields such as `id`. The layouts can also be sorted or paginated.; Layouts
List Layout Configurations: Retrieve a list of layout configurations for a specific zone. These are the configurations made by the users for their admin dashboard layouts.; Layouts
List Locales: Retrieve a list of locales. The locales can be filtered by fields such as `code`. The locales can also be sorted or paginated.; Locales
Get a Locale: Retrieve a locale by its code. You can expand the locale's relations or select the fields that should be returned.; Locales
List Notifications: Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated.; Notifications
Get a Notification: Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned.; Notifications
List Orders: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated.; Orders
Get an Order: Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned.; Orders
List Changes on an Order: Retrieve a list of changes made on an order, including returns, exchanges, etc... The changes can be filtered by fields like `created_at`. The changes can also be paginated.; Orders
List Line Items: Retrieve a list of line items in a order. The line items can be filtered by fields like FILTER FIELDS. The line items can also be paginated.; Orders
Get Preview: Retrieve a preview of an order using its associated change, such as an edit.; Orders
List Shipping Options for Order: Retrieve a list of shipping options that can be used for outbound shipping in an order. This is especially useful when adding outbound shipping to order exchanges or claims.; Orders
List Payments: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated.; Payments
Get a Payment: Retrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned.; Payments
List Payment Providers: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated.; Payments
List Plugins: Retrieve the list of plugins installed in the Medusa application.; Plugins
List Price Lists: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated.; Price Lists
Get a Price List: Retrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned.; Price Lists
List Prices for a Price List: Retrieve a list of prices in a price list. The prices can be filtered by fields like FILTER FIELDS. The prices can also be paginated.; Price Lists
List Price Preferences: Retrieve a list of price preferences. The price preferences can be filtered by fields such as `id`. The price preferences can also be sorted or paginated.; Price Preferences
Get a Price Preference: Retrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned.; Price Preferences
List Product Categories: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated.; Product Categories
Get a Product Category: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.; Product Categories
List Product Options: Retrieve a list of product options. The product options can be filtered by fields such as `id`. The product options can also be sorted or paginated.; Product Options
Get a Product Option: Retrieve a product option by its ID. You can expand the product option's relations or select the fields that should be returned.; Product Options
List Product Option Values: Retrieve a list of values in a product option. The values can be filtered by fields like `id`. The values can also be paginated.; Product Options
Get Product Option Value: Get a product option value by its ID.; Product Options
List Product Tags: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated.; Product Tags
Get a Product Tag: Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.; Product Tags
List Product Types: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated.; Product Types
Get a Product Type: Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.; Product Types
List Product Variants: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated.; Product Variants
List Products: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.; Products
Get a Product: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.; Products
List a Product's Options: Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated.; Products
List Variants of a Product: Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated.; Products
Get Variant of a Product: Retrieve a product's variant by its ID.; Products
List Promotions: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated.; Promotions
Get a Promotion: Retrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned.; Promotions
List Rules of a Promotion: Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved.; Promotions
List Rule Attribute Options of a Rule Type: Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved: - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved.; Promotions
List Rule Values Given a Rule Attribute: Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type. For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to `rules`, a list of currencies are retrieved in label-value pairs.; Promotions
List Property Labels: Retrieve a list of property labels. The property labels can be filtered by fields such as `id`. The property labels can also be sorted or paginated.; Property Labels
Get a Property Label: Retrieve a property label by its ID.; Property Labels
List Refund Reasons: Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated.; Refund Reasons
Get a Refund Reason: Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned.; Refund Reasons
List Regions: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.; Regions
Get a Region: Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.; Regions
List Reservations: Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated.; Reservations
Get a Reservation: Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned.; Reservations
List Return Reasons: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated.; Return Reasons
Get a Return Reason: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.; Return Reasons
List Returns: Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated.; Returns
Get a Return: Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned.; Returns
List Sales Channels: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated.; Sales Channels
Get a Sales Channel: Retrieve a sales channel by its ID. You can expand the sales channel's relations or select the fields that should be returned.; Sales Channels
List Search: Retrieve a list of search. The search can be filtered by fields such as `id`. The search can also be sorted or paginated.; Search
List Shipping Option Types: Retrieve a list of shipping option types. The shipping option types can be filtered by fields such as `id`. The shipping option types can also be sorted or paginated.; Shipping Option Types
Get a Shipping Option Type: Retrieve a shipping option type by its ID. You can expand the shipping option type's relations or select the fields that should be returned.; Shipping Option Types
List Shipping Options: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated.; Shipping Options
Get a Shipping Option: Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned.; Shipping Options
List Shipping Profiles: Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated.; Shipping Profiles
Get a Shipping Profile: Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned.; Shipping Profiles
List Stock Locations: Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated.; Stock Locations
Get a Stock Location: Retrieve a stock location by its ID. You can expand the stock location's relations or select the fields that should be returned.; Stock Locations
List Store Credit Accounts: Retrieve a list of store credit accounts. The store credit accounts can be filtered by fields such as `id`. The store credit accounts can also be sorted or paginated.; Store Credit Accounts
Get a Store Credit Account: Retrieve a store credit account by its ID. You can expand the store credit account's relations or select the fields that should be returned.; Store Credit Accounts
List Transactions: Retrieve a list of transactions in a store credit account. The transactions can be filtered by fields like FILTER FIELDS. The transactions can also be paginated.; Store Credit Accounts
List Stores: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated.; Stores
Get a Store: Retrieve a store by its ID. You can expand the store's relations or select the fields that should be returned.; Stores
List Tax Providers: Retrieve a list of tax providers installed in the Medusa application through Tax Module Providers. The tax providers can be filtered by fields such as `id`. The tax providers can also be sorted or paginated.; Tax Providers
List Tax Rates: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated.; Tax Rates
Get a Tax Rate: Retrieve a tax rate by its ID. You can expand the tax rate's relations or select the fields that should be returned.; Tax Rates
List Tax Regions: Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated.; Tax Regions
Get a Tax Region: Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned.; Tax Regions
List Translations: Retrieve a list of translations. The translations can be filtered by fields such as `reference_id` (For example, the ID of a product). The translations can also be sorted or paginated.; Translations
List Translatable Entities: Retrieve a list of translatable entities. The entities can be filtered by fields such as `id`. The entities can also be sorted or paginated.; Translations
List Translation Settings: Retrieve the list of translatable fields for all entities, such as products and collections. You can also filter the results by entity type or active entities.; Translations
Retrieve Translation Statistics: Get statistics on translations for specified locales and entity types. This includes overall translation progress for each entity type, and statistics for each locale within those entity types.; Translations
Get a File: Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned.; Uploads
List Users: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated.; Users
Get a User: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned.; Users
Get Logged-In User: Retrieve the logged-in user's details.; Users
List Views: Retrieve a list of views. The views can be filtered by fields such as `id`. The views can also be sorted or paginated.; Views
List Columns in View: Retrieve a list of columns in a view for an entity. The columns are retrieved for the authenticated admin user.; Views
List View Configurations: Retrieve a list of view configurations of an entity. The configurations can be filtered by fields like `id`. The configurations can also be paginated. An admin user can only retrieve their own configurations.; Views
Get Active View Configuration: Get the active view configurations for an entity. If no active view is set, `null` is returned. An admin user can only retrieve their own active configuration.; Views
Get View Configuration: Retrieve a view configuration for an entity. An admin user can only retrieve their own configurations.; Views
List Workflows Executions: Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as `id`. The workflows executions can also be sorted or paginated.; Workflows Executions
Get a Workflows Execution: Retrieve a workflows execution by its ID. You can expand the workflows execution's relations or select the fields that should be returned.; Workflows Executions
Subscribe to a Workflow's Execution: Subscribe to a workflow's execution to receive real-time information about its steps, status, and data. This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).; Workflows Executions
Get Workflow Execution's Details: Get the details of the workflow's execution.; Workflows Executions
Subscribe to Workflow Execution Events: Subscribe to workflow execution events for a specific workflow and transaction. This endpoint establishes a Server-Sent Events (SSE) connection, allowing clients to receive real-time updates about the workflow execution. The events include details such as the event type, workflow ID, transaction ID, step information, response, result, and any errors that occur during the execution.; Workflows Executions
Create Campaign: Create a campaign.; Campaigns
Update a Campaign: Update a campaign's details.; Campaigns
Manage the Promotions of a Campaign: Manage the promotions of a campaign, either by adding them or removing them from the campaign.; Campaigns
Create a Claim: Create a claim. The claim is still in the request state, and the changes are only applied on the order once the claim is confirmed.; Claims
Cancel a Claim: Cancel a claim and its associated return.; Claims
Add Claim Items to a Claim: Add order items to a claim as claim items. These claim items will have the action `WRITE_OFF_ITEM`.; Claims
Update a Claim Item: Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Add Inbound Items to a Claim: Add inbound (or return) items to a claim. These inbound items will have a `RETURN_ITEM` action.; Claims
Update Inbound Items of a Claim: Update an inbound (or return) item of a claim using the `ID` of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Add an Inbound Shipping Method to a Claim: Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a `SHIPPING_ADD` action.; Claims
Update Inbound Shipping Method of a Claim: Update the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Add Outbound Items to a Claim: Add outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action.; Claims
Update Outbound Item of a Claim: Update an outbound (or new) item of a claim using the `ID` of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Add Outbound Shipping Methods to a Claim: Add an outbound shipping method to a claim. The outbound shipping method will have a `SHIPPING_ADD` action.; Claims
Update Outbound Shipping Method of a Claim: Update the shipping method for delivering outbound items in a claim using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Claims
Confirm a Claim Request: Confirm a claim request, applying its changes on the associated order.; Claims
Create Collection: Create a collection.; Collections
Update a Collection: Update a collection's details.; Collections
Manage Products of a Collection: Manage the products of a collection by adding or removing them from the collection.; Collections
Create Customer Group: Create a customer group.; Customer Groups
Update a Customer Group: Update a customer group's details.; Customer Groups
Manage Customers of a Customer Group: Manage the customers of a group to add or remove them from the group.; Customer Groups
Create Customer: Create a customer.; Customers
Update a Customer: Update a customer's details.; Customers
Add a Customer Address: Add an address to a customer.; Customers
Update a Customer's Address: Update a customer address's details.; Customers
Manage Customer Groups of Customer: Manage the customer groups of a customer, adding or removing the customer from those groups.; Customers
Create Draft Order: Create a draft order. This creates an order with the `is_draft_order` property enabled. You can later convert the draft order to an order.; Draft Orders
Update a Draft Order: Update a draft order's details. This doesn't include updating the draft order's items, shipping methods, or promotions. To update those, you need to create an edit that you can later request or confirm.; Draft Orders
Convert a Draft Order to an Order: Convert a draft order to an order. This will finalize the draft order and create a new order with the same details.; Draft Orders
Create a Draft Order Edit: Create an edit on a draft order. This will allow you to make changes to the draft order's items, shipping methods, or promotions. Once you've made the necessar changes, you can later either request the edit (which requires a confirmation from the customer), or force-confirm the edit.; Draft Orders
Confirm an Edit on a Draft Order: Confirm an edit on a draft order. This will apply the changes made to the draft order.; Draft Orders
Add Item to Draft Order Edit: Add an item to a draft order edit.; Draft Orders
Update New Item in Draft Order Edit: Update a new item that was added to a draft order edit by the ID of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Draft Orders
Update Existing Item in Draft Order Edit: Update an existing item in a draft order edit.; Draft Orders
Add Promotions to Draft Order Edit: Add promotions to a draft order edit.; Draft Orders
Request Edit on Draft Order: Change the status of a draft order's edit to be requested. Later, the edit can be confirmed or canceled.; Draft Orders
Add Shipping Method to Draft Order Edit: Add a shipping method to a draft order edit.; Draft Orders
Update New Shipping Method in Draft Order Edit: Update a new shipping method that was added to a draft order edit using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Draft Orders
Update Existing Shipping Method in Draft Order Edit: Update an existing shipping method in a draft order edit.; Draft Orders
Create Exchange: Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed.; Exchanges
Cancel an Exchange: Cancel an exchange and its associated return.; Exchanges
Add Inbound Items to an Exchange: Add inbound (or return) items to an exchange. These inbound items will have the action `RETURN_ITEM`.; Exchanges
Update an Inbount Item of an Exchange: Update an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Add an Inbound Shipping Method to an Exchange: Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a `SHIPPING_ADD` action.; Exchanges
Update Inbound Shipping Method of an Exchange: Update the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Add Outbound Items to Exchange: Add outbound (or new) items to an exchange. These outbound items will have the action `ITEM_ADD`.; Exchanges
Update Outbound Item of an Exchange: Update an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Add Outbound Shipping Method to Exchange: Add an outbound shipping method to an exchange. The outbound shipping method will have a `SHIPPING_ADD` action.; Exchanges
Update Outbound Shipping Method of Exchange: Update the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Exchanges
Confirm an Exchange: Confirm an exchange request, applying its changes on the associated order.; Exchanges
Add a Service Zone to a Fulfillment Set: Add a service zone to a fulfillment set.; Fulfillment Sets
Update the Service Zone of a Fulfillment Set: Update the details of a service zone in a fulfillment set.; Fulfillment Sets
Create Fulfillment: Create a fulfillment for an order, return, exchange, and more.; Fulfillments
Cancel a Fulfillment: Cancel a fulfillment. The fulfillment can't be shipped or delivered. To cancel the fulfillment, the `cancelFulfillment` method of the associated fulfillment provider is used.; Fulfillments
Create a Shipment for a Fulfillment: Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled.; Fulfillments
Create Gift Card: Create a gift card.; Gift Cards
Update a Gift Card: Update a gift card's details.; Gift Cards
Trigger Index Sync: Trigger reindexing or re-ingestion of the Index Module.; Index
Create Inventory Item: Create an inventory item.; Inventory Items
Export Inventory Items: Start an inventory items export process to retrieve a CSV of exported inventory items. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-inventory-items/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.; Inventory Items
Update an Inventory Item: Update an inventory item's details.; Inventory Items
Create Inventory Level for Inventory Item: Create an inventory level for an inventory item.; Inventory Items
Manage Inventory Levels of Inventory Item: Manage the inventory levels of an inventory item to create or delete them.; Inventory Items
Update an Inventory Level of an Inventory Item: Updates the details of an inventory item's inventory level using its associated location ID.; Inventory Items
Manage Inventory Levels: Manage inventory levels to create, update, or delete them.; Inventory Items
Create Invite: Create a invite.; Invites
Accept Invite: Accept an invite and create a new user. Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route.; Invites
Refresh Invite Token: Refresh the token of an invite.; Invites
Add Layout Configuration: Add a layout configuration for a specific zone. This allows you to customize the layout of the admin dashboard for that zone, including the arrangement of widgets and other UI elements.; Layouts
Update an Order Change: Update an order change's details. An order change can be an exchange, claim, or edit. For example, you can edit whether an exchange carries over the parent order's promotion.; Order Changes
Create Order Edit: Create an order edit.; Order Edits
Confirm Order Edit: Confirm an order edit request and apply the changes on the order.; Order Edits
Add Items to Order Edit: Add new items to an order edit. These items will have the action `ITEM_ADD`.; Order Edits
Update an Item in an Order Edit: Update an added item in the order edit by the ID of the item's `ITEM_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Order Edits
Update Order Item Quantity of Order Edit: Update an existing order item's quantity of an order edit. You can also use this API route to remove an item from an order by setting its quantity to `0`.; Order Edits
Request Order Edit: Change the status of an active order edit to requested.; Order Edits
Add Shipping Method to Order Edit: Add a shipping method to an exchange. The shipping method will have a `SHIPPING_ADD` action.; Order Edits
Update Shipping Method of an Order Edit: Update a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Order Edits
Export Orders: Start an order export process to retrieve a CSV of exported orders. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-orders/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.; Orders
Update Order: Update an order's details. Updating the order's shipping or billing address doesn't recalculate the order's taxes or totals; the existing tax lines are preserved as-is. You also can't change the address's `country_code`.; Orders
Archive an Order: Change the status of an order to archived.; Orders
Cancel Order: Cancel an order. The cancelation fails if: - The order has captured payments. - The order has refund payments. - The order has fulfillments that aren't canceled.; Orders
Complete Order: Mark an order as completed.; Orders
Create Credit Line for Order: Create a credit line for an order.; Orders
Create an Order Fulfillment: Create a fulfillment for an order. The creation fails if the order is canceled.; Orders
Cancel Fulfillment: Cancel an order's fulfillment. The fulfillment can't be canceled if it's shipped.; Orders
Mark a Fulfillment as Delivered.: Mark an order's fulfillment as delivered.; Orders
Create Shipment for an Order's Fulfillment: Create a shipment for an order's fulfillment.; Orders
Authorize Payment Session: Authorize a payment session for an order. This is useful for orders created from draft orders.; Orders
Request Order Transfer: Request an order to be transfered to another customer. The transfer is confirmed by sending a request to the [Accept Order Transfer](https://docs.medusajs.com/api/store#orders_postordersidtransferaccept) Store API route.; Orders
Cancel Transfer Request: Cancel a request to transfer an order to another customer.; Orders
Transfer Order to Guest Customer: Transfer an order to a guest customer. This is useful when the order email was incorrectly entered and you want to set it to a guest customer. The order will be transferred to a new guest customer with the provided email. For transferring orders to registered customer, check out the [Request Order Transfer](https://docs.medusajs.com/api/admin#orders_postordersidtransfer) API route instead.; Orders
Create Payment Collection: Create a payment collection.; Payment Collections
Mark a Payment Collection as Paid: Mark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider.; Payment Collections
Initialize Payment Session in Payment Collection: Initialize a Payment Session in a payment collection. This is useful for orders placed outside the checkout flow, such as draft orders, or when a payment session needs to be re-initialized for an existing payment collection.; Payment Collections
Capture Payment: Capture an amount of a payment. This uses the `capturePayment` method of the payment provider associated with the payment's collection.; Payments
Refund Payment: Refund an amount of a payment. This uses the `refundPayment` method of the payment provider associated with the payment's collection.; Payments
Create Price List: Create a price list.; Price Lists
Update a Price List: Update a price list's details.; Price Lists
Manage Prices in Price List: Manage the prices of a price list to create, update, or delete them.; Price Lists
Remove Products from Price List: Remove products from a price list.; Price Lists
Create Price Preference: Create a price preference.; Price Preferences
Update a Price Preference: Update a price preference's details.; Price Preferences
Create Product Category: Create a product category.; Product Categories
Update a Product Category: Update a product category's details.; Product Categories
Manage Products in Product Category: Manage products of a category to add or remove them.; Product Categories
Create Product Option: Create a product option.; Product Options
Update a Product Option: Update a product option's details.; Product Options
Update Product Option Value: Update a product option value's details.; Product Options
Create Product Tag: Create a product tag.; Product Tags
Update a Product Tag: Update a product tag's details.; Product Tags
Create Product Type: Create a product type.; Product Types
Update a Product Type: Update a product type's details.; Product Types
Create Product: Create a product.; Products
Manage Products: Manage products to create, update, or delete them.; Products
Export Products: Start a product export process to retrieve a CSV of exported products. You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL.; Products
Update a Product: Update a product's details.; Products
Manage Variants of Product Image: Manage the association between product variants and a product image. You can add or remove associations between variants and the image.; Products
Add Options to Product: Add a list of options to a product.; Products
Create a Product Variant: Create a variant for a product.; Products
Manage Variants in a Product: Manage variants in a product to create, update, or delete them.; Products
Manage Variants Inventory in a Product: Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items.; Products
Update a Product Variant: Update a variant's details.; Products
Manage Images of Product Variant: Manage the association between product images and a product variant. You can add or remove associations between images and the variant.; Products
Associate Variant with Inventory Item: Associate with a product variant an inventory item that manages its inventory details.; Products
Update Product Variant's Inventory Details: Update the inventory item that manages the inventory details of a product variant.; Products
Create Product Import: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/import` API route.; Products
Confirm Product Import: Confirm that a created product import should start importing the products into Medusa.; Products
Create Product Import: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/imports` API route.; Products
Confirm Product Import: Confirm that a created product import should start importing the products into Medusa.; Products
Create Promotion: Create a promotion.; Promotions
Update a Promotion: Update a promotion's details.; Promotions
Manage the Buy Rules of a Promotion: Manage the buy rules of a `buyget` promotion to create, update, or delete them.; Promotions
Manage a Promotion's Rules: Manage the rules of a promotion to create, update, or delete them.; Promotions
Manage Target Rules of a Promotion: Manage the target rules of a promotion to create, update, or delete them.; Promotions
Create Property Label: Create a property label.; Property Labels
Create Property Label: Create a property label.; Property Labels
Update a Property Label: Update a property label's details.; Property Labels
Create Refund Reason: Create a refund reason.; Refund Reasons
Update a Refund Reason: Update a refund reason's details.; Refund Reasons
Create Region: Create a region.; Regions
Update a Region: Update a region's details.; Regions
Create Reservation: Create a reservation.; Reservations
Update a Reservation: Update a reservation's details.; Reservations
Create Return Reason: Create a return reason.; Return Reasons
Update a Return Reason: Update a return reason's details.; Return Reasons
Create Return: Create a return. The return can later be requested or confirmed.; Returns
Update a Return: Update a return's details.; Returns
Cancel a return.: Cancel a return.; Returns
Add Damaged Items to Return: Add damaged items, whose quantity is to be dismissed, to a return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`.; Returns
Update Damaged Item of Return: Update a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Start Return Receival: Start a return receival process to be later confirmed using the `/admin/returns/:id/receive/confirm` API route.; Returns
Confirm Return Receival: Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and reflects the changes on the order.; Returns
Add Received Items to Return: Add received items in a return. These items will have the action `RECEIVE_RETURN_ITEM`.; Returns
Update a Received Item in a Return: Update a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Confirm Return Request: Confirm a requested return. The changes are applied on the inventory quantity and the order only after the return has been confirmed as received using the `/admin/returns/:id/received/confirm`.; Returns
Add Requested Items to Return: Add items that are requested to be returned. These items will have the action `RETURN_ITEM`.; Returns
Update Requested Item in Return: Update a requested item to be returned by the ID of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return.; Returns
Add a Shipping Method to a Return: Add a shipping method to a return. The shipping method will have a `SHIPPING_ADD` action.; Returns
Update a Shipping Method of a Return: Update a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.; Returns
Create Sales Channel: Create a sales channel.; Sales Channels
Update a Sales Channel: Update a sales channel's details.; Sales Channels
Manage Products in Sales Channel: Manage products in a sales channel to add or remove them from the channel.; Sales Channels
Create Shipping Option Type: Create a shipping option type.; Shipping Option Types
Update a Shipping Option Type: Update a shipping option type's details.; Shipping Option Types
Create Shipping Option: Create a shipping option.; Shipping Options
Update a Shipping Option: Update a shipping option's details. When you provide the `prices` array, it replaces the shipping option's existing flat-rate prices: - A price with a matching `id` is updated. - A price without an `id` is created - Any existing price whose `id` isn't included in the array is deleted. The `rules` you provide for a price similarly replace that price's existing rules, so omit a rule to remove it. Omitting the `prices` property entirely leaves the existing prices unchanged, whereas setting `price_type` to `calculated` removes all flat-rate prices.; Shipping Options
Manage the Rules of a Shipping Option: Manage the rules of a shipping option to create, update, or delete them.; Shipping Options
Create Shipping Profile: Create a shipping profile.; Shipping Profiles
Update a Shipping Profile: Update a shipping profile's details.; Shipping Profiles
Create Stock Location: Create a stock location.; Stock Locations
Update a Stock Location: Update a stock location's details.; Stock Locations
Manage Fulfillment Providers of a Stock Location: Manage the fulfillment providers to add or remove them from a stock location.; Stock Locations
Add Fulfillment Set to Stock Location: Create and add a fulfillment set to a stock location.; Stock Locations
Manage Sales Channels of a Stock Location: Manage the sales channels in a stock location by adding or removing them.; Stock Locations
Create Store Credit Account: Create a store credit account.; Store Credit Accounts
Add Credit to Store Credit Account: Add credit to a store credit account; Store Credit Accounts
Update a Store: Update a store's details.; Stores
Create Tax Rate: Create a tax rate.; Tax Rates
Update a Tax Rate: Update a tax rate's details.; Tax Rates
Create Tax Rule for a Rate: Create a tax rule for a rate.; Tax Rates
Create Tax Region: Create a tax region.; Tax Regions
Update a Tax Region: Update a tax region's details.; Tax Regions
Manage Translations: Manage translations in bulk by creating, updating, or deleting multiple translations in a single request. You can manage translations for various resources such as products, product variants, categories, and more.; Translations
Manage Translation Settings: Create, update, or delete multiple translation settings.; Translations
Upload Files: Upload files to the configured File Module Provider.; Uploads
Get Presigned Upload URL: Get a presigned URL for uploading a file to the configured File Module Provider. The presigned URL can be used to upload files directly to the third-party provider. This only works if your configured provider supports presigned URLs, such as the S3 provider.; Uploads
Update a User: Update a user's details.; Users
Create View Configuration: Create a new view configuration for an entity. If `is_system_default` is set to true, the created configuration will be set as the system default for the specified entity. Otherwise, it will be a custom configuration for the admin user.; Views
Make View Configuration Active: Make a view configuration active. This will set the given view configuration as the active one for the specified entity for the admin user. An admin user can only set their own configurations as active. If the view configuration ID is `null`, the active view configuration will be cleared, and the `code` or system default view configuration type will be used as the active view.; Views
Update View Configuration: Update the view configuration of an entity. An admin user can only update their own configurations.; Views
Execute a Workflow: Execute a workflow by its ID.; Workflows Executions
Fail a Step in a Workflow's Execution: Set the status of a step in a workflow's execution as failed. This is useful for long-running workflows.; Workflows Executions
Succeed a Step in a Workflow's Execution: Set the status of a step in a workflow's execution as successful. This is useful for long-running workflows.; Workflows Executions

FAQ

Medusa Admin integration, answered

How do AI agents use Medusa Admin through Open Connector?: Your user connects Medusa Admin once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Medusa Admin tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Medusa Admin MCP server?: Yes. Open Connector can serve Medusa Admin as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Medusa Admin actions with credentials injected server-side.
Where do Medusa Admin credentials live?: In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Medusa Admin — keep the keys.

Open source, self-hostable, with Medusa Admin credentials that never leave your infrastructure. Run it from source today.

View source on GitHub How the MCP gateway works →