Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

Links between Stock Location Module and Other Modules

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

Summary#

The Stock Location Module has the following links to other modules:

Tip: Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database.

Fulfillment Module#

A fulfillment set can be conditioned to a specific stock location.

Medusa defines a link between the FulfillmentSet and StockLocation data models.

A diagram showcasing an example of how data models from the Fulfillment and Stock Location modules are linked

Medusa also defines a link between the FulfillmentProvider and StockLocation data models to indicate the providers that can be used in a location.

A diagram showcasing an example of how data models from the Fulfillment and Stock Location modules are linked

Retrieve with Query#

To retrieve the fulfillment sets of a stock location with Query, pass fulfillment_sets.* in fields:

Note: To retrieve the fulfillment providers, pass fulfillment_providers.* in fields.

Manage with Link#

To manage the stock location of a fulfillment set, use Link:

Inventory Module#

Medusa defines a read-only link between the StockLocation data model and the Inventory Module's InventoryLevel data model. This means you can retrieve the details of a stock location's inventory levels, but you don't manage the links in a pivot table in the database. The stock location of an inventory level is determined by the location_id property of the InventoryLevel data model.

Retrieve with Query#

To retrieve the inventory levels of a stock location with Query, pass inventory_levels.* in fields:

Sales Channel Module#

A stock location is associated with a sales channel. This scopes inventory quantities in a stock location by the associated sales channel.

Medusa defines a link between the SalesChannel and StockLocation data models.

A diagram showcasing an example of how resources from the Sales Channel and Stock Location modules are linked

Retrieve with Query#

To retrieve the sales channels of a stock location with Query, pass sales_channels.* in fields:

Manage with Link#

To manage the stock locations of a sales channel, use Link:

Was this page helpful?
Edit this page