Medusa MCP Server

Authenticate a customer and receive the JWT token to be used in the header of subsequent requests.

When used with a third-party provider, such as Google, the request returns a location property. You redirect to the specified URL in your storefront to continue authentication with the third-party service.

This API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as code, state, and error, must be passed as query parameters to this route. You can decode the JWT token using libraries like react-jwt in the storefront. If the decoded data doesn't have an actor_id property, then you must register the customer using the Create Customer API route passing the token in the request's Authorization header.

This API route retrieves a registration JWT token of a customer that hasn't been registered yet. The token is used in the header of requests that create a customer.

Generate a reset password token for a customer. This API route doesn't reset the customer password or send them the reset instructions in a notification.

Instead, This API route emits the auth.password_reset event, passing it the token as a payload. You can listen to that event in a subscriber as explained in this guide, then send the customer a notification. The notification is sent using a Notification Module Provider, and it should have a URL that accepts a token query parameter, allowing the customer to reset their password from the storefront.

Use the generated token to update the customer's password using the Reset Password API route.

Reset a customer's password using a reset-password token generated with the Generate Reset Password Token API route. You pass the token as a bearer token in the request's Authorization header.

Set the cookie session ID of a customer. The customer must be previously authenticated with the /auth/customer/{provider} API route first, as the JWT token is required in the header of the request.

Refresh the authentication token of a customer. This is useful after authenticating a customer with a third-party service to ensure the token holds the new user's details, or when you don't want customers to re-login every day.

Create a cart.

Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned.

Complete a cart and place an order.

Set the customer of the cart. This is useful when you create the cart for a guest customer, then they log in with their account.

Add a product variant as a line item in the cart.

Update a line item's details in the cart.

Add a list of promotions to a cart.

Add a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option.

Calculate the cart's tax lines and amounts.

Retrieve a list of collections. The collections can be filtered by fields such as handle. The collections can also be sorted or paginated.

Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.

Retrieve a list of currencies. The currencies can be filtered by fields such as code. The currencies can also be sorted or paginated.

Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned.

Register a customer. Use the /auth/customer/emailpass/register API route first to retrieve the registration token and pass it in the header of the request.

Retrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned.

Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as country_code. The addresses can also be sorted or paginated.

Retrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned.

Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as id. The orders can also be sorted or paginated.

Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned.

Accept an order to be transfered to a customer's account, which was specified when the transfer request was created. The transfer is requested previously either by the customer using the Request Order Transfer Store API route, or by the admin using the Request Order Transfer Admin API route.

Cancel an order transfer that the logged-in customer previously requested using the Request Order Transfer API route.

Decline an order transfer previously requested, typically by the admin user using the Request Order Transfer Admin API route.

Request an order to be transfered to the logged-in customer's account. The transfer is confirmed using the Accept Order Transfer API route.

Create a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions.

Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses.

Retrieve a list of payment providers. You must provide the region_id query parameter to retrieve the payment providers enabled in that region.

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.

Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.

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.

Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.

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.

Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.

Retrieve a list of products. The products can be filtered by fields such as id. The products can also be sorted or paginated.

Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.

Retrieve a list of regions. The regions can be filtered by fields such as id. The regions can also be sorted or paginated.

Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.

Create a return for an order's items. The admin receives the return and process it from their side.

Retrieve a list of return reasons. The return reasons can be sorted or paginated.

Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.

Retrieve a list of shipping options for a cart. The cart's ID is set in the required cart_id query parameter.

The shipping options also be sorted or paginated.

Calculate the price of a shipping option in a cart.

This tool helps store administors. Retrieve a list of API keys. The API keys can be filtered by fields such as id. The API keys can also be sorted or paginated.

This tool helps store administors. Retrieve an API key by its ID. You can expand the API key's relations or select the fields that should be returned using the query parameters.

This tool helps store administors. Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.

This tool helps store administors. Manage the sales channels of a publishable API key, either to associate them or remove them from the API key.

This tool helps store administors. Retrieve a list of campaigns. The campaigns can be filtered by fields such as id. The campaigns can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. Manage the promotions of a campaign, either by adding them or removing them from the campaign.

This tool helps store administors. Retrieve a list of claims. The claims can be filtered by fields such as id. The claims can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. Cancel a claim and its associated return.

This tool helps store administors. Add order items to a claim as claim items. These claim items will have the action WRITE_OFF_ITEM.

This tool helps store administors. 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.

This tool helps store administors. Add inbound (or return) items to a claim. These inbound items will have a RETURN_ITEM action.

This tool helps store administors. 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.

This tool helps store administors. Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Add outbound (or new) items to a claim. These outbound items will have an ITEM_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Add an outbound shipping method to a claim. The outbound shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Confirm a claim request, applying its changes on the associated order.

This tool helps store administors. Retrieve a list of collections. The collections can be filtered by fields such as id. The collections can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. Manage the products of a collection by adding or removing them from the collection.

This tool helps store administors. Retrieve a list of currencies. The currencies can be filtered by fields such as id. The currencies can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned.

This tool helps store administors. Manage the customers of a group to add or remove them from the group.

