Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Storefront__theme

{ permissions: ['*', 'read'], collectionName: 'storefront__Theme' } Requires a signed-in staff user. Needs the `storefront__Theme` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYstorefront__theme(where: CommonFindDocumentDto!): StorefrontTheme!

{ permissions: ['*', 'read'], collectionName: 'storefront__Theme' } Requires a signed-in staff user. Needs the storefront__Theme read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where*

Returns

  1. storefront__theme
_id*ID!
allowedTypes*[String!]!
defaultDocumentJson?String
label*String!
nodesJson?String
screenshot*String!
slug*String!
status*StorefrontThemeStatus!
Value inDRAFTPUBLISHED
version*String!
Example Request
query Storefront__theme($where: CommonFindDocumentDto!) {  storefront__theme(where: $where) {    _id    allowedTypes    defaultDocumentJson    label    nodesJson    screenshot    slug    status  }}
Variables
{  "where": {    "and": [      {        "and": [          {            "and": [              {                "and": [                  {}                ],                "key": "string"              }            ],            "key": "string"          }        ],        "key": "string"      }    ],    "key": "string"  }}
Example Response
{  "data": {    "storefront__theme": {      "_id": "1",      "allowedTypes": [        "string"      ],      "defaultDocumentJson": "string",      "label": "string",      "nodesJson": "string",      "screenshot": "string",      "slug": "string",      "status": "DRAFT"    }  }}

Storefront__tenant Themes QUERY

{ permissions: ['*', 'read'], collectionName: 'storefront__TenantThemeMap' } Requires a signed-in staff user. Needs the `storefront__TenantThemeMap` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Storefront__themes QUERY

Published catalog themes. System admins see drafts as well. { permissions: ['*', 'read'], collectionName: 'storefront__Theme' } Requires a signed-in staff user. Needs the `storefront__Theme` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).