Generated the following references: - `entities` - `file` - `fulfillment` - `inventory` - `js_client` - `medusa` - `medusa_config` - `medusa_react` - `modules` - `notification` - `payment` - `price_selection` - `pricing` - `product` - `search` - `services` - `stock_location` - `tax` - `tax_calculation` - `types` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
15 lines
4.0 KiB
Plaintext
15 lines
4.0 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
slug: /references/entities/classes/SalesChannelLocation
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# SalesChannelLocation
|
|
|
|
This represents the association between a sales channel and a stock locations.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The Sales Channel Stock Location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the Sales Channel","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the Location Stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel the location is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"carts","type":"[Cart](entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"locations","type":"[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SalesChannelLocation"/>
|