Medusa Storefront API
Medusa Storefront API endpoints from Medusa
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Medusa Storefront API endpoints from Medusa
Endpoints 79
Auth
- POSTVerify the Customer's Email
/auth/customer/emailpass/verification/confirmVerifies the customer's email using a token that is typically sent to their email address. This is used to confirm the customer's email during registration or… - GETList Auth Providers for Customers
/auth/customer/providersRetrieve a list of auth providers for the customer actor type. This is useful to show the authentication option for the available providers. - POSTAuthenticate Customer
/auth/customer/:auth_providerAuthenticate 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… - POSTValidate Authentication Callback
/auth/customer/:auth_provider/callbackThis API route is used by your storefront or frontend application when a third-party provider redirects to it after authentication. It validates the… - POSTRetrieve Registration JWT Token
/auth/customer/:auth_provider/registerThis 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… - POSTGenerate Reset Password Token for Customer
/auth/customer/:auth_provider/reset-passwordGenerate 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.… - POSTReset a Customer's Password
/auth/customer/:auth_provider/updateReset 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… - POSTSet Authentication Session
/auth/sessionSet 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… - DELETEDelete Authentication Session
/auth/sessionDeletes the cookie session ID previously set for authentication. - POSTRefresh Authentication Token
/auth/token/refreshRefresh 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… - POSTConfirm Customer Verification
/auth/verification/confirmConfirm a verification token of the customer. This API route is used as the last step part of the email verification flow. It can also be used for custom… - POSTRequest Customer Verification
/auth/verification/requestCreate a verification request for a customer. This API route is used when a customer logs in, but their email requires verification. It can also be used for…
Carts
- POSTCreate Cart
/store/carts?fields=string&locale=en-USCreate a cart. - GETGet a Cart
/store/carts/:id?fields=string&locale=en-USRetrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned. - POSTUpdate a Cart
/store/carts/:id?fields=string&locale=en-USUpdate a cart's details. This unsets the payment methods chosen before, and the customer would have to choose them again. Also, if the customer has chosen a… - POSTComplete Cart
/store/carts/:id/complete?fields=string&locale=en-USComplete a cart and place an order. - POSTChange Cart's Customer to Logged-in Customer
/store/carts/:id/customer?fields=string&locale=en-USChange the cart's customer to the currently logged-in customer. This is useful when you create the cart for a guest customer, then they log in with their… - POSTAdd Gift Card to Cart
/store/carts/:id/gift-cards?locale=en-USAdd a Gift Card to a cart - DELETERemove Gift Card from Cart
/store/carts/:id/gift-cards?locale=en-USRemove a Gift Card from a cart. - POSTAdd Line Item to Cart
/store/carts/:id/line-items?fields=string&locale=en-USAdd a product variant as a line item in the cart. - POSTUpdate a Line Item in a Cart
/store/carts/:id/line-items/:line_id?fields=string&locale=en-USUpdate a line item's details in the cart. - DELETERemove Line Item from Cart
/store/carts/:id/line-items/:line_id?fields=string&locale=en-USRemove a line item from a cart. - POSTAdd Promotions to Cart
/store/carts/:id/promotions?fields=string&locale=en-USAdd a list of promotions to a cart. - DELETERemove Promotions from Cart
/store/carts/:id/promotions?fields=string&locale=en-USRemove a list of promotions from a cart. - POSTAdd Shipping Method to Cart
/store/carts/:id/shipping-methods?locale=en-US&fields=stringAdd a shipping method to a cart. Use this API route when the customer chooses their preferred shipping option. If the chosen shipping option's price_type is… - POSTAdd Store Credit to Cart
/store/carts/:id/store-credits?locale=en-USAdd a Store Credit to a cart - POSTCalculate Cart Taxes
/store/carts/:id/taxes?locale=en-US&fields=stringCalculate the cart's tax lines and amounts. Medusa recalculates a cart's tax lines automatically on cart changes when the cart's region has automatic_taxes…
Collections
- GETList Collections
/store/collections?fields=string&offset=0.0&limit=0.0&order=string&title=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&handle=string&q=string&$and={}&$or={}&with_deleted=true&id=string&locale=en-US&external_id=stringRetrieve a list of collections. The collections can be filtered by fields such as handle. The collections can also be sorted or paginated. - GETGet a Collection
/store/collections/:id?fields=string&locale=en-USRetrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned.
Currencies
- GETList Currencies
/store/currencies?fields=string&offset=0.0&limit=0.0&order=string&q=string&code=string&$and={}&$or={}&with_deleted=true&locale=en-USRetrieve a list of currencies. The currencies can be filtered by fields such as code. The currencies can also be sorted or paginated. - GETGet a Currency
/store/currencies/:code?fields=string&locale=en-USRetrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned.
Customers
- POSTRegister Customer
/store/customers?fields=string&locale=en-USRegister 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. - GETGet Logged-in Customer
/store/customers/me?fields=string&locale=en-USRetrieve the logged-in customer. You can expand the customer's relations or select the fields that should be returned. - POSTUpdate Customer
/store/customers/me?fields=string&locale=en-USUpdate the logged-in customer's details. - GETList Customer's Addresses
/store/customers/me/addresses?city=string&postal_code=string&country_code=string&q=string&$and={}&$or={}&locale=en-US&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=stringRetrieve 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. - POSTCreate Address for Logged-In Customer
/store/customers/me/addresses?fields=string&locale=en-USCreate an address for the logged-in customer. - GETGet Customer's Address
/store/customers/me/addresses/:address_id?fields=string&locale=en-USRetrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned. - POSTUpdate Customer's Address
/store/customers/me/addresses/:address_id?fields=string&locale=en-USUpdate the logged-in customer's address. - DELETERemove Customer's Address
/store/customers/me/addresses/:address_id?fields=string&locale=en-USRemove an address of the logged-in customer.
Gift Cards
- GETGet a Gift Card
/store/gift-cards/:idOrCode?fields=string&locale=en-USRetrieve a gift card by its ID or code. You can expand the gift card's relations or select the fields that should be returned.
Locales
- GETList Locales
/store/locales?locale=en-USRetrieve the list of supported locales. You can use this list to allow customers to select their preferred locale in your storefront.
Multi-Factor Authentication (MFA) Factors
- POSTVerify a Multi-Factor Authentication (MFA) Challenge
/auth/mfa/challenges/:id/verifyVerify a multi-factor authentication (MFA) challenge issued during login. On success, this completes the authentication flow and returns a JWT token that can… - GETList Multifactor Authentication (MFA) Factors
/auth/mfa/factorsRetrieve the list of multi-factor authentication (MFA) factors registered for the authenticated user, including both pending (not yet verified) and enabled… - POSTStart Multi-Factor Authentication (MFA) Factor Enrollment
/auth/mfa/factorsStart the enrollment of a new multi-factor authentication (MFA) factor for the authenticated user. The response contains the factor along with… - DELETEDisable a Multi-Factor Authentication (MFA) Factor
/auth/mfa/factors/:idDisable a multi-factor authentication (MFA) factor for the authenticated user. Once disabled, the factor can no longer be used to verify MFA challenges. When… - POSTVerify and Enable a Multi-Factor Authentication (MFA) Factor
/auth/mfa/factors/:id/verifyVerify a pending multi-factor authentication (MFA) factor by submitting a code generated from it. A successful verification enables the factor, after which it… - POSTGenerate Multi-Factor Authentication (MFA) Recovery Codes
/auth/mfa/recovery-codesGenerate a new set of single-use recovery codes for the authenticated user. Recovery codes can be used to verify MFA challenges when the user does not have…
Orders
- GETList Logged-in Customer's Orders
/store/orders?fields=string&offset=0.0&limit=0.0&order=string&id=string&$and={}&$or={}&status=canceled&with_deleted=true&locale=en-USRetrieve 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. - GETGet an Order
/store/orders/:id?fields=string&locale=en-USRetrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. This API route doesn't require customer… - POSTAccept Order Transfer
/store/orders/:id/transfer/accept?fields=string&locale=en-USAccept an order to be transfered to a customer's account, which was specified when the transfer request was created. The transfer is requested previously… - POSTCancel Order Transfer
/store/orders/:id/transfer/cancel?fields=string&locale=en-USCancel an order transfer that the logged-in customer previously requested using the Request Order Transfer API route. - POSTDecline Order Transfer
/store/orders/:id/transfer/decline?fields=string&locale=en-USDecline an order transfer previously requested, typically by the admin user using the Request Order Transfer Admin API route. - POSTRequest Order Transfer
/store/orders/:id/transfer/request?fields=string&locale=en-USRequest an order to be transfered to the logged-in customer's account. The transfer is confirmed using the Accept Order Transfer API route.
Payment Collections
- POSTCreate Payment Collection
/store/payment-collections?fields=string&locale=en-USCreate a payment collection for a cart. This is used during checkout, where the payment collection holds the cart's payment sessions. - POSTInitialize Payment Session of a Payment Collection
/store/payment-collections/:id/payment-sessions?fields=string&locale=en-USInitialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then… - POSTUpdate Payment Session
/store/payment-collections/:id/payment-sessions/:session_id?locale=en-US&fields=stringUpdate a payment session's client data, such as payment details collected by the payment provider's checkout component. The data is merged into the session's…
Payment Providers
- GETList Payment Providers
/store/payment-providers?fields=string&offset=0.0&limit=0.0&order=string®ion_id=string&with_deleted=true&locale=en-USRetrieve a list of payment providers. You must provide the region_id query parameter to retrieve the payment providers enabled in that region.
Product Categories
- GETList Product Categories
/store/product-categories?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&description=string&handle=string&parent_category_id=string&include_ancestors_tree=true&include_descendants_tree=true&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&$and={}&$or={}&name=string&with_deleted=true&locale=en-US&external_id=stringRetrieve 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. - GETGet a Product Category
/store/product-categories/:id?fields=string&include_ancestors_tree=true&include_descendants_tree=true&locale=en-USRetrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned.
Product Options
- GETList Product Options
/store/product-options?locale=en-US&q=string&title=string&is_exclusive=true&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}&id=stringRetrieve 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. - GETGet a Product Option
/store/product-options/:id?locale=en-US&fields=stringRetrieve a product option by its ID. You can expand the product option's relations or select the fields that should be returned.
Product Tags
- GETList Product Tags
/store/product-tags?fields=string&offset=0.0&limit=0.0&order=string&$and={}&$or={}&q=string&id=string&value=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&with_deleted=true&locale=en-US&external_id=stringRetrieve 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. - GETGet a Product Tag
/store/product-tags/:id?fields=string&locale=en-USRetrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.
Product Types
- GETList Product Types
/store/product-types?fields=string&offset=0.0&limit=0.0&order=string&$and={}&$or={}&q=string&id=string&value=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&with_deleted=true&locale=en-US&external_id=stringRetrieve 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. - GETGet a Product Type
/store/product-types/:id?fields=string&locale=en-USRetrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.
Product Variants
- GETList Product Variants
/store/product-variants?locale=en-US&sku=string&manage_inventory=true&allow_backorder=true&product_id=string&q=string&id=string&options={"value":"string","option_id":"string"}&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&deleted_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&with_deleted=true&fields=string&$and={}&$or={}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.
Products
- GETList Products
/store/products?fields=string&offset=0.0&limit=0.0&order=string&$and={}&$or={}&q=string&id=string&title=string&handle=string&is_giftcard=true&collection_id=&tag_id=string&type_id=string&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}®ion_id=string&province=us-ca&sales_channel_id=string&category_id=string&variants={"sku":"string","manage_inventory":true,"allow_backorder":true,"product_id":"string","q":"string","id":"string","options":{"value":"string","option_id":"string"},"created_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"updated_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"deleted_at":{"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true},"limit":0.0,"offset":0.0,"order":"string","with_deleted":true,"fields":"string","$and":[{}],"$or":[{}],"ean":"string","upc":"string","barcode":"string"}&country_code=string&cart_id=string&locale=en-US&external_id=string&option_value_id=string&option_id=stringRetrieve a list of products. The products can be filtered by fields such as id. The products can also be sorted or paginated. You can retrieve the content of… - GETGet a Product
/store/products/:id?fields=string®ion_id=string&country_code=string&province=us-ca&cart_id=string&locale=en-USRetrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. You can retrieve the content of the product…
Regions
- GETList Regions
/store/regions?fields=string&offset=0.0&limit=0.0&order=string&q=string&id=string&name=string¤cy_code=string&$and={}&$or={}&with_deleted=true&locale=en-USRetrieve a list of regions. The regions can be filtered by fields such as id. The regions can also be sorted or paginated. - GETGet a Region
/store/regions/:id?fields=string&locale=en-USRetrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.
Return Reasons
- GETList Return Reasons
/store/return-reasons?fields=string&offset=0.0&limit=0.0&order=string&with_deleted=true&locale=en-USRetrieve a list of return reasons. The return reasons can be sorted or paginated. - GETGet a Return Reason
/store/return-reasons/:id?fields=string&locale=en-USRetrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned.
Returns
- POSTCreate Return
/store/returns?locale=en-USCreate a return for an order's items. The admin receives the return and process it from their side. This API route doesn't require customer authentication, so…
Search
- POSTSearch Indexes
/store/search?locale=en-USSearch the indexes that your application exposes to the storefront. An index is only searchable through this route once it's allowed with the…
Shipping Options
- GETList Shipping Options for Cart
/store/shipping-options?fields=string&offset=0.0&limit=0.0&order=string&cart_id=string&$and={}&$or={}&is_return=true&locale=en-USRetrieve 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… - POSTCalculate Shipping Option Price
/store/shipping-options/:id/calculate?locale=en-US&fields=stringCalculate the price of a shipping option in a cart. Use this API route for shipping options whose price_type is calculated, as their price isn't stored but…
Store Credit Accounts
- GETList Customer's Store Credit Accounts
/store/store-credit-accounts?currency_code=usd&created_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&updated_at={"$and":[{}],"$or":[{}],"$eq":"string","$ne":"string","$in":["string"],"$nin":["string"],"$not":"string","$gt":"string","$gte":"string","$lt":"string","$lte":"string","$like":"string","$re":"string","$ilike":"string","$fulltext":"string","$overlap":["string"],"$contains":["string"],"$contained":["string"],"$exists":true}&limit=0.0&offset=0.0&order=string&fields=string&$and={}&$or={}&locale=en-US&with_deleted=trueRetrieve the logged-in customer's store credit accounts. The store credit accounts can be filtered by fields such as id. The store credit accounts can also be… - POSTClaim a Store Credit Account
/store/store-credit-accounts/claim?locale=en-USClaim a store credit account as the logged-in customer. The store credit account must not belong to another customer, and it must have amount available to… - GETGet Customer's Store Credit Account
/store/store-credit-accounts/:id?locale=en-USRetrieve logged-in customer's store credit account by its ID. You can expand the store credit account's relations or select the fields that should be returned.
API details
- Base URL
http://localhost:9000https://api.medusajs.com- Authentication
- A bearer token in the Authorization header
An API key in the connect.sid cookie
A bearer token in the Authorization header - Operations
- 79 operations on 69 pathsPOST 40GET 33DELETE 6
- Main resources
- Carts 15Auth 12Customers 8Multi-Factor Authentication (MFA) Factors 6Orders 6Payment Collections 3Store Credit Accounts 3Collections 2Currencies 2Product Categories 2
- Response formats
application/jsontext/plain- Description format
- OpenAPI 3.0.0, API version
2.22.7 - Links
- OpenAPI document
- Listed from
- Medusa (Store API)'s published OpenAPI description (medusajs/medusa) (MIT)
How to test the Medusa Storefront API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Medusa Storefront API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Verify the Customer's Email” (POST /auth/customer/emailpass/verification/confirm), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Medusa Storefront API?
Medusa Storefront API endpoints from Medusa It is listed under E-commerce and has 79 endpoints.
Who publishes the Medusa Storefront API?
It is listed from Medusa's public API description (an OpenAPI document), not published by Medusa on Swastik Codes. Anyone who controls medusajs.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Medusa Storefront API?
Its description lists 2 base URLs: http://localhost:9000, https://api.medusajs.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Medusa Storefront API?
It accepts 3 methods: A bearer token in the Authorization header; an API key in the connect.sid cookie; A bearer token in the Authorization header.
How many endpoints does the Medusa Storefront API have?
79 operations on 69 paths (40 POST, 33 GET, 6 DELETE). The largest groups are Carts, Auth, Customers, Multi-Factor Authentication (MFA) Factors.
Is forking the Medusa Storefront API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.