Skip to content

Beacons

Returns every beacon (announcement) configured for your shop. Takes no arguments.

Returns a non-null list of non-null Beacon objects ([Beacon!]!).

FieldTypeDescription
idID!Unique identifier.
nameStringBeacon name.
messageStringAnnouncement text shown to customers.
iconStringIcon identifier.
activeBooleanWhether currently active.
query {
beacons {
id
name
message
icon
active
}
}
{
"data": {
"beacons": [
{
"id": "7",
"name": "Double stamps weekend",
"message": "Earn double beans all weekend!",
"icon": "sparkles",
"active": true
}
]
}
}