Skip to main content
Skip to main content

SalesChannel

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

Properties

idstringRequired
The sales channel's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
namestringRequired
The name of the sales channel.
descriptionnull | stringRequired
The description of the sales channel.
is_disabledbooleanRequired
Specify if the sales channel is enabled or disabled.

Default: false

metadatanull | Record<string, unknown>Required
An optional key-value map with additional details
productsProduct[]Required
cartsCart[]Required
The associated carts.
ordersOrder[]Required
The associated orders.
publishableKeysPublishableApiKey[]Required
The associated publishable API keys.
locationsSalesChannelLocation[]Required
The details of the stock locations related to the sales channel.
Was this section helpful?