Skip to main content
Required scopes: commerce_agent_settings_read
String
A short description of the brand. Live: one value for both versions, outside revision. Null when none is set.
String
What the agent calls the store. Null means it uses the store name.
What the agent can do today. Read only.
Outreach channels.
The discount the agent may offer.
Boolean!
required
Whether the Commerce Agent is on.
Handing conversations to the support team.
Boolean!
required
Whether texts skip shoppers who unsubscribed through another SMS provider. Live: one value for both versions, outside revision.
[String!]!
required
The merchant’s guidelines for the agent, in order.
String
The name the agent goes by. Null when none is set.
Int
Hours before the agent contacts the same shopper again. Null means the default.
Boolean!
required
Whether the agent replies to shoppers who write back. A version with no stored choice reads true, as the agent does.
Late-return cutoffs. Null when none are set.
String!
required
Identifies this version’s content. It changes when any setting in the version changes, including settings this type does not show: instant exchanges, knowledge auto-apply, email replies, Shop Pay, guideline rules, escalation guidelines and capability guidance. It identifies what is stored, so saving a setting again with the same effective value, such as switching off a channel that was already off, can change it too. A fresh draft has the published revision. Live fields are not part of it.
Tone and voice. A version with no stored choice reads the default sliders.