Links between Region Module and Other Modules

This document showcases the module links defined between the Region Module and other commerce modules.

Summary#

The Region Module has the following links to other modules:

• Region data model <> Cart data model of the Cart Module. (Read-only)
• Region data model <> Order data model of the Order Module. (Read-only)
• Region data model <> PaymentProvider data model of the Payment Module.

Cart Module#

Medusa defines a read-only link between the Region data model and the Cart Module's Cart data model. This means you can retrieve the details of a region's carts, 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 carts of a region with Query, pass carts.* in fields:

Order Module#

Medusa defines a read-only link between the Region data model and the Cart Module's Cart data model. This means you can retrieve the details of a region's orders, but you don't manage the links in a pivot table in the database. The region of an order is determined by the region_id property of the Order data model.

Retrieve with Query#

To retrieve the orders of a region with Query, pass orders.* in fields:

Payment Module#

You can specify for each region which payment providers are available for use.

Medusa defines a module link between the PaymentProvider and the Region data models.

Retrieve with Query#

To retrieve the payment providers of a region with Query, pass payment_providers.* in fields:

Manage with Link#

To manage the payment providers in a region, use Link: