Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Storefront__custom Domain

The custom domain connected to this tenant's storefront, if any. { permissions: ['*', 'read'], collectionName: 'storefront__CustomDomain' } Requires a signed-in staff user. Needs the `storefront__CustomDomain` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYstorefront__customDomain: StorefrontCustomDomain

The custom domain connected to this tenant's storefront, if any. { permissions: ['*', 'read'], collectionName: 'storefront__CustomDomain' } Requires a signed-in staff user. Needs the storefront__CustomDomain read permission. Send the x-tenant header (the gateway sets it from your API key).

Returns

  1. storefront__customDomain
cnameTarget*String!
createdAt?DateTime

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

domain*String!
hostnameMode*String!
status*StorefrontCustomDomainStatus!
Value inACTIVEFAILEDPENDING
updatedAt?DateTime

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

verifiedAt?DateTime

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

Example Request
query Storefront__customDomain {  storefront__customDomain {    cnameTarget    createdAt    domain    hostnameMode    status    updatedAt    verifiedAt  }}
Example Response
{  "data": {    "storefront__customDomain": {      "cnameTarget": "string",      "createdAt": "<DateTime>",      "domain": "string",      "hostnameMode": "string",      "status": "ACTIVE",      "updatedAt": "<DateTime>",      "verifiedAt": "<DateTime>"    }  }}

Sale__invoices QUERY

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

Storefront__fluid Theme Versions QUERY

Prototype: uploaded Fluid theme zips, newest first. { 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).