On this page
cannedStorefrontThemes
query · in the family Reading your records
What it does
The canned storefront themes to pick from — each key names a ready-made look; storefronts only accept listed keys.
The AT-maintained canned storefront-theme roster: createStorefront/updateStorefront must name a listed key (the refusal NAMES the roster). Unpaginated bounded roster (not a construct list). Requires authentication.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:cannedStorefrontThemes
Returns
StorefrontTheme [StorefrontTheme!]! — One canned storefront theme. The key is the stable contract the DTC render packages ship against.
Example request
query ExampleCannedStorefrontThemes {
cannedStorefrontThemes {
key
caption
description
}
}
Example response
{
"data": {
"cannedStorefrontThemes": [
{
"key": "<key>",
"caption": "Blue jeans",
"description": "Straight-cut, mid-rise, five pockets."
}
]
},
"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)