Links between Order Return Request Module and Other Modules

This document showcases the module links defined between the Order Return Request Module and other Commerce Modules.

Summary

The Order Return Request Module has the following links to other modules:

First Data Model	Second Data Model	Type	Description
OrderReturnRequest	Order	Stored - many-to-one	Associates return requests with the original order
Seller	OrderReturnRequest	Stored - one-to-many	Associates a seller with their return requests

Order Module

Mercur defines a link between the Order Return Request Module’s OrderReturnRequest data model and the Order Module’s Order data model. This allows return requests to be associated with the original order being returned.

Retrieve with Query

To retrieve the order of a return request with Query, pass order.* in fields:

query.graph
useQueryGraphStep

const { data: returnRequests } = await query.graph({
  entity: "order_return_request",
  fields: [
    "*",
    "order.*",
  ],
})

// returnRequests[0].order

import { useQueryGraphStep } from "@medusajs/medusa/core-flows"

// ...

const { data: returnRequests } = useQueryGraphStep({
  entity: "order_return_request",
  fields: [
    "*",
    "order.*",
  ],
})

// returnRequests[0].order

Manage with Link

To manage the order association of a return request, use Link:

link.create
createRemoteLinkStep

import { Modules } from "@medusajs/framework/utils"

// ...

await link.create({
  order_return_request: {
    order_return_request_id: "oretreq_123",
  },
  [Modules.ORDER]: {
    order_id: "ord_123",
  },
})

import { createRemoteLinkStep } from "@medusajs/medusa/core-flows"

// ...

createRemoteLinkStep({
  order_return_request: {
    order_return_request_id: "oretreq_123",
  },
  [Modules.ORDER]: {
    order_id: "ord_123",
  },
})

Seller Module

Mercur defines a link between the Seller Module’s Seller data model and the Order Return Request Module’s OrderReturnRequest data model. This allows tracking which return requests belong to each seller for vendor review and processing.

Retrieve with Query

To retrieve the return requests of a seller with Query, pass order_return_request.* in fields:

query.graph
useQueryGraphStep

const { data: sellers } = await query.graph({
  entity: "seller",
  fields: [
    "*",
    "order_return_request.*",
  ],
})

// sellers[0].order_return_request

import { useQueryGraphStep } from "@medusajs/medusa/core-flows"

// ...

const { data: sellers } = useQueryGraphStep({
  entity: "seller",
  fields: [
    "*",
    "order_return_request.*",
  ],
})

// sellers[0].order_return_request

Manage with Link

To manage the return requests of a seller, use Link:

link.create
createRemoteLinkStep

// ...

await link.create({
  seller: {
    seller_id: "sel_123",
  },
  order_return_request: {
    order_return_request_id: "oretreq_123",
  },
})

import { createRemoteLinkStep } from "@medusajs/medusa/core-flows"

// ...

createRemoteLinkStep({
  seller: {
    seller_id: "sel_123",
  },
  order_return_request: {
    order_return_request_id: "oretreq_123",
  },
})

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

Order Return Request Module Links

Links between Order Return Request Module and Other Modules

Summary

Order Module

Retrieve with Query

Manage with Link

Seller Module

Retrieve with Query

Manage with Link

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

​Links between Order Return Request Module and Other Modules

​Summary

​Order Module

​Retrieve with Query

​Manage with Link

​Seller Module

​Retrieve with Query

​Manage with Link

Links between Order Return Request Module and Other Modules

Summary

Order Module

Retrieve with Query

Manage with Link

Seller Module

Retrieve with Query

Manage with Link