Links between Split Order Payment Module and Other Modules

This document showcases the module links defined between the Split Order Payment Module and other Commerce Modules.

Summary

The Split Order Payment Module has the following links to other modules:

First Data Model	Second Data Model	Type	Description
Order	SplitOrderPayment	Stored - one-to-one	Associates an order with its split payment record tracking the seller’s payment portion

Order Module

Mercur defines a link between the Order Module’s Order data model and the Split Order Payment Module’s SplitOrderPayment data model. This allows tracking payment amounts (authorized, captured, refunded) specific to each seller’s portion of an order in a multi-vendor marketplace.

Retrieve with Query

To retrieve the split order payment of an order with Query, pass split_order_payment.* in fields:

query.graph
useQueryGraphStep

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

// orders[0].split_order_payment

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

// ...

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

// orders[0].split_order_payment

Manage with Link

To manage the split order payment of an order, use Link:

link.create
createRemoteLinkStep

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

// ...

await link.create({
  [Modules.ORDER]: {
    order_id: "ord_123",
  },
  split_order_payment: {
    split_order_payment_id: "sp_ord_pay_123",
  },
})

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

// ...

createRemoteLinkStep({
  [Modules.ORDER]: {
    order_id: "ord_123",
  },
  split_order_payment: {
    split_order_payment_id: "sp_ord_pay_123",
  },
})

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

Split Order Payment Module Links

Links between Split Order Payment Module and Other Modules

Summary

Order Module

Retrieve with Query

Manage with Link

Quick start

Components

Core Concepts

Product

Integrations

Deployment

Help

​Links between Split Order Payment Module and Other Modules

​Summary

​Order Module

​Retrieve with Query

​Manage with Link

Links between Split Order Payment Module and Other Modules

Summary

Order Module

Retrieve with Query

Manage with Link