Skip to main content

StorefrontEditJob

A started storefront edit.

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

Fields​

StorefrontEditJob.costDisplay ● String scalar​

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

StorefrontEditJob.creditsUsedCents ● Int scalar​

The credits used so far, in cents.

StorefrontEditJob.error ● String scalar​

The upstream failure, verbatim. Never a generic fallback.

StorefrontEditJob.jobId ● ID! non-null scalar​

The ID of the job.

StorefrontEditJob.partial ● String scalar​

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

StorefrontEditJob.result ● JSON scalar​

On COMPLETED: { pageId, edits, skipped, summary?, unmet?, answer? }. edits are checked value edits in ids, in order ({ from, why, kind: setValue|setStyle|setHidden|setSurfaces|move|setLabel|setTheme, … }), for the editor to apply as one undo step after checking each again (@arc/theme-engine checkEdit). skipped lists each requested edit that could not be used ({ index, op, why, reason, sectionId?, blockId?, field?, value? }). answer is the reply in plain text when the seller asked a question (help mode), usually with no edits. Writes nothing.

StorefrontEditJob.stage ● String! non-null scalar​

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

StorefrontEditJob.status ● StorefrontSectionJobStatus! non-null enum​

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

Returned By​

cancelStorefrontEditGeneration mutation ● startStorefrontEditGeneration mutation ● storefrontEditGenerationJob query