Links between Sales Channel Module and Other Modules
This document showcases the module links defined between the Sales Channel Module and other Commerce Modules.
Summary#
The Sales Channel Module has the following links to other modules:
First Data Model | Second Data Model | Type | Description |
|---|---|---|---|
Stored - many-to-many | |||
Cart in Cart Module | Read-only - has one | ||
Read-only - has one | |||
Stored - many-to-many | |||
Stored - many-to-many |
API Key Module#
A publishable API key allows you to easily specify the sales channel scope in a client request.
Medusa defines a link between the ApiKey and the SalesChannel data models.
Retrieve with Query#
To retrieve the API keys associated with a sales channel with Query, pass publishable_api_keys.* in fields:
Manage with Link#
To manage the sales channels of an API key, use Link:
Cart Module#
Medusa defines a read-only link between the Cart Module's Cart data model and the SalesChannel data model. Because the link is read-only from the Cart's side, you can only retrieve the sales channel of a cart, and not the other way around.
Retrieve with Query#
To retrieve the sales channel of a cart with Query, pass sales_channel.* in fields:
Order Module#
Medusa defines a read-only link between the Order Module's Order data model and the SalesChannel data model. Because the link is read-only from the Order's side, you can only retrieve the sales channel of an order, and not the other way around.
Retrieve with Query#
To retrieve the sales channel of an order with Query, pass sales_channel.* in fields:
Product Module#
A product has different availability for different sales channels. Medusa defines a link between the Product and the SalesChannel data models.
A product can be available in more than one sales channel. You can retrieve only the products of a sales channel.
Retrieve with Query#
To retrieve the products of a sales channel with Query, pass products.* in fields:
Manage with Link#
To manage the sales channels of a product, use Link:
Stock Location Module#
A stock location is associated with a sales channel. This scopes inventory quantities associated with that stock location by the associated sales channel.
Medusa defines a link between the SalesChannel and StockLocation data models.
Retrieve with Query#
To retrieve the stock locations of a sales channel with Query, pass stock_locations.* in fields:
Manage with Link#
To manage the stock locations of a sales channel, use Link:
