Medusa interacting with our custom entity


Interacting with our custom entity in medusa, create and list records

2 Oct, 2022 · 4 min read

Now that we have our custom entity set up and ready to go, let’s see how we can interact with it.

In this article, we’ll learn how to create a new record for this custom entity and how we can list all active items in the database.

Creating the repository

The first thing we’ll need to create is a new repository that can interact with our model.

Create a new folder called repositories; inside, create the post.ts file.

import { EntityRepository, Repository } from 'typeorm';

import { Post } from '../models/post';

export class PostRepository extends Repository<Post> {}

This file extends the typeORM functionality for repositories so we can interact with the entity.

Creating the service

As we learned before, services are the logic for medusa, so let’s create a new custom service we’ll call post.js.

On the basis, we’ll need to construct the elements we need.

import { TransactionBaseService } from '@medusajs/medusa';

class PostService extends TransactionBaseService {
  constructor({ postRepository, manager }) {
    super({ postRepository, manager });

    this.postRepository = postRepository;
    this.manager_ = manager;

export default PostService;

Then we’ll move on to adding the two functions we’ll need. First up is the create function to add new records.

class PostService extends TransactionBaseService {
  async create(name) {
    const postRepository = this.manager_.getCustomRepository(
    const post = await postRepository.create({ name: name });
    return await;

Here we have the create function that accepts one param and will invoke the create function of typeORM on this entity. Then we’ll save the newly created entity.

Because we used BeforeInsert on our entity it will auto create a new ID for each item.

The second function we’ll want is the list function to list all posts in our database.

class PostService extends TransactionBaseService {
  async list() {
    const postRepository = this.manager_.getCustomRepository(
    return await postRepository.find();

And that’s it for our service.

The routes

The last part is to create some routes to interact with this service.

I’ll be using the api/index.js file for this.

Let’s start with the creation of the new record. For this, we’ll need to enable the body parser so we can accept data.

import { Router } from 'express';
import bodyParser from 'body-parser';

export default () => {
  const router = Router();'/store/post', bodyParser.json(), async (req, res) => {
    const postService = req.scope.resolve('postService');
    const { name } = req.body;
    if (!name) {
        msg: 'Name not supplied.',
    const post = await postService.create(name);
    res.json({ msg: 'Post created', id: });

  return router;

This method will retrieve our custom post service and extract the name property from the sending body. We’ll notify the user with a 400 status if it’s not there.

Let’s see what happens if we post to this route now.

Create new record medusa

Else, we’ll invoke the create function we just added.

Let’s move on to the list function.

router.get('/store/post', async (req, res) => {
  const postService = req.scope.resolve('postService');
  res.json(await postService.list());

And that’s it. You can now get the records:

List all records medusa

Thank you for reading, and let’s connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

Spread the knowledge with fellow developers on Twitter
Tweet this tip
Powered by Webmentions - Learn more

Read next 📖

On a webshop break

3 Oct, 2022 · 2 min read

On a webshop break

Creating custom entities in medusa

1 Oct, 2022 · 3 min read

Creating custom entities in medusa

Join 2098 devs and subscribe to my newsletter