Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceMutations

Storefront__create Custom Domain

Connect a custom domain for DNS verification. { permissions: ['*', 'create'], collectionName: 'storefront__CustomDomain' } Requires a signed-in staff user. Needs the `storefront__CustomDomain` `create` permission. Send the `x-tenant` header (the gateway sets it from your API key).

MUTATIONstorefront__createCustomDomain(input: CreateCustomDomainInput!): StorefrontCustomDomain!

Connect a custom domain for DNS verification. { permissions: ['*', 'create'], collectionName: 'storefront__CustomDomain' } Requires a signed-in staff user. Needs the storefront__CustomDomain create permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

input*

Returns

  1. storefront__createCustomDomain
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
mutation Storefront__createCustomDomain($input: CreateCustomDomainInput!) {  storefront__createCustomDomain(input: $input) {    cnameTarget    createdAt    domain    hostnameMode    status    updatedAt    verifiedAt  }}
Variables
{  "input": {    "domain": "string",    "hostnameMode": "string"  }}
Example Response
{  "data": {    "storefront__createCustomDomain": {      "cnameTarget": "string",      "createdAt": "<DateTime>",      "domain": "string",      "hostnameMode": "string",      "status": "ACTIVE",      "updatedAt": "<DateTime>",      "verifiedAt": "<DateTime>"    }  }}

Seed MUTATION

Platform admin only.

Storefront__delete Custom Domain MUTATION

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