calendar_events_read
Returns
required
What a calendar event can be: its types, the agenda item kinds that give it behavior, and the limits writes enforce. New kinds are added here as they ship, so read it before creating or editing events.
Show fields
Show fields
Every agenda item kind this API writes field by field. Stored kinds missing here are read as CalendarUnknownAgendaItem.
Show fields
Show fields
String!
required
What an item of this kind does, including how the Commerce Agent uses it.
String!
required
The merchant-facing name of the kind.
required
The kind, as
kind on a read agenda item.String!
required
The key on CalendarAgendaItemInput that carries this kind’s fields, such as
promotion. Set exactly one key per item.Int!
required
The most events the Commerce Agent reads at once: those in its window with the earliest start. Later ones are left out until earlier ones end.
Int!
required
The Commerce Agent reads events that overlap this many days before and after the current time, when it answers shoppers and when it writes outbound marketing messages. Events further out are not in its context yet.
Every event type createCalendarEvent accepts.
Show fields
Show fields
required
Agenda item kinds an event of this type can carry. Adding any other kind returns AGENDA_ITEM_KIND_NOT_ALLOWED.
String!
required
What events of this type are for.
String!
required
The merchant-facing name of the type.
required
Pass as
type to createCalendarEvent.Boolean!
required
Whether the Commerce Agent reads events of this type as context, within
commerceAgentContextWindowDays of now.Int!
required
The most agenda items a write may leave on one event. A create or update that goes past it returns TOO_MANY_AGENDA_ITEMS; an event already over it, from the merchant app, can still be edited without adding items.
Example
query {
calendarEventCatalog {
commerceAgentContextMaxEvents
commerceAgentContextWindowDays
maxAgendaItemsPerEvent
}
}