Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Storefront__tenant Theme

{ 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).

QUERYstorefront__tenantTheme(where: CommonFindDocumentDto!): TenantThemeMap!

{ 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).

Arguments

where*

Returns

  1. storefront__tenantTheme
_id*ID!
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

draftDocumentJson?String
kind*TenantThemeKind!
Value inCATALOGFLUIDLIQUID
name?String
publishedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

publishedDocumentJson?String
status*TenantThemeMapStatus!
Value inARCHIVEDINSTALLEDLIVE
tenant*String!
theme*
themeSlug*String!
themeVersion*String!
updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example Request
query Storefront__tenantTheme($where: CommonFindDocumentDto!) {  storefront__tenantTheme(where: $where) {    _id    createdAt    draftDocumentJson    kind    name    publishedAt    publishedDocumentJson    status    theme {      _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__tenantTheme": {      "_id": "1",      "createdAt": "<DateTime>",      "draftDocumentJson": "string",      "kind": "CATALOG",      "name": "string",      "publishedAt": "<DateTime>",      "publishedDocumentJson": "string",      "status": "ARCHIVED",      "theme": {        "_id": "1",        "allowedTypes": [          "string"        ],        "defaultDocumentJson": "string",        "label": "string",        "nodesJson": "string",        "screenshot": "string",        "slug": "string",        "status": "DRAFT"      }    }  }}

Storefront__fluid Theme Zip QUERY

Prototype: an uploaded Fluid theme zip as base64, for the console customizer to render widgets. { 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__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).