commerce_agent_settings_read
Arguments
Returns
One version of the Commerce Agent’s Playbook settings.
brandBio, excludeSmsProviderUnsubscribers and capabilities are live: the same in both versions.Show fields
Show fields
A short description of the brand. Live: one value for both versions, outside
revision. Null when none is set.Outreach channels.
Show fields
Show fields
Email. Off until the merchant switches it on.
Show fields
Show fields
Whether the channel is switched on in this version. Not reduced by
status: a channel the store cannot use yet still shows what was chosen.Whether the channel can send, from this version’s switch plus the store’s live access. Access is the same in both versions.
Extended outreach: Commerce Agent’s messages beyond replies, such as cart recovery.
Show fields
Show fields
Whether the channel is switched on in this version. Not reduced by
status: a channel the store cannot use yet still shows what was chosen.Whether the channel can send, from this version’s switch plus the store’s live access. Access is the same in both versions.
iMessage.
Show fields
Show fields
Whether the channel is switched on in this version. Not reduced by
status: a channel the store cannot use yet still shows what was chosen.Whether the channel can send, from this version’s switch plus the store’s live access. Access is the same in both versions.
Rich text messages (RCS).
Show fields
Show fields
Whether the channel is switched on in this version. Not reduced by
status: a channel the store cannot use yet still shows what was chosen.Whether the channel can send, from this version’s switch plus the store’s live access. Access is the same in both versions.
Text messages. On until the merchant switches it off.
Show fields
Show fields
Whether the channel is switched on in this version. Not reduced by
status: a channel the store cannot use yet still shows what was chosen.Whether the channel can send, from this version’s switch plus the store’s live access. Access is the same in both versions.
The discount the agent may offer.
Show fields
Show fields
The DiscountCode the agent may offer. Null when none is linked, or when the discount code was deleted.
How readily the agent offers the discount. Null when it was never set.
Whether texts skip shoppers who unsubscribed through another SMS provider. Live: one value for both versions, outside
revision.Whether the agent replies to shoppers who write back. A version with no stored choice reads true, as the agent does.
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.
Example
query {
commerceAgentConfig(version: DRAFT) {
brandBio
brandName
enabled
excludeSmsProviderUnsubscribers
guidelines
personaName
recontactCooldownHours
repliesEnabled
# ...
}
}