Skip to content

The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.

3.3 KB
Raw Blame
---
title: "Seller module events"
sidebarTitle: "Events"
description: "Every event the store and team workflows emit, when each fires, and its payload."
---

The Seller module workflows emit events after they write. Subscribe to them to send notifications, sync an outside system, or start follow-up work without polling. The event names are exported from `@mercurjs/core/workflows` as `SellerWorkflowEvents`, `SellerMemberWorkflowEvents`, and `MemberInviteWorkflowEvents`.

```ts title="src/subscribers/store-approved.ts"
import type { SubscriberArgs, SubscriberConfig } from "@medusajs/framework"
import { MercurModules } from "@mercurjs/types"

export default async function storeApproved({
  event,
  container,
}: SubscriberArgs<{ id: string }>) {
  const sellerService = container.resolve(MercurModules.SELLER)
  const seller = await sellerService.retrieveSeller(event.data.id)

  container.resolve("logger").info(`${seller.name} is open`)
}

export const config: SubscriberConfig = {
  event: "seller.approved",
}
```

This subscriber loads the store when it’s approved. Store events carry only the id, so retrieve the record when you need more.

## Store events

`SellerWorkflowEvents` covers creation, updates, and every status transition.

| Event | Emitted when | Payload |
| --- | --- | --- |
| `seller.created` | `createSellersWorkflow` or `createSellerAccountWorkflow` creates a store, once per store | `{ id }` |
| `seller.updated` | `updateSellersWorkflow` updates a store, once per store | `{ id }` |
| `seller.deleted` | `deleteSellersWorkflow` soft deletes a store, once per store | `{ id }` |
| `seller.approved` | `approveSellerWorkflow` opens a pending store | `{ id }` |
| `seller.suspended` | `suspendSellerWorkflow` suspends a store | `{ id }` |
| `seller.unsuspended` | `unsuspendSellerWorkflow` reopens a suspended store | `{ id }` |
| `seller.terminated` | `terminateSellerWorkflow` terminates a store | `{ id }` |
| `seller.unterminated` | `unterminateSellerWorkflow` returns a terminated store to `suspended` | `{ id }` |

The address, professional details, payment details, and region workflows don’t emit events.

## Membership events

`SellerMemberWorkflowEvents` covers memberships changed directly. Accepting an invite emits `member_invite.accepted` instead of `seller_member.created`.

| Event | Emitted when | Payload |
| --- | --- | --- |
| `seller_member.created` | `addSellerMemberWorkflow` adds a member to a store | `{ seller_id, member_id }` |
| `seller_member.updated` | `updateMemberRoleWorkflow` changes a membership’s role | `{ seller_member_id }` |
| `seller_member.deleted` | `removeSellerMemberWorkflow` removes a membership | `{ seller_id, seller_member_id }` |

## Invite events

`MemberInviteWorkflowEvents` covers team invites. The created payload includes the signed token, so a subscriber can build the invite link.

| Event | Emitted when | Payload |
| --- | --- | --- |
| `member_invite.created` | `createMemberInvitesWorkflow`, `resendMemberInviteWorkflow`, or `createSellersWorkflow` creates an invite, once per invite | `{ id, token, expires_at }` |
| `member_invite.accepted` | `acceptMemberInviteWorkflow` turns an invite into a membership | `{ seller_id, member_id }` |

<Warning>
  The `member_invite.created` payload carries a working invite token. Don’t log it or forward it to systems that shouldn’t grant store access.
</Warning>