Details about the sales channel, including its settings, metadata, and associated resources.
Fields
id
StringThe unique identifier (24-digit Mongo Object ID) for the sales channel details.
banner
SecureUrlURL of the banner image for the sales channel.
description
StringIt gives a detailed information about the sales channel.
domain
DomainPrimary domain associated with the sales channel.
domains
[Domain]List of domains associated with the sales channel.
favicon
SecureUrlList of domains associated with the sales channel.
logo
SecureUrlURL of the logo image for the sales channel.
mobile_logo
SecureUrlURL of the mobile version of the logo image for the sales channel.
name
String!Required
Store name of the ordering store.
app_type
AppTypeIt shows application is live or in development mode.
auth
ApplicationAuthAuthentication settings for the sales channel.
cache_ttl
IntAn integer value that specifies the number of seconds until the key expires.
channel_type
StringIt indicates different channel types like store, website-and-mobile-apps. Default value is store.
company_id
IntNumeric ID allotted to a business account where the sales channel exists.
cors
ApplicationCorsCORS configuration for the sales channel.
created_at
StringISO 8601 timestamp of sales channel creation.
updated_at
StringISO 8601 timestamp of sales channel updation.
is_active
BooleanIndicates sales channel is active or not active.
is_internal
BooleanIndicates whether a sales channel is internal or not.
List of meta information for the sales channel.
owner
StringThe unique identifier (24-digit Mongo Object ID) of owner who owns the application.
redirections
[ApplicationRedirections]List of redirections for the sales channel.
token
StringRandom generated fix length string for sales channel. It is required and auto-generated.
website
ApplicationWebsiteSales channel website details.
modified_at
StringISO 8601 timestamp of sales channel updation.
version
FloatVersion key for tracking revisions. Default value is zero.
slug
StringSlug identifier.
mode
StringApplication mode.
status
StringCurrent status of the application.
tokens
[TokenSchema]List of tokens associated with the sales channel.
Was this section helpful?