This tool helps store administors. Retrieve a list of customers. The customers can be filtered by fields such as id. The customers can also be sorted or paginated.

This tool helps store administors. Retrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of addresses in a customer. The addresses can be filtered by fields like query. The addresses can also be paginated.

This tool helps store administors. Retrieve a list of a customer's addresses. The addresses can be filtered by fields like company. The addresses can also be paginated.

This tool helps store administors. Manage the customer groups of a customer, adding or removing the customer from those groups.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a list of exchanges. The exchanges can be filtered by fields such as id. The exchanges can also be sorted or paginated.

This tool helps store administors. Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.

This tool helps store administors. Cancel an exchange and its associated return.

This tool helps store administors. Add inbound (or return) items to an exchange. These inbound items will have the action RETURN_ITEM.

This tool helps store administors. 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.

This tool helps store administors. Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Add outbound (or new) items to an exchange. These outbound items will have the action ITEM_ADD.

This tool helps store administors. 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.

This tool helps store administors. Add an outbound shipping method to an exchange. The outbound shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Confirm an exchange request, applying its changes on the associated order.

This tool helps store administors. 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.

This tool helps store administors. Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.

This tool helps store administors. Delete a fulfillment set.

This tool helps store administors. Add a service zone to a fulfillment set.

This tool helps store administors. Retrieve a service zone that belongs to a fulfillment set. be paginated.

This tool helps store administors. Create a fulfillment for an order, return, exchange, and more.

This tool helps store administors. 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.

This tool helps store administors. Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled.

This tool helps store administors. 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.

This tool helps store administors. Manage inventory levels to create, update, or delete them.

This tool helps store administors. Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Manage the inventory levels of an inventory item to create or delete them.

This tool helps store administors. Updates the details of an inventory item's inventory level using its associated location ID.

This tool helps store administors. Retrieve a list of invites. The invites can be filtered by fields such as id. The invites can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned.

This tool helps store administors. Refresh the token of an invite.

This tool helps store administors. Retrieve a list of notifications. The notifications can be filtered by fields such as id. The notifications can also be sorted or paginated.

This tool helps store administors. Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned.

This tool helps store administors. Create an order edit.

This tool helps store administors. Cancel an order edit.

This tool helps store administors. Confirm an order edit request and apply the changes on the order.

This tool helps store administors. Add new items to an order edit. These items will have the action ITEM_ADD.

This tool helps store administors. Update an existing order item's quantity of an order edit.

This tool helps store administors. 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.

This tool helps store administors. Change the status of an active order edit to requested.

This tool helps store administors. Add a shipping method to an exchange. The shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a list of orders. The orders can be filtered by fields such as id. The orders can also be sorted or paginated.

This tool helps store administors. Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned.

This tool helps store administors. Change the status of an order to archived.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a list of changes made on an order, including returns, exchanges, etc...

The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated.

This tool helps store administors. Mark an order as completed.

This tool helps store administors. Create a fulfillment for an order. The creation fails if the order is canceled.

This tool helps store administors. Cancel an order's fulfillment. The fulfillment can't be canceled if it's shipped.

This tool helps store administors. Mark an order's fulfillment as delivered.

This tool helps store administors. Create a shipment for an order's fulfillment.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a preview of an order using its associated change, such as an edit.

This tool helps store administors. Request an order to be transfered to another customer. The transfer is confirmed by sending a request to the Accept Order Transfer Store API route.

This tool helps store administors. Cancel a request to transfer an order to another customer.

This tool helps store administors. Create a payment collection.

This tool helps store administors. Delete a payment collection.

This tool helps store administors. Mark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider.

This tool helps store administors. Retrieve a list of payments. The payments can be filtered by fields such as id. The payments can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned.

This tool helps store administors. Capture an amount of a payment. This uses the capturePayment method of the payment provider associated with the payment's collection.

This tool helps store administors. Refund an amount of a payment. This uses the refundPayment method of the payment provider associated with the payment's collection.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned.

This tool helps store administors. Manage the prices of a price list to create, update, or delete them.

This tool helps store administors. Remove products from a price list.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.

This tool helps store administors. Manage products of a category to add or remove them.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a list of products. The products can be filtered by fields such as id. The products can also be sorted or paginated.

This tool helps store administors. Manage products to create, update, or delete them.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Confirm that a created product import should start importing the products into Medusa.

This tool helps store administors. Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of options of a product. The options can be filtered by fields like id. The options can also be paginated.

This tool helps store administors. Retrieve a product's option by its ID.

This tool helps store administors. Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated.

This tool helps store administors. Manage variants in a product to create, update, or delete them.

This tool helps store administors. Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items.

This tool helps store administors. Retrieve a product's variant by its ID.

This tool helps store administors. Associate with a product variant an inventory item that manages its inventory details.

This tool helps store administors. Update the inventory item that manages the inventory details of a product variant.

This tool helps store administors. Retrieve a list of promotions. The promotions can be filtered by fields such as id. The promotions can also be sorted or paginated.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned.

