Types

Self-description of the calling API key: its organization, granted scopes, and the org's store(s) — so a client (e.g. the MCP server) can resolve org/store/theme from the key alone, with no hand-fed ids. Exempt from the API-key scope guard.

Magento-style swatch payload. `type` discriminates how to render `value`: visual_color → hex string ('#FF69B4') visual_image → image URL ('/storage/.../red.jpg') text → display string ('M')

The `Boolean` scalar type represents `true` or `false`.

Per-recipient send record (campaign_recipients projected with engagement).

Configurable product option (e.g. Type, Size, Color). Each value carries its option_id + label + optional swatch (Magento-style: visual color, visual image, or text).

One raw email-channel event (open/click/bounce/…).

A page of suppression entries (total ignores the current page window).

Product Feed — export catalog products to advertising channels (Google Shopping XML, Meta/Facebook catalog CSV, Pinterest TSV). Each feed targets one store, selects products via the shared condition builder, renders through an editable Liquid template, and regenerates on a cron schedule.

The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point).

The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

One inbound web/custom (marketing) event attributed to a lead.

Page of email events. totalPages = ceil(total / pageSize).

Page of marketing/custom events. totalPages = ceil(total / pageSize).

One row of the payment ledger — a single money-movement event with its gateway reference, amount, and timestamp. Drives the admin payment timeline.

A page of store-wide payment events plus the total count for pagination.

Filter + pagination for the store-wide payment log.

Input for updating payment method configuration.

Payment method information returned by queries.

Bulk 'apply rules' run — poll for a live progress bar.

A customer-uploaded personalization file (image/file field).

Aggregated block performance over a window.

A filterable attribute returned by storefront search/collection queries. Storefront sidebar checks `code` against its known facets to decide how to render (range slider vs checkbox list).

Filters accepted by publicSearchProducts / publicCollectionProducts.

The effective template assigned to a product.

A flat record per variant child product. The frontend matches user-selected option_ids against `attributes` to find the variant, then uses its price/sku/image.

One resolved merchandising block ready to render on a storefront page.

The full theme payload (metadata + resolved file tree). Files include parent overrides merged in; each file's `source` field tells you whether it comes from this theme or its parent.

Per-recipient delivery lifecycle for one campaign send.

Input for updating shipping carrier configuration.

Shipping carrier information.

Shipping method within a carrier.

Shipping rate information returned by rate collection.

A payment ledger row enriched with its order linkage, for the store-wide log.

The `String`scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

One file inside a theme tree (path-keyed).

Short-lived bearer token granting unauthenticated preview access to a draft theme.

A single validation issue surfaced by ValidateSettingsData.

Immutable snapshot of a theme's files + settings_data at a point in time.