On this page
changes
query · in the family Your own session
What it does
What shipped across the whole system — the platform’s release notes in plain words, newest first, from any day you name or over the last 90 days.
What shipped, NEWEST first (🆕 — THE CHANGES TAB): the platform's release record in the merchant's words, off the bundled table — the same rows the office's What's new tab shows. since: a UTC calendar day YYYY-MM-DD — the rows on or after it (malformed → VALIDATION/INVALID); absent = the last 90 days. limit: the house page size (default 100, clamps at 200). nextToken: a prior page's cursor VERBATIM (opaque; a foreign cursor → VALIDATION/INVALID). A SELF read — every signed-in person, every role; an integration key reads it too (release notes are public-grade). Requires authentication.
What happens
A read over the platform’s own release record — the same rows the office shows on the landing’s What’s new tab: what changed, why it matters, which surfaces and roles it touches, and the door to open. Nothing of yours is read or changed; every signed-in person sees the same list, and your scripts and assistants can ask for it too.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:changes
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
since | String | no | No further notes. |
limit | Int | no | How many records to answer at most; a page may hold fewer. |
nextToken | String | no | The cursor from the previous page, passed back exactly as received. |
Returns
ChangePage ChangePage! — One page of the release record, NEWEST first (the house page grammar over a bounded table).
This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.
Example request
query ExampleChanges($since: String) {
changes(since: $since) {
items {
key
tag
date
title
summary
surfaces
templates
doorPath
doorWords
record
}
nextToken
}
}
Variables:
{
"since": "<since>"
}
Example response
{
"data": {
"changes": {
"items": [
{
"key": "<key>",
"tag": "<tag>",
"date": "<date>",
"title": "Blue jeans",
"summary": "<summary>",
"surfaces": [
"<surfaces>"
],
"templates": [
"<templates>"
],
"doorPath": "<door path>",
"doorWords": "<door words>",
"record": "<record>"
}
],
"nextToken": "<the cursor from the previous page>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)