This tool helps store administors. Manage the buy rules of a buyget promotion to create, update, or delete them.

This tool helps store administors. Manage the rules of a promotion to create, update, or delete them.

This tool helps store administors. Manage the target rules of a promotion to create, update, or delete them.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of regions. The regions can be filtered by fields such as id. The regions can also be sorted or paginated.

This tool helps store administors. Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of reservations. The reservations can be filtered by fields such as id. The reservations can also be sorted or paginated.

This tool helps store administors. Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of returns. The returns can be filtered by fields such as id. The returns can also be sorted or paginated.

This tool helps store administors. Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned.

This tool helps store administors. Cancel a return.

This tool helps store administors. Add damaged items, whose quantity is to be dismissed, to a return. These items will have the action RECEIVE_DAMAGED_RETURN_ITEM.

This tool helps store administors. 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.

This tool helps store administors. Start a return receival process to be later confirmed using the /admin/returns/:id/receive/confirm API route.

This tool helps store administors. Add received items in a return. These items will have the action RECEIVE_RETURN_ITEM.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Add items that are requested to be returned. These items will have the action RETURN_ITEM.

This tool helps store administors. 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.

This tool helps store administors. Add a shipping method to a return. The shipping method will have a SHIPPING_ADD action.

This tool helps store administors. 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.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a sales channel by its ID. You can expand the sales channel's relations or select the fields that should be returned.

This tool helps store administors. Manage products in a sales channel to add or remove them from the channel.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned.

This tool helps store administors. Manage the rules of a shipping option to create, update, or delete them.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a stock location by its ID. You can expand the stock location's relations or select the fields that should be returned.

This tool helps store administors. Manage the fulfillment providers to add or remove them from a stock location.

This tool helps store administors. Create and add a fulfillment set to a stock location.

This tool helps store administors. Manage the sales channels in a stock location by adding or removing them.

This tool helps store administors. Retrieve a list of stores. The stores can be filtered by fields such as id. The stores can also be sorted or paginated.

This tool helps store administors. Retrieve a store by its ID. You can expand the store's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a tax rate by its ID. You can expand the tax rate's relations or select the fields that should be returned.

This tool helps store administors. Create a tax rule for a rate.

This tool helps store administors. Remove a tax rate's rule.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned.

This tool helps store administors. Upload files to the configured File Module Provider.

This tool helps store administors. Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned.

This tool helps store administors. Retrieve a list of users. The users can be filtered by fields such as id. The users can also be sorted or paginated.

This tool helps store administors. Retrieve the logged-in user's details.

This tool helps store administors. Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned.

This tool helps store administors. 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.

This tool helps store administors. Retrieve a workflows execution by its ID. You can expand the workflows execution's relations or select the fields that should be returned.

This tool helps store administors. Execute a workflow by its ID.

This tool helps store administors. Set the status of a step in a workflow's execution as failed. This is useful for long-running workflows.

This tool helps store administors. Set the status of a step in a workflow's execution as successful. This is useful for long-running workflows.

This tool helps store administors. 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.

This tool helps store administors. Get the details of the workflow's execution.

This tool helps store administors. Subscribe to a step in a workflow's execution to receive real-time information about its status and data. This route returns an event stream that you can consume using the EventSource API.

This tool helps store administors. Set the cookie session ID of an admin user. The admin must be previously authenticated with the /auth/user/{provider} API route first, as the JWT token is required in the header of the request.

This tool helps store administors. Refresh the authentication token of a user. This is useful after authenticating a user with a third-party service to ensure the token holds the new user's details, or when you don't want users to re-login every day.

This tool helps store administors. Authenticate a user and receive the JWT token to be used in the header of subsequent requests.

When used with a third-party provider, such as Google, the request returns a location property. You redirect to the specified URL in your frontend to continue authentication with the third-party service.

This tool helps store administors. This API route is used by your dashboard or frontend application when a third-party provider redirects to it after authentication. It validates the authentication with the third-party provider and, if successful, returns an authentication token. All query parameters received from the third-party provider, such as code, state, and error, must be passed as query parameters to this route.

You can decode the JWT token using libraries like react-jwt in the frontend. If the decoded data doesn't have an actor_id property, then you must create a user, typically using the Accept Invite route passing the token in the request's Authorization header.

This tool helps store administors. This API route retrieves a registration JWT token of a user that hasn't been registered yet. The token is used in the header of requests that create a user, such as the Accept Invite API route.

This tool helps store administors. Generate a reset password token for an admin user. This API route doesn't reset the admin's password or send them the reset instructions in a notification.

Instead, This API route emits the auth.password_reset event, passing it the token as a payload. You can listen to that event in a subscriber as explained in this guide, then send the user a notification. The notification is sent using a Notification Module Provider, and it should have the URL to reset the password in the Medusa Admin dashboard, such as http://localhost:9000/app/reset-password?token=123.

Use the generated token to update the user's password using the Reset Password API route.

This tool helps store administors. Reset an admin user's password using a reset-password token generated with the Generate Reset Password Token API route. You pass the token as a bearer token in the request's Authorization header.