runStorefrontThemeCutover

Restricted to platform staff.

Platform only. Carry each named organization's Home CMS into its storefront theme and publish it as version 1. An organization with a theme or a published version is skipped; one with no Home CMS rows gets nothing written.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RunStorefrontThemeCutover($organizationIds: [ID!]!) {
  runStorefrontThemeCutover(organizationIds: $organizationIds) {
    dryRun
    organizations {
      versionNumber
      name
      status
      error
      homeCmsRows
      leftOut
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RunStorefrontThemeCutover($organizationIds: [ID!]!) {\n  runStorefrontThemeCutover(organizationIds: $organizationIds) {\n    dryRun\n    organizations {\n      versionNumber\n      name\n      status\n      error\n      homeCmsRows\n      leftOut\n    }\n  }\n}",
  "variables": {
    "organizationIds": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "organizationIds": [
    "id"
  ]
}

Response:

{
  "data": {
    "runStorefrontThemeCutover": {
      "dryRun": true,
      "organizations": [
        {
          "versionNumber": 0,
          "name": "string",
          "status": "string",
          "error": "string",
          "homeCmsRows": 0,
          "leftOut": [
            "string"
          ]
        }
      ]
    }
  }
}

runStorefrontThemeCutover(
  organizationIds: [ID!]!
): StorefrontCutoverReport!

Arguments

runStorefrontThemeCutover.organizationIds ● [ID!]! non-null scalar

The IDs of the organizations.

Type

StorefrontCutoverReport object

The Home CMS cutover's report (ruling 5).