- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Links between Cart Module and Other Modules
This document showcases the module links defined between the Cart Module and other commerce modules.
Summary#
The Cart Module has the following links to other modules:
Cart
data model <>Customer
data model of Customer Module. (Read-only).Order
data model of Order Module <>Cart
data model.Cart
data model <>PaymentCollection
data model of Payment Module.LineItem
data model <>Product
data model of Product Module. (Read-only).LineItem
data model <>ProductVariant
data model of Product Module. (Read-only).Cart
data model <>Promotion
data model of Promotion Module.Cart
data model <>Region
data model of Region Module. (Read-only).Cart
data model <>SalesChannel
data model of Sales Channel Module. (Read-only).
Customer Module#
Medusa defines a read-only link between the Cart
data model and the Customer Module's Customer
data model. This means you can retrieve the details of a cart's customer, but you don't manage the links in a pivot table in the database. The customer of a cart is determined by the customer_id
property of the Cart
data model.
Retrieve with Query#
To retrieve the customer of a cart with Query, pass customer.*
in fields
:
Order Module#
The Order Module provides order-management features.
Medusa defines a link between the Cart
and Order
data models. The cart is linked to the order created once the cart is completed.
Retrieve with Query#
To retrieve the order of a cart with Query, pass order.*
in fields
:
Manage with Link#
To manage the order of a cart, use Link:
Payment Module#
The Payment Module handles payment processing and management.
Medusa defines a link between the Cart
and PaymentCollection
data models. A cart has a payment collection which holds all the authorized payment sessions and payments made related to the cart.
Retrieve with Query#
To retrieve the payment collection of a cart with Query, pass payment_collection.*
in fields
:
Manage with Link#
To manage the payment collection of a cart, use Link:
Product Module#
Medusa defines read-only links between:
- the
LineItem
data model and the Product Module'sProduct
data model. This means you can retrieve the details of a line item's product, but you don't manage the links in a pivot table in the database. The product of a line item is determined by theproduct_id
property of theLineItem
data model. - the
LineItem
data model and the Product Module'sProductVariant
data model. This means you can retrieve the details of a line item's variant, but you don't manage the links in a pivot table in the database. The variant of a line item is determined by thevariant_id
property of theLineItem
data model.
Retrieve with Query#
To retrieve the variant of a line item with Query, pass variant.*
in fields
:
product.*
in fields
.Promotion Module#
The Promotion Module provides discount features.
Medusa defines a link between the Cart
and Promotion
data models. This indicates the promotions applied on a cart.
Medusa also defines a read-only link between the LineItemAdjustment
and Promotion
data models. This means you can retrieve the details of the promotion applied on a line item, but you don't manage the links in a pivot table in the database. The promotion of a line item is determined by the promotion_id
property of the LineItemAdjustment
data model.
Retrieve with Query#
To retrieve the promotions of a cart with Query, pass promotions.*
in fields
:
promotion.*
in fields
.Manage with Link#
To manage the promotions of a cart, use Link:
Region Module#
Medusa defines a read-only link between the Cart
data model and the Region Module's Region
data model. This means you can retrieve the details of a cart's region, but you don't manage the links in a pivot table in the database. The region of a cart is determined by the region_id
property of the Cart
data model.
Retrieve with Query#
To retrieve the region of a cart with Query, pass region.*
in fields
:
Sales Channel Module#
Medusa defines a read-only link between the Cart
data model and the Sales Channel Module's SalesChannel
data model. This means you can retrieve the details of a cart's sales channel, but you don't manage the links in a pivot table in the database. The sales channel of a cart is determined by the sales_channel_id
property of the Cart
data model.
Retrieve with Query#
To retrieve the sales channel of a cart with Query, pass sales_channel.*
in fields
: