Mutations

Create/replace a per-user AI client artifact (e.g. mockup HTML) keyed by (thread_key, name). Scoped to the caller's org+user.

Delete a per-user AI client artifact.

Restore the whole workspace (theme + data) to a checkpoint: rolls the theme back AND inverse-undoes the run's data created after the checkpoint. Own org only.

Bulk upsert leads by email; optionally add them to a list. Returns imported count.

Launch the campaign immediately (draft|scheduled → sending).

Schedule the campaign for a future time. Use sendCampaign to launch now.

Send the campaign to up to 5 test addresses without affecting stats.

Start an async full reindex of the active org's products into Elasticsearch. Returns immediately with a run row to poll; single-flight per org (a fresh in-progress run is returned as-is).

Purge the active org's entire cached storefront (all pages) from the edge + data caches.

Public storefront submission. Anonymous OK. Status='pending' unless the store has auto_approve_reviews=true. Errors if accept_reviews=false.

Record debt payment

Increase customer debt (for manual adjustments)

Create new RFM segment rule

Update existing RFM segment rule

Delete RFM segment rule

Toggle active status of RFM segment rule

Reorder RFM segment rules by priority

Add a product to the current customer's or anon session's wishlist. Idempotent.

Remove a product. No-op if not present.

Upsert a swatch row for an option. `type` must be one of visual_color | visual_image | text. `value` is interpreted accordingly (hex / URL / display string). `store_id=0` is the global default; pass a non-zero store_id for per-store overrides.

Delete a swatch row for an option (option_id + store_id pair). The option itself is preserved — only the swatch payload is removed, so the storefront falls back to plain label rendering.

Send a live test email through the sender's SMTP (or the process transport).

Register a sending domain (DKIM selector defaults to em1).

Re-run SPF/DKIM/DMARC DNS lookups and persist the verification flags.

Enqueue a test email (pre-rendered HTML) through the real send pipeline.

Restore a system template's content from its canonical default.

Render + enqueue a test send of this template to an address (uses store default sender). When subject+html are both supplied the content is rendered raw (unsaved); otherwise the saved template is rendered. sampleData merges over the default {first_name, email} context.

Open pixel — records an open from the encrypted token. Returns true.

Click — records a click; returns the decoded redirect URL.

Unsubscribe — records the unsub, flips the lead, adds a suppression.

Storefront/custom marketing event collection (lead-attributed).

Assign (or clear, with eventName=null) the event that fills a role for a store.

Add a user-defined custom role (extends the standard set).

Register (or update, by name) a custom event in the catalog.

Remove a custom event definition.

Auto-map every unmapped role to its best suggestion (observed event / default).

Define (or update by name) a custom conversion metric.

Delete a conversion metric.

Create a plan definition (platform admin).

Update a plan definition (platform admin).

Assign a plan to an org (platform admin).

Make a plan the global default auto-assigned to every new org (platform admin).

Override which plan the orgs THIS account creates get; null reverts to the global default (platform admin).

Override how many shops (orgs) an account may create; null reverts to the default (platform admin).

Grant/revoke cross-org platform-admin on an account (platform admin).

Change an account's status: active | inactive | suspended (platform admin).

Suspend/reactivate a shop (org): active | suspended. Suspended shops serve a 'deactivated' page on their storefront (platform admin).

Enable/disable the AI chat editor for an org (platform admin). Effective only when the org's plan allows AI and the server has an AI key.

Enqueue an immediate generation; returns the new run to poll.

Render a candidate config against a few sample products without writing a file.

Restore a system flow's trigger + definition from its canonical default.

Manually enroll one contact for testing.

Synchronous debug run (sim send/render, cycle detection, 30s timeout).

Persist a builder test run into the flow's execution history.

Public form submission — upserts a lead, adds to the target list, stores the submission. IP/UA/geo/utm are read server-side from request headers.

Create a catalog price rule. Reindex runs async via the durable job queue.

Update a catalog price rule. Reindex runs async.

Delete a catalog price rule. Stage-1 + stage-2 rows are cleaned up by the indexer.

Manually trigger a reindex. rule_id = null → full org reindex. Returns immediately.

Create a new promotion

Update a promotion

Create a new sales rule

Update a sales rule

Delete a sales rule

Duplicate a sales rule

Generate multiple coupons

Create a primary coupon

Delete coupons

Export coupons to CSV

Import coupons from CSV

Record a block impression or product click for analytics. Fire-and-forget; always returns true (never breaks the storefront).

Record a storefront PDP view. Feeds the 'Also viewed' co-view affinity + recently-viewed signal. Fire-and-forget; always returns true.

Patch the moderation block in a store's settings JSON (accepts/auto-approve for comments+reviews).

Patch the branding block (logo + favicon) and SEO defaults on a store.

Update payment method configuration for a store.

Enable or disable a specific payment method for a store.

Pin a manual template on a product (overrides any rule-sourced assignment).

Remove a manual pin; rules may then reclaim the product.

Re-resolve every rule-sourced assignment for the org (async, progress-tracked).

Anonymous storefront upload for an image/file personalization field. Validates the field's accept + max size server-side; returns a stored /storage URL to embed in the cart line options.

Open cashier shift

Close cashier shift

Record cash drawer operation

Release a pre-order: reserve stock for held units + move it into fulfilment (admin 'Release now').

Update shipping carrier configuration for a store.

Enable or disable a specific shipping carrier for a store.

Enqueue a REAL test conversion to the destination's Conversions API; appears in the delivery log.

Storefront CAPI beacon: forward a canonical event to server-side destinations (deduped by event_id).

Issue a fresh signing secret (returned once).

Play-demo: enqueue a REAL signed test delivery; appears in the delivery log.

Play-demo: preview the signed request for an event WITHOUT sending it.

Create a new blog post

Update a blog post

Delete a blog post

Publish a blog post immediately

Schedule a blog post for future publication

Unpublish a blog post (revert to draft)

Create a new blog category

Update a blog category

Delete a blog category

Reorder blog categories

Create a new blog tag

Update a blog tag

Delete a blog tag

Create a new blog comment

Public storefront submission. Anonymous OK. Status = 'pending' unless the store has auto_approve_comments=true. Errors if accept_comments=false.

Approve a blog comment

Reject a blog comment (mark as spam)

Delete a blog comment

Bulk approve comments

Bulk mark comments as spam

Create a new collection

Update an existing collection

Delete a collection

Manually add products to a collection

Remove products from a collection

Update product positions in a collection

Refresh collection products based on current conditions

Upload a single media file to a store

Upload multiple media files to a store

Update media metadata

Delete a single media item

Delete multiple media items

Upload an image for webstore content (blog, collection, category)

Delete a webstore image by URL

Upload a custom font file (TTF, OTF, WOFF, WOFF2)

Update font metadata

Delete a custom font

Create a new menu

Update a menu

Delete a menu

Create a menu item

Update a menu item

Delete a menu item

Reorder menu items (bulk update positions)

Duplicate a menu

Update menu styles

Update menu item style override

Bulk add menu items from resources

Create a new page

Update an existing page

Save page content (Craft.js JSON) - used by auto-save

Delete a page

Publish a page

Unpublish a page

Schedule page publication

Duplicate a page

Create default pages for a store

Save a global section

Toggle global section visibility

Publish a global section (copy draft to published)

Register a new customer account for a storefront

Login as a customer

Logout the current customer (revokes token)

Add a product to the storefront cart. Auto-creates a guest quote when none exists for this session_id.

Update a cart item quantity

Remove an item from guest cart

Clear every line from the storefront cart (returns the now-empty quote).

Add a new entry to the authed customer's address book.

Patch an existing saved address (ownership enforced by the resolver).

Soft-delete a saved address. Returns success=false silently when the row isn't found / not owned.

Flip the default shipping or billing flag onto the given address (clears the previous default of the same kind).

Update the authed customer's own profile (name / phone / email). Mirrors updateCustomer but scoped to self — no admin perms needed.

Change the authed customer's password. Requires the current password.

Request a password reset link. Always returns success=true to prevent email enumeration.

Confirm a password reset using the token issued by storefrontRequestPasswordReset.

Apply voucher code to guest cart

Remove voucher from guest cart

Set shipping address on storefront cart

Set shipping method on storefront cart

Set payment method on storefront cart

Set customer contact info for guest checkout

Set the customer-provided order note on the quote (gated by shop.allow_order_note)

Place order from storefront guest cart

Redeem loyalty points on the cart for a discount. Requires a signed-in customer (Bearer token); the resolver links the customer to the quote. Validates min/balance/cap server-side. Points are only deducted when the order is placed.

Cancel a pending loyalty-points redemption on the cart.

Pre-create order in pending_payment status + issue Stripe PaymentIntent.

Confirm a Stripe payment after Stripe.js redirects back with payment_intent succeeded. Server re-verifies status with Stripe then flips order to processing/paid. Idempotent.

Pre-create order in pending_payment status + build a signed VNPay payment URL. return_url is where VNPay redirects the browser back (e.g. https://shop/checkout/vnpay-return).

Confirm a VNPay payment from the return-url params. Server re-verifies the HMAC-SHA512 signature + amount (never trusts the client) then flips the order to processing/paid. Idempotent with the server IPN.

Create a new custom theme

Update an existing theme

Update theme settings (colors, typography, etc.)

Delete a theme

Duplicate a theme

Activate a theme for a store

Install a template/preset design into a store as an unpublished draft (clone of the chosen template). Publish/activate it to switch the storefront.

Export a theme to JSON

Import a theme from JSON

Create a section for a theme

Update a theme section

Delete a theme section

Delete a theme asset

Create or replace a single theme file.

Bulk write a batch of theme files (used by editor save-all + seeder).

Rename a theme file.

Delete a theme file.

Snapshot the current state of a theme (creates a new version row).

Restore every file in the theme to a previous snapshot.

Snapshot + flip the theme's published_files_version_id to point at the new snapshot. Optionally promote to 'main' (live).

Open a theme for editing in the Customizer. If the theme is currently 'main', returns (or creates) a draft clone whose parent_theme_id points back at the main; if a draft already exists for this main it is returned unchanged so the merchant continues their in-progress edits.

Promote a draft theme (role='unpublished' with parent_theme_id set) into the live 'main' slot for its store, demoting the previous main to 'unpublished' as a one-click backup. Snapshots the draft into theme_versions before swapping so the change is auditable + rollback-able.

Issue a short-lived preview token (auth required).

Revoke a preview token (called on logout / editor close).

Save a store-level widget template override

Save a theme-level widget template

Reset/delete a store-level widget template override

Reset/delete a theme-level widget template

Validate a Liquid template without saving