Skip to content

o2sdev/medusa-plugin-assets-services

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Medusa Assets & Services Plugin

A Medusa.js plugin for managing customer-linked product instances and service subscriptions.

Overview

The assets-services plugin extends Medusa with the ability to manage physical product instances (assets) and related service subscriptions (service instances) linked to individual customers. It supports a wide range of after-sales and post-purchase use cases, such as:

  • Assigning products (with serial numbers) to customers
  • Attaching services to assets (e.g. maintenance plans, insurance, calibration)
  • Selling standalone services (e.g. rentals, diagnostics)
  • Managing product relationships (e.g. compatible services, spare parts)

The plugin enhances the Medusa admin interface with new panels for managing assets, services, and product references, enabling rich linking and management flows.

This plugin is used in Open Self Service, a composable customer portal for viewing and managing owned products, warranties, and activating additional services. You can also use the plugin independently.

Installation

  1. Install plugin package

    yarn add @o2s/medusa-plugin-assets-services
  2. Register plugin in medusa-config.js

     ...
     plugins: [
         {
             resolve: "@o2s/medusa-plugin-assets-services",
             options: {}
         }
     ]
     ...
  3. Run DB migrations - This plugin introduces new models in database so you need to execute db migration

     npx medusa db:migrate

Features

Asset Management

  • Register purchased product instances per customer
  • Track serial numbers, warranty dates, and installation addresses
  • Link to product variants and optionally store thumbnails

Service Instance Management

  • Create/manage service subscriptions (linked to assets or standalone)
  • Supports various billing models: one-time, weekly, monthly, yearly
  • Statuses: Active / Inactive / Retired

Product References

  • Define references such as:
    • SPARE_PART
    • COMPATIBLE_SERVICE
  • Easily attach compatible services or accessories

Admin Interface Extensions

  • Adds new admin menu entries:
    • Assets
    • Services
  • Adds a new component on the product variant page to manage product references
  • "Deep-linking" between assets, services, and products

Compatibility

  • Medusa version >= 2.4.0

Known Issues

  • Unlinking the last asset from a service instance currently fails.

Used In: Open Self Service

Although this plugin is generic and can be used independently, it was developed to power one of core backend functionalities of Open Self Service, a frontend portal that allows customers to:

  • Browse and manage their purchased assets
  • Check product status and warranty
  • View and activate compatible service plans

Explore the Open Self Service project to see how this plugin supports real-world industrial self-service scenarios.

Docs

You can find admin API definition in repo files.

Models schema

Services & Assets

---
  config:
    class:
      hideEmptyMembersBox: true
---
classDiagram
    ServiceInstance --> PaymentTypeEnum : has
    ServiceInstance --> ServiceItemStatusEnum : has

    ServiceInstance "0..*" <--> "0..*" Asset

    ServiceInstance "1" --> "1" ProductVariant

    Asset "1" --> "1" Address

    Asset "1" --> "1" Customer

    ServiceInstance "1" --> "1" Customer

    Asset "1" --> "1" ProductVariant

    ProductVariant "1" --> "0..*" ProductReference

    ProductReference --> ProductVariant_

    class ServiceInstance{
        String name
        Date startDate
        Date endDate
        Date purchaseDate
        Price price
    }

    class PaymentTypeEnum{
        ONE_TIME
        WEEKLY
        MONTHLY
        YEARLY
    }

    class ServiceItemStatusEnum{
        ACTIVE
        INACTIVE
        RETIRED
    }

    class Asset{
        String name
        String serialNumber
        String thumbnail
        Date endOfWarranty
    }

    class Address{
    }

    class ProductVariant{

    }

    class Customer{

    }

    class ProductReference{
        SPARE_PART
        COMPATIBLE_SERVICE
    }
Loading

Releases

No releases published

Packages

No packages published