calendarEvent

Required scopes: calendar_events_read

Arguments

ID!

required

The event’s id.

Returns

Something happening for the brand on a known date, such as a sale, launch, or holiday, with an agenda of typed items that give it behavior. The Commerce Agent reads MARKETING events near the current date as context, both when it answers shoppers and when it writes outbound marketing messages, and may repeat what they say to shoppers.

Show fields

[CalendarEventAgendaItem!]!

required

The typed items attached to this event, in order. A kind this API version does not model is returned as CalendarUnknownAgendaItem. Change them with agendaOperations on updateCalendarEvent.

Show fields

ID!

required

The id of this agenda item. Pass it to an update or remove agenda operation on updateCalendarEvent.

CalendarAgendaItemKind!

required

What this item adds to the event.

[JSON!]!

required

agenda with every field selected, as JSON: one element per item, in order, with __typename.

Boolean!

required

Whether the event spans whole days in timezone rather than specific times.

DateTime!

required

When the event was created.

String

Notes about the event. The Commerce Agent reads them for MARKETING events and may repeat them to shoppers, so keep internal notes out.

DateTime!

required

When the event ends. Never before startAt.

ID!

required

The id of this calendar event.

DateTime!

required

When the event starts.

CalendarEventStatus!

required

Whether the event is upcoming, happening now, or ended.

String!

required

The IANA time zone the event was written in, such as America/New_York. startAt and endAt are instants; this is how to show them.

String!

required

The name of the event. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.

CalendarEventType!

required

The part of the business this event belongs to.

DateTime!

required

When the event or its agenda was last changed.

Example

query {
  calendarEvent(id: "...") {
    agendaJson
    allDay
    createdAt
    description
    endAt
    id
    startAt
    status
    # ...
  }
}

Getting Started

Reference

calendarEvent

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example