Details about the sales channel, including its settings, metadata, and associated resources.
Fields
id
StringThe unique identifier for sales channel.
banner
SecureUrlURL of the banner image for the sales channel.
banner_url
StringURL of the banner image for the sales channel.
description
StringDetailed description about the sales channel.
domain
Domain!Required
Primary domain associated with the sales channel.
domains
[Domain]!Required
List of domains associated with the sales channel.
favicon
SecureUrlURL for the favicon image for the sales channel.
favicon_url
StringURL for the favicon image for the sales channel.
logo
SecureUrlURL of the logo image for the sales channel.
logo_url
StringURL of the logo image for the sales channel.
mobile_logo
SecureUrlURL of the mobile version of the logo image for the sales channel.
mobile_logo_url
StringURL of the mobile version of the logo image for the sales channel.
name
String!Required
Name of the sales channel, e.g. 'My Fashion Store'.
app_type
AppTypeShows whether sales channel is live or in development mode.
auth
ApplicationAuthAuthentication settings for the sales channel.
cache_ttl
IntCache time-to-live in seconds, e.g. 3600 for 1 hour.
channel_type
StringChannel type like 'store', 'website-and-mobile-apps'. Default value is 'store'.
company_id
Int!Required
The ID of the company this sales channel belongs to.
cors
ApplicationCorsCORS configuration for the sales channel.
created_at
String!Required
Timestamp when sales channel was created, e.g. '2023-10-15T10:30:00Z'.
modified_at
String!Required
Timestamp when sales channel was updated, e.g. '2023-10-16T14:20:00Z'.
updated_at
StringTimestamp when sales channel was updated, e.g. '2023-10-16T14:20:00Z'.
is_active
Boolean!Required
Indicates whether sales channel is active or inactive.
is_internal
BooleanIndicates whether a sales channel is internal or external.
List of meta information for the sales channel.
owner
StringThe unique ID of the owner who owns the sales channel.
redirections
[ApplicationRedirections]List of redirections for the sales channel.
token
StringRandomly generated fixed length string for sales channel. It is required and auto-generated.
website
ApplicationWebsiteSales channel website details.
version
FloatVersion key for tracking revisions. Default value is zero.
slug
String!Required
A short URL-friendly identifier of a sales channel, e.g. 'my-fashion-store'.
mode
ApplicationMode!Required
Shows whether sales channel is in 'live' or 'development' mode.
status
ApplicationStatus!Required
Current status of the sales channel, e.g. 'active', 'blocked'.
tokens
[TokenSchema]List of tokens associated with the sales channel.
Was this section helpful?