Skip to main content

StorefrontPageJob

A started storefront page generation.

type StorefrontPageJob {
  costDisplay: String
  creditsUsedCents: Int
  error: String
  jobId: ID!
  page: JSON
  partial: String
  stage: String!
  status: StorefrontSectionJobStatus!
}

Fields​

StorefrontPageJob.costDisplay ● String scalar​

Platform billing figure in USD — Growmax billing the tenant, not tenant money.

StorefrontPageJob.creditsUsedCents ● Int scalar​

The credits used so far, in cents.

StorefrontPageJob.error ● String scalar​

The upstream failure, verbatim. Never a generic fallback.

StorefrontPageJob.jobId ● ID! non-null scalar​

The ID of the job.

StorefrontPageJob.page ● JSON scalar​

On COMPLETED: { import, sections, unmet, journeys }. import is an importer's answer for the theme editor ({ placements, leftOut, notes }: built-in library sections only, on the home page; the editor places them where the seller asked). sections describes each imported section in order: { index, kind, name, why?, surfaces, twinOf?, appDraws, needsPicture, records: [{ type, id, name }], journeys: [{ id, label, via }], placeholders }. unmet lists what the library cannot show ({ what, journey }), and journeys.used the journeys the page opens. Writes nothing.

StorefrontPageJob.partial ● String scalar​

While the job runs: the tail of any prose the model writes outside its plan (usually empty). Empty once the job ends.

StorefrontPageJob.stage ● String! non-null scalar​

What the job is doing now: queued, reading, choosing, repairing, filling, done, failed or cancelled. A plain string, so treat a value you do not know as 'choosing'.

StorefrontPageJob.status ● StorefrontSectionJobStatus! non-null enum​

The same lifecycle as a section job (StorefrontSectionJobStatus is registered once, for both).

Returned By​

cancelStorefrontPageGeneration mutation ● startStorefrontPageGeneration mutation ● storefrontPageGenerationJob query