local-storefront 0.2.0 → 0.3.0-rc.1

package/docs/data-reference.md

@@ -0,0 +1,1247 @@
+# Store data reference
+
+Every type of the store data format. This file is generated from the JSON Schema the
+validator uses (`npx local-storefront docs --reference`); the guide is in
+[data-format.md](data-format.md).
+
+## Data file
+
+A data file: any combination of the sections below. Every `*.json` file at the root of the
+data directory is one of these, and they are merged, so you can split the data as you like
+(`shop.json`, `catalog.json`, ...).
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"./schema/store.schema.json"`. |
+| `shop` | [Shop](#shop) | General store information. At most one data file may define it. |
+| `products` | array of [Product](#product) | Products. They can also live one per file in `products/`. |
+| `collections` | array of [Collection](#collection) | Collections. They can also live one per file in `collections/`. |
+| `pages` | array of [Page](#page) | Pages. They can also live one per file in `pages/`. |
+| `blogs` | array of [Blog](#blog) | Blogs with their articles. They can also live one per file in `blogs/`. |
+| `menus` | map of [Menu](#menu) | Navigation menus by handle, e.g. `main-menu` and `footer`. |
+| `customers` | array of [Customer](#customer) | Customers. They can also live one per file in `customers/`. |
+| `companies` | array of [Company](#company) | Companies that buy from the store (B2B). Customers join one with their `company`. |
+| `gift_cards` | array of [GiftCard](#giftcard) | Issued gift cards, each with its own page. |
+| `metaobjects` | map of array of [Metaobject](#metaobject) | Metaobject entries by type. |
+| `localization` | [Localization](#localization) | The countries and languages of the store. At most one data file may define it. |
+| `swatches` | map of [Swatch](#swatch) | The swatches of product option values, by the name of the value: `{"White": "#ffffff", "Floral": {"image": "swatches/floral.jpg"}}`. Every option value with one of these names gets the swatch, on products and in collection filters. |
+| `locations` | array of [Location](#location) | The places the store stocks products at, for store pickup. |
+| `selling_plan_groups` | array of [SellingPlanGroup](#sellingplangroup) | Groups of selling plans: subscriptions, pre-orders and other purchase options. |
+| `files` | map of [File](#file) | Metadata for files in `files/`, by path. |
+| `session` | [Session](#session) | What every new browser session starts with: a logged-in customer, a filled cart... |
+| `checkout` | [Checkout](#checkout) | The fake checkout of `lsf app dev --app`: shipping rates, payment methods, discounts and Function settings. At most one data file may define it. |
+| `now` | string | Freezes the clock: the instant `'now'` resolves to, e.g. `"2025-01-15T10:00:00Z"`. Set it to make renders reproducible; each `'now'` of a render is then one nanosecond after the previous one, so `%N` still differs between calls. Defaults to the real time, read at each `'now'`. |
+| `theme_settings` | map of any JSON value | Overrides for theme settings (`config/settings_data.json`), by setting id. |
+| `app` | [AppInstallation](#appinstallation) | The app of `--app` as this store has it installed: what its theme app extensions read. |
+
+## Shop
+
+General store information (the `shop` object). Every field has a sensible default.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `name` | string | Defaults to `"Local Store"`. |
+| `description` | string |  |
+| `email` | string |  |
+| `phone` | string |  |
+| `domain` | string | The primary domain, without scheme. Defaults to the host the server is reached on. |
+| `permanent_domain` | string | The `*.myshopify.com` domain. Defaults to a value derived from the name. |
+| `currency` | string | ISO 4217 code of the store currency. Defaults to `USD`. |
+| `money_format` | string | How `money` formats amounts, e.g. `"${{amount}}"` or `"{{amount_with_comma_separator}} €"`. Defaults to the usual format of the currency. |
+| `money_with_currency_format` | string | How `money_with_currency` formats amounts, e.g. `"${{amount}} USD"`. |
+| `timezone` | string | IANA time zone used to display dates, e.g. `"Europe/Paris"`. Defaults to `UTC`. |
+| `address` | [Address](#address) |  |
+| `policies` | [Policies](#policies) |  |
+| `enabled_payment_types` | array of string | Payment icons to show, e.g. `["visa", "master", "american_express", "paypal"]`. |
+| `customer_accounts_enabled` | boolean | Whether customer accounts exist at all. Defaults to `true`. |
+| `customer_accounts_optional` | boolean | Whether checking out as a guest is possible. Defaults to `true`. |
+| `taxes_included` | boolean | Whether prices include taxes. Defaults to `false`. |
+| `password_message` | string | The message shown on the password page. |
+| `password` | string | The password the `/password` page accepts. Defaults to `"password"`. The storefront is never locked: the page is there to be worked on, and nothing leads to it. |
+| `brand` | [Brand](#brand) |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Address
+
+A postal address. Every field is optional.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `first_name` | string |  |
+| `last_name` | string |  |
+| `company` | string |  |
+| `address1` | string |  |
+| `address2` | string |  |
+| `city` | string |  |
+| `province` | string | Province or state name, e.g. `"Ontario"`. |
+| `province_code` | string | E.g. `"ON"`. |
+| `country` | string | Country name, e.g. `"Canada"`. |
+| `country_code` | string | ISO 3166-1 alpha-2 code, e.g. `"CA"`. |
+| `zip` | string |  |
+| `phone` | string |  |
+
+## Policies
+
+The store policies. Each one that is set gets a page under `/policies/`.
+
+| Field | Type | Description |
+|---|---|---|
+| `privacy_policy` | [Policy](#policy) |  |
+| `refund_policy` | [Policy](#policy) |  |
+| `shipping_policy` | [Policy](#policy) |  |
+| `terms_of_service` | [Policy](#policy) |  |
+| `subscription_policy` | [Policy](#policy) |  |
+
+## Policy
+
+A store policy (`shop.refund_policy`, `/policies/refund-policy`).
+
+| Field | Type | Description |
+|---|---|---|
+| `title` | string | Defaults to the standard title of the policy. |
+| `body` | string | **Required.** HTML body. |
+
+## Brand
+
+The brand assets of the store (`shop.brand`).
+
+| Field | Type | Description |
+|---|---|---|
+| `slogan` | string |  |
+| `short_description` | string |  |
+| `logo` | [Image](#image) |  |
+| `square_logo` | [Image](#image) |  |
+| `cover_image` | [Image](#image) |  |
+| `favicon` | [Image](#image) |  |
+| `colors` | any JSON value | Brand colors as CSS hex strings, e.g. `{"primary": ["#112233"], "secondary": []}`. |
+
+## Image
+
+An image: either just its source, or an object with more detail.
+
+The source is a path inside the `files/` directory of the data directory
+(`"shirt.jpg"` → `files/shirt.jpg`). When no such file exists a placeholder of the declared
+size is generated, so fixtures work without shipping real images.
+
+One of:
+
+- string
+- [ImageDetail](#imagedetail)
+
+## ImageDetail
+
+An image with its metadata.
+
+| Field | Type | Description |
+|---|---|---|
+| `src` | string | **Required.** Path of the image inside `files/`, e.g. `"products/shirt-front.jpg"`. |
+| `alt` | string | Alternative text. Defaults to an empty string. |
+| `width` | integer | Width in pixels. Read from the file when it exists, otherwise defaults to 1200. |
+| `height` | integer | Height in pixels. Read from the file when it exists, otherwise defaults to 1200. |
+| `id` | integer |  |
+| `focal_point` | [FocalPoint](#focalpoint) | The focal point as percentages from the top-left corner, e.g. `{"x": 50, "y": 20}`. |
+
+## FocalPoint
+
+The point of an image that should stay visible when it is cropped.
+
+| Field | Type | Description |
+|---|---|---|
+| `x` | number | **Required.** Horizontal position, 0 (left) to 100 (right). |
+| `y` | number | **Required.** Vertical position, 0 (top) to 100 (bottom). |
+
+## Metafield
+
+A metafield value. Write the value directly and its type is inferred (string →
+`single_line_text_field`, integer → `number_integer`, decimal → `number_decimal`, boolean →
+`boolean`, anything else → `json`), or spell out `{"type": ..., "value": ...}`.
+
+One of:
+
+- [TypedMetafield](#typedmetafield)
+- any JSON value
+
+## TypedMetafield
+
+A metafield with an explicit type.
+
+| Field | Type | Description |
+|---|---|---|
+| `type` | string | **Required.** A Shopify metafield type, e.g. `single_line_text_field`, `multi_line_text_field`, `rich_text_field`, `number_integer`, `number_decimal`, `boolean`, `color`, `date`, `date_time`, `url`, `json`, `money`, `rating`, `weight`, `volume`, `dimension` and the other measurements (`distance`, `temperature`, `duration`...), `product_reference`, `collection_reference`, `page_reference`, `article_reference` (`blog/article`, or the article's handle alone), `file_reference`, `metaobject_reference`, or a `list.` variant of those. |
+| `value` | any JSON value | **Required.** The value. References are written as handles (`"blue-shirt"`), files as paths inside `files/`, lists as JSON arrays. |
+
+## Product
+
+A product.
+
+The smallest valid product is `{"title": "Blue shirt", "price": 1999}`: it gets a single
+default variant, like a product without options in the Shopify admin.
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/product.schema.json"`. |
+| `id` | integer | Generated from the handle when omitted. |
+| `title` | string | **Required.** |
+| `handle` | string | The URL slug (`/products/<handle>`). Derived from the title when omitted. In a `products/<name>.json` file it defaults to the file name. |
+| `description` | string | HTML description. Also exposed as `product.content`. |
+| `vendor` | string |  |
+| `type` | string | The product type, e.g. `"Shirts"`. |
+| `tags` | array of string |  |
+| `options` | array of [Option](#option) | Option names, e.g. `["Size", "Color"]`. At most three. Omit for a product with a single default variant. |
+| `variants` | array of [Variant](#variant) | The variants. Each must give one value per option. |
+| `price` | [Money](#money) | Price of the variants that do not set their own, and of the default variant. |
+| `compare_at_price` | [Money](#money) | Compare-at price of the variants that do not set their own. |
+| `images` | array of [Image](#image) | Shorthand for image-only media. Use `media` for videos and 3D models. |
+| `media` | array of [Media](#media) | Images, videos and models in display order. When set, `images` must be empty. |
+| `available` | boolean | Shorthand to set availability on every variant that does not say otherwise. |
+| `collections` | array of string | Handles of the collections this product belongs to, in addition to the collections that list it in their own `products`. |
+| `template_suffix` | string | Selects `templates/product.<suffix>.json` instead of `templates/product.json`. |
+| `gift_card` | boolean | Whether the product is a gift card (`product.gift_card?`). |
+| `created_at` | string |  |
+| `published_at` | string |  |
+| `updated_at` | string |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+| `recommendations` | array of string | Handles of the products returned by product recommendations for this product. Defaults to other products from the same collections. |
+| `selling_plan_groups` | array of string | Names of the selling plan groups (from `selling_plan_groups`) this product is sold with, in addition to the groups that list it in their own `products`. |
+| `requires_selling_plan` | boolean | Whether the product can only be bought with a selling plan, like a product sold by subscription only. Defaults to `false`. |
+| `status` | [ProductStatus](#productstatus) | `active`, `draft` or `archived`. Defaults to `active`. Only an active product that is published is on the storefront: a draft, an archived product or one that is not published has no page, is in no collection, and cannot be bought, but the Admin API lists it. What names it (a collection, a menu, an order of the data) leaves it out without an error. |
+| `published` | boolean | Whether the product is published on the Online Store. Defaults to `true`. |
+
+## Option
+
+A product option. Write just the name (`"Size"`); the values are collected from the variants.
+
+One of:
+
+- string
+- [OptionDetail](#optiondetail)
+
+## OptionDetail
+
+A product option with its values in a chosen order.
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | string | **Required.** |
+| `values` | array of [OptionValue](#optionvalue) | The values in display order. Defaults to the order they appear in the variants. A value is its name (`"White"`), or its name with a swatch (`{"name": "White", "swatch": "#ffffff"}`). |
+
+## OptionValue
+
+A value of a product option: its name, or its name with a swatch.
+
+One of:
+
+- string
+- [OptionValueDetail](#optionvaluedetail)
+
+## OptionValueDetail
+
+A value of a product option with its swatch (`product_option_value.swatch`).
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | string | **Required.** |
+| `swatch` | [Swatch](#swatch) | The swatch of the value on this product. Defaults to the swatch the store's `swatches` give to this name. |
+
+## Swatch
+
+How an option value is shown instead of its name: a CSS color (`"#f4f1ea"`), or an object
+with a color, an image, or both.
+
+One of:
+
+- string
+- [SwatchDetail](#swatchdetail)
+
+## SwatchDetail
+
+A swatch with a color, an image, or both (`swatch.color`, `swatch.image`).
+
+| Field | Type | Description |
+|---|---|---|
+| `color` | string | A CSS color: `"#f4f1ea"`, `"rgb(244, 241, 234)"`, ... |
+| `image` | [Image](#image) | An image, for a pattern that a single color cannot show. |
+
+## Variant
+
+A product variant.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer | Generated from the product handle and the variant's position when omitted. |
+| `title` | string | Defaults to the option values joined with ` / ` (`"Small / Blue"`). |
+| `options` | array of string | One value per product option, in the order of the product's `options`. |
+| `price` | [Money](#money) | Defaults to the product's `price`. |
+| `compare_at_price` | [Money](#money) | The price before a sale. Must be higher than `price` to show as a discount. |
+| `sku` | string | Also a convenient way to reference the variant from carts and orders. |
+| `barcode` | string |  |
+| `available` | boolean | Whether the variant can be bought. Derived from the inventory fields when omitted. `false` alone makes the variant tracked and out of stock, as a sold-out variant is on Shopify. |
+| `inventory_quantity` | integer | Units in stock. Setting it turns inventory tracking on. |
+| `inventory_tracked` | boolean | Set to `false` to disable inventory tracking (the variant is then always available). Defaults to `true` when `inventory_quantity` is set or `available` is `false`, `false` otherwise. |
+| `inventory_policy` | [InventoryPolicy](#inventorypolicy) | Defaults to `"deny"`. |
+| `weight` | integer | Weight in grams. |
+| `weight_unit` | string | The unit the weight is displayed in: `g`, `kg`, `oz` or `lb`. Defaults to `kg`. |
+| `requires_shipping` | boolean | Defaults to `true`. |
+| `taxable` | boolean | Defaults to `true`. |
+| `image` | string | The `src` of the product image that shows this variant. |
+| `unit_price` | [Money](#money) |  |
+| `unit_price_measurement` | [UnitPriceMeasurement](#unitpricemeasurement) |  |
+| `quantity_rule` | [QuantityRule](#quantityrule) |  |
+| `quantity_price_breaks` | array of [QuantityPriceBreak](#quantitypricebreak) |  |
+| `store_availabilities` | map of boolean | The locations (from `locations`, by name) that stock this variant, and whether it is in stock there: `{"Portland": true, "Seattle": false}`. When omitted, every location stocks the variant, and it is in stock there when the variant is available. |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Money
+
+An amount of money: an integer number of cents (`1999`, the unit Liquid uses) or a decimal string in the shop currency (`"19.99"`). Floats such as `19.99` are rejected because they are ambiguous.
+
+One of:
+
+- integer: Cents, e.g. 1999 for 19.99.
+- string: Decimal amount, e.g. "19.99" or "20".
+
+## InventoryPolicy
+
+What happens when a tracked variant is out of stock.
+
+One of:
+
+- `"deny"`: Stop selling when the stock reaches zero.
+- `"continue"`: Keep selling when out of stock.
+
+## UnitPriceMeasurement
+
+What a unit price refers to, e.g. 250 g priced per 100 g.
+
+| Field | Type | Description |
+|---|---|---|
+| `measured_type` | string | `weight`, `volume`, `length` or `area`. |
+| `quantity_value` | number | **Required.** |
+| `quantity_unit` | string | **Required.** E.g. `g`, `kg`, `ml`, `l`, `m`. |
+| `reference_value` | number |  |
+| `reference_unit` | string |  |
+
+## QuantityRule
+
+The quantities a variant can be bought in (`variant.quantity_rule`).
+
+| Field | Type | Description |
+|---|---|---|
+| `min` | integer | Minimum quantity. Defaults to 1. |
+| `max` | integer | Maximum quantity. No maximum when omitted. |
+| `increment` | integer | Quantities must be a multiple of this. Defaults to 1. |
+
+## QuantityPriceBreak
+
+A volume price: the unit price from a given quantity.
+
+| Field | Type | Description |
+|---|---|---|
+| `minimum_quantity` | integer | **Required.** |
+| `price` | [Money](#money) | **Required.** |
+
+## Media
+
+A piece of product media. Images can be written as a plain string.
+
+One of:
+
+- [Image](#image)
+- [MediaDetail](#mediadetail)
+
+## MediaDetail
+
+A video, an external (YouTube/Vimeo) video or a 3D model.
+
+| Field | Type | Description |
+|---|---|---|
+| `media_type` | [MediaType](#mediatype) | **Required.** |
+| `id` | integer |  |
+| `alt` | string |  |
+| `preview_image` | [Image](#image) | The image shown before the media plays. |
+| `sources` | array of [MediaSource](#mediasource) | `video` and `model`: the files, by decreasing preference. |
+| `duration` | integer | `video`: length in milliseconds. |
+| `host` | [VideoHost](#videohost) | `external_video`: `youtube` or `vimeo`. |
+| `external_id` | string | `external_video`: the id of the video on the host, e.g. `dQw4w9WgXcQ`. |
+| `aspect_ratio` | number | Width divided by height. Defaults to the preview image's ratio, or 16:9. |
+
+## MediaType
+
+The kind of a piece of media that is not an image.
+
+One of: `"video"`, `"external_video"`, `"model"`.
+
+## MediaSource
+
+One file of a video or 3D model.
+
+| Field | Type | Description |
+|---|---|---|
+| `url` | string | **Required.** Path inside `files/` or an absolute URL. |
+| `mime_type` | string | E.g. `video/mp4`, `model/gltf-binary`. |
+| `format` | string | E.g. `mp4`, `m3u8`, `glb`, `usdz`. |
+| `width` | integer |  |
+| `height` | integer |  |
+
+## VideoHost
+
+Where an external video is hosted.
+
+One of: `"youtube"`, `"vimeo"`.
+
+## ProductStatus
+
+Where a product is in its life, as the Shopify admin shows it.
+
+One of:
+
+- `"active"`: For sale.
+- `"draft"`: Being prepared: not on the storefront yet.
+- `"archived"`: No longer sold: not on the storefront.
+
+## Collection
+
+A collection of products.
+
+A collection named `all` containing every product always exists; define it yourself only
+to change its title or order.
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/collection.schema.json"`. |
+| `id` | integer |  |
+| `title` | string | **Required.** |
+| `handle` | string |  |
+| `description` | string | HTML description. |
+| `image` | [Image](#image) |  |
+| `products` | array of string | Handles of the products in the collection, in manual order. |
+| `rules` | array of [CollectionRule](#collectionrule) | Makes the collection automated: products matching the rules are added after the ones listed in `products`. |
+| `disjunctive` | boolean | With several rules: `true` to match any of them, `false` (default) to match all. |
+| `sort_order` | [SortOrder](#sortorder) | The default order of the products. Defaults to `manual`. |
+| `template_suffix` | string | Selects `templates/collection.<suffix>.json`. |
+| `published_at` | string |  |
+| `updated_at` | string |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## CollectionRule
+
+A rule of an automated collection: products matching it are included.
+
+| Field | Type | Description |
+|---|---|---|
+| `column` | [RuleColumn](#rulecolumn) | **Required.** What to look at: `tag`, `type`, `vendor`, `title`, `price` (cents) or `compare_at_price` (cents). |
+| `relation` | [RuleRelation](#rulerelation) | Defaults to `equals`. |
+| `condition` | string | **Required.** The value compared with, e.g. `"sale"` for a tag or `"5000"` for a price in cents. |
+
+## RuleColumn
+
+The product property an automated collection rule looks at.
+
+One of: `"tag"`, `"type"`, `"vendor"`, `"title"`, `"price"`, `"compare_at_price"`.
+
+## RuleRelation
+
+How an automated collection rule compares the property to its condition.
+
+One of: `"equals"`, `"not_equals"`, `"contains"`, `"not_contains"`, `"starts_with"`, `"ends_with"`, `"greater_than"`, `"less_than"`.
+
+## SortOrder
+
+How a collection orders its products by default.
+
+One of: `"manual"`, `"best-selling"`, `"title-ascending"`, `"title-descending"`, `"price-ascending"`, `"price-descending"`, `"created-ascending"`, `"created-descending"`.
+
+## Page
+
+A page (`/pages/<handle>`).
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/page.schema.json"`. |
+| `id` | integer |  |
+| `title` | string | **Required.** |
+| `handle` | string |  |
+| `content` | string | HTML content. |
+| `author` | string |  |
+| `template_suffix` | string | Selects `templates/page.<suffix>.json`, e.g. `"contact"`. |
+| `published_at` | string |  |
+| `updated_at` | string |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Blog
+
+A blog (`/blogs/<handle>`) and its articles.
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/blog.schema.json"`. |
+| `id` | integer |  |
+| `title` | string | **Required.** |
+| `handle` | string |  |
+| `articles` | array of [Article](#article) | Articles, newest first unless they carry `published_at` dates. |
+| `comments_enabled` | boolean | Whether readers can comment. Defaults to `false`. |
+| `moderated` | boolean | Whether comments wait for approval. Defaults to `false`. |
+| `template_suffix` | string |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Article
+
+A blog post.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `title` | string | **Required.** |
+| `handle` | string |  |
+| `author` | string |  |
+| `content` | string | HTML content. |
+| `excerpt` | string | HTML excerpt. `article.excerpt_or_content` falls back to the content. |
+| `image` | [Image](#image) |  |
+| `tags` | array of string |  |
+| `comments` | array of [Comment](#comment) |  |
+| `template_suffix` | string |  |
+| `created_at` | string |  |
+| `published_at` | string |  |
+| `updated_at` | string |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Comment
+
+A comment on an article.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `author` | string | **Required.** |
+| `email` | string |  |
+| `content` | string | **Required.** HTML content. |
+| `created_at` | string |  |
+
+## Menu
+
+A navigation menu (`linklists.<handle>`).
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/menu.schema.json"`. |
+| `title` | string | Defaults to the handle, title-cased. |
+| `links` | array of [Link](#link) |  |
+
+## Link
+
+A link in a navigation menu.
+
+Point it at a resource with exactly one of `url`, `collection`, `product`, `page`, `blog`,
+`article` or `policy`; the URL and the link type follow from it. A link with none of them
+points to `#`.
+
+| Field | Type | Description |
+|---|---|---|
+| `title` | string | **Required.** |
+| `url` | string | A literal URL: `/`, `/collections/all`, `/search`, `https://example.com`. |
+| `collection` | string | Handle of a collection. |
+| `product` | string | Handle of a product. |
+| `page` | string | Handle of a page. |
+| `blog` | string | Handle of a blog. |
+| `article` | string | An article as `<blog-handle>/<article-handle>`. |
+| `policy` | string | A policy: `privacy-policy`, `refund-policy`, `shipping-policy`, `terms-of-service`. |
+| `links` | array of [Link](#link) | Nested links (up to three levels, like the Shopify admin). |
+
+## Customer
+
+A customer. Sessions log in as a customer by email (see `session.customer`), and the checkout
+of an app lists the customers as login profiles: "Log in" logs the checkout in as one of them,
+with their addresses (the first is the default) and, for a B2B customer, their locations.
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/customer.schema.json"`. |
+| `id` | integer |  |
+| `email` | string | **Required.** |
+| `first_name` | string |  |
+| `last_name` | string |  |
+| `phone` | string |  |
+| `tags` | array of string |  |
+| `accepts_marketing` | boolean |  |
+| `has_account` | boolean | Defaults to `true`. |
+| `tax_exempt` | boolean |  |
+| `addresses` | array of [Address](#address) | The first address is the default one (`customer.default_address`). |
+| `orders` | array of [Order](#order) |  |
+| `company` | string | The name of a company in `companies`: the customer buys for it (B2B). |
+| `company_locations` | array of string | The names of the locations of the company the customer can buy for. Defaults to all of them. |
+| `company_contact` | [CompanyContact](#companycontact) | What the company knows of the customer as a buyer: their job title, language, dates. Checkout Functions read it as `purchasingCompany.contact`. |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Order
+
+An order of a customer, shown on account pages.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `name` | string | The order name, e.g. `"#1001"`. Generated when omitted. |
+| `created_at` | string |  |
+| `financial_status` | string | `paid`, `pending`, `refunded`, ... Defaults to `paid`. |
+| `fulfillment_status` | string | `fulfilled`, `unfulfilled`, `partial`. Defaults to `unfulfilled`. |
+| `line_items` | array of [OrderLine](#orderline) |  |
+| `shipping_address` | [Address](#address) |  |
+| `billing_address` | [Address](#address) |  |
+| `shipping_price` | [Money](#money) |  |
+| `tax_price` | [Money](#money) |  |
+| `cancelled` | boolean |  |
+| `note` | string |  |
+| `returns` | array of [OrderReturn](#orderreturn) | What the customer sent back, as the customer account shows it. |
+
+## OrderLine
+
+A line of an order.
+
+| Field | Type | Description |
+|---|---|---|
+| `variant` | [VariantRef](#variantref) | **Required.** A variant, by id or SKU, or a product handle (its first variant is used). |
+| `quantity` | integer | Defaults to 1. |
+
+## VariantRef
+
+A reference to a variant: its numeric id, its SKU, or a product handle (meaning that
+product's first variant).
+
+One of:
+
+- integer
+- string
+
+## OrderReturn
+
+A return of an order.
+
+| Field | Type | Description |
+|---|---|---|
+| `status` | string | `requested`, `open` or `closed`. Defaults to `open`. |
+| `line_items` | array of [OrderLine](#orderline) | The lines sent back, by their variant, and how many of each. Defaults to every line of the order. |
+
+## CompanyContact
+
+A customer as a contact of their company (B2B): `purchasingCompany.contact` of a checkout
+Function.
+
+| Field | Type | Description |
+|---|---|---|
+| `title` | string | The job title of the contact, e.g. `"Purchasing manager"`. |
+| `locale` | string | The language of the contact, e.g. `"fr"`. None when absent. |
+| `created_at` | string | Defaults to the creation date of the company. |
+| `updated_at` | string | Defaults to `created_at`. |
+
+## Company
+
+A company that buys from the store (B2B). A customer whose `company` names it is a B2B
+customer: `customer.b2b?` is true, and `customer.current_company` is this company.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `name` | string | **Required.** The name customers refer to the company by. |
+| `external_id` | string | The id the merchant gives the company in its own systems. |
+| `locations` | array of [CompanyLocation](#companylocation) | The places the company buys for. The first one is selected when a customer logs in. |
+| `created_at` | string | Defaults to a fixed date, 2024-01-01 plus one day per company. |
+| `updated_at` | string | Defaults to `created_at`. |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## CompanyLocation
+
+A place a company buys for (`customer.current_location`): a branch, a shop, a warehouse.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `name` | string | **Required.** |
+| `external_id` | string | The id the merchant gives the location in its own systems. |
+| `shipping_address` | [Address](#address) | Where orders of this location ship to. |
+| `tax_registration_id` | string | The tax number of the location, e.g. a VAT number. |
+| `locale` | string | The preferred language of the location, e.g. `"fr"`. None when absent. |
+| `created_at` | string | Defaults to the creation date of the company. |
+| `updated_at` | string | Defaults to `created_at`. |
+| `orders_count` | integer | The number of orders placed at the location, which checkout Functions read as `ordersCount`. The orders of the customers are not counted: defaults to 0. |
+| `total_spent` | [Money](#money) | The amount spent at the location (`totalSpent`), e.g. `"1250.00"`. Defaults to 0. |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## GiftCard
+
+An issued gift card, shown by `templates/gift_card.liquid` at the URL the `routes` command lists
+(`/gift_cards/<shop id>/<token>`).
+
+| Field | Type | Description |
+|---|---|---|
+| `code` | string | **Required.** The code customers redeem at checkout, e.g. `"WCGX7X97G74JGDGC"`. |
+| `initial_value` | [Money](#money) | **Required.** The value the card was issued with. |
+| `balance` | [Money](#money) | What is left on the card. Defaults to `initial_value`. |
+| `currency` | string | ISO 4217 code. Defaults to the shop's currency. |
+| `expires_on` | string | The day the card stops working, e.g. `"2026-12-31"`. A date before `now` makes the card `expired`. |
+| `enabled` | boolean | `false` for a card the merchant disabled. |
+| `customer` | string | The email of the customer (from `customers`) the card belongs to. |
+| `message` | string |  |
+| `recipient` | [GiftCardRecipient](#giftcardrecipient) |  |
+| `send_on` | string | When the card is scheduled to be sent to its recipient. |
+| `product` | string | The handle of the gift card product that was bought. |
+| `properties` | map of string | Line item properties of the purchase. |
+| `template_suffix` | string | Selects `templates/gift_card.<suffix>.liquid`. |
+
+## GiftCardRecipient
+
+Who a gift card was sent to.
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | string |  |
+| `email` | string |  |
+| `nickname` | string |  |
+
+## Metaobject
+
+A metaobject entry (`metaobjects.<type>.<handle>`).
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | **Required.** |
+| `fields` | map of [Metafield](#metafield) | Field values, with the same shorthand as metafields. |
+| `template_suffix` | string | Selects `templates/metaobject/<type>.<suffix>.json` instead of `templates/metaobject/<type>.json` for the page of the entry, which is `/pages/<type>/<handle>`. |
+
+## Localization
+
+The countries and languages the store sells in (the `localization` object).
+
+The first language is the primary one and is served at `/`; the others are served under
+`/<iso_code>/`. Defaults to one country, the shop's (`shop.address.country_code`, else `US`),
+and the theme's default language.
+
+| Field | Type | Description |
+|---|---|---|
+| `countries` | array of [Country](#country) |  |
+| `languages` | array of [Language](#language) |  |
+| `markets` | array of [Market](#market) | Groups of countries sold as one market. A country in none of them is a market of its own, named after the country. |
+
+## Country
+
+A country the store sells to.
+
+| Field | Type | Description |
+|---|---|---|
+| `iso_code` | string | **Required.** ISO 3166-1 alpha-2 code, e.g. `"FR"`. |
+| `name` | string | Defaults to the English name of the country. |
+| `currency` | string | ISO 4217 currency code. Defaults to the store currency. |
+| `unit_system` | string | `metric` or `imperial`. Defaults to `metric`. |
+| `popular` | boolean | Whether to list the country among the popular ones. |
+
+## Language
+
+A language the store is published in.
+
+| Field | Type | Description |
+|---|---|---|
+| `iso_code` | string | **Required.** Locale code, e.g. `"en"`, `"fr"`, `"pt-BR"`. |
+| `name` | string | The language's name in English. Defaults to a built-in name. |
+| `endonym_name` | string | The language's name in that language. Defaults to a built-in name. |
+
+## Market
+
+A market: the countries the store sells to as one, as checkout Functions see it in
+`localization.market` and `MailingAddress.market`.
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | **Required.** What Functions call the market: `"europe"`. |
+| `countries` | array of string | **Required.** The ISO 3166-1 alpha-2 codes of its countries, which are in `localization.countries`. |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## Location
+
+A place the store stocks products at, where customers can pick up their orders
+(`variant.store_availabilities`, `store_availability.location`).
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer |  |
+| `name` | string | **Required.** The name of the location. Variants refer to it by this name. |
+| `address` | [Address](#address) |  |
+| `pick_up_enabled` | boolean | Whether orders can be picked up at the location. Defaults to `true`. |
+| `pick_up_time` | string | How long a pickup order takes to be ready. Defaults to `"Usually ready in 24 hours"`. |
+| `physical_storefront` | boolean | Whether the location is a shop that sells in person. Defaults to `true`. |
+| `latitude` | number |  |
+| `longitude` | number |  |
+| `metafields` | map of map of [Metafield](#metafield) |  |
+
+## SellingPlanGroup
+
+A group of selling plans (`product.selling_plan_groups`): what a subscription app creates
+for "Subscribe and save". Products are sold with a group when the group lists them in
+`products`, or when they name the group in their own `selling_plan_groups`.
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | string | **Required.** The name shown to customers, e.g. `"Subscribe and save"`. Products refer to the group by this name. |
+| `app_id` | string | The id of the app that created the group (`selling_plan_group.app_id`). |
+| `options` | array of string | The names of the options the plans differ by. Defaults to one option, `"Delivery frequency"`. |
+| `selling_plans` | array of [SellingPlan](#sellingplan) | **Required.** The plans of the group. At least one. |
+| `products` | array of string | Handles of the products sold with these plans. |
+
+## SellingPlan
+
+A selling plan: one way of buying a product, such as "Deliver every month, 10% off".
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer | Generated from the names of the group and of the plan when omitted. |
+| `name` | string | **Required.** The name shown to customers, e.g. `"Deliver every month, 10% off"`. |
+| `description` | string |  |
+| `options` | array of string | One value per option of the group, e.g. `["Every month"]`. Defaults to the plan's name. |
+| `price_adjustments` | array of [PriceAdjustment](#priceadjustment) | How the plan changes the price: at most two adjustments, the first one applies to the first orders. No adjustment means the price of the variant. |
+| `recurring_deliveries` | boolean | Whether the plan delivers more than once. Defaults to `true`. |
+| `checkout_charge` | [CheckoutCharge](#checkoutcharge) | What is paid at checkout. Defaults to the whole price (`percentage`, `100`). |
+
+## PriceAdjustment
+
+A price adjustment of a selling plan (`selling_plan.price_adjustments`).
+
+| Field | Type | Description |
+|---|---|---|
+| `value_type` | [AdjustmentType](#adjustmenttype) | **Required.** |
+| `value` | [Money](#money) | **Required.** With `percentage`: the percentage, e.g. `10`. With `fixed_amount` and `price`: an amount of money, e.g. `"2.00"` or `200`. |
+| `order_count` | integer | The number of orders the adjustment applies to. Every order when omitted. |
+
+## AdjustmentType
+
+How a price adjustment of a selling plan changes the price.
+
+One of:
+
+- `"percentage"`: `value` percent off the price of the variant.
+- `"fixed_amount"`: `value` (an amount of money) off the price of the variant.
+- `"price"`: `value` (an amount of money) is the price.
+
+## CheckoutCharge
+
+What is paid at checkout, for plans that take a deposit (`selling_plan.checkout_charge`).
+
+| Field | Type | Description |
+|---|---|---|
+| `value_type` | [CheckoutChargeType](#checkoutchargetype) | **Required.** |
+| `value` | [Money](#money) | **Required.** With `percentage`: the percentage, e.g. `50`. With `price`: an amount of money. |
+
+## CheckoutChargeType
+
+How the amount due at checkout is expressed.
+
+One of:
+
+- `"percentage"`: `value` percent of the price.
+- `"price"`: `value` (an amount of money).
+
+## File
+
+A file in `files/` that needs metadata. Files without an entry work too.
+
+| Field | Type | Description |
+|---|---|---|
+| `alt` | string |  |
+| `width` | integer | Size to assume when the file itself is absent (a placeholder is generated). |
+| `height` | integer |  |
+| `focal_point` | [FocalPoint](#focalpoint) |  |
+
+## Session
+
+The state a browser session starts with. Tests can replace it per session through the
+control API (`PUT /__lsf/session`).
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/session.schema.json"`. |
+| `customer` | string | Who is logged in: the email of a customer, `"default"` for the first customer of the data, or `"none"`. Nobody is logged in when omitted. |
+| `cart` | [Cart](#cart) | The content of the cart. Empty when omitted. |
+| `country` | string | ISO code of the selected country. When omitted, the visitor is in the shop's country (`shop.address.country_code`), the one of its primary market: the storefront shows it, and the checkout, until an address is entered, is in it (its Functions, its UI extensions and its address form read it). A shop in a country the store does not sell to uses the first country. |
+| `company_location` | string | For a B2B customer: the name of the company location they buy for. Defaults to the first one they have access to. |
+
+## Cart
+
+The cart a session starts with.
+
+| Field | Type | Description |
+|---|---|---|
+| `items` | array of [CartLine](#cartline) |  |
+| `note` | string |  |
+| `attributes` | map of string | Cart attributes. |
+
+## CartLine
+
+A line of the cart a session starts with.
+
+| Field | Type | Description |
+|---|---|---|
+| `variant` | [VariantRef](#variantref) | **Required.** A variant, by id or SKU, or a product handle (its first variant is used). |
+| `quantity` | integer | Defaults to 1. |
+| `properties` | map of string | Line item properties, e.g. `{"Engraving": "Hello"}`. |
+| `selling_plan` | [SellingPlanRef](#sellingplanref) | The selling plan the line is bought with: its name or its id. The product of the variant must be sold with it. |
+
+## SellingPlanRef
+
+A reference to a selling plan: its numeric id, or its name.
+
+One of:
+
+- integer
+- string
+
+## Checkout
+
+How the local checkout (`lsf app dev --app`) is set up. Every field has a default.
+
+| Field | Type | Description |
+|---|---|---|
+| `shipping_rates` | array of [CheckoutShippingRate](#checkoutshippingrate) | The delivery options offered to every address. Defaults to one, "Standard" at 5.00. |
+| `payment_methods` | array of [CheckoutPaymentMethod](#checkoutpaymentmethod) | The payment methods. Defaults to "Credit card", "Cash on Delivery" and "Bank Deposit". |
+| `discounts` | array of [CheckoutDiscount](#checkoutdiscount) | Discounts backed by discount Functions of the app. |
+| `functions` | map of [CheckoutFunction](#checkoutfunction) | The settings of the other Functions, by the handle of the Function. |
+| `extensions` | map of [CheckoutExtension](#checkoutextension) | What the merchant filled in for the UI extensions of the app, by the handle of the extension: the values its `shopify.settings` (`useSettings`) reads. |
+| `tax_rate` | number | Tax in percent, added on top of the discounted subtotal: `20` for 20 %. No tax when omitted. |
+
+## CheckoutShippingRate
+
+A delivery option the local checkout offers to every address.
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | **Required.** What Functions and the page call the option: `"standard"`. |
+| `title` | string | What the buyer sees. Defaults to the handle. |
+| `price` | [Money](#money) | **Required.** The cost, e.g. `"4.90"`. |
+| `description` | string |  |
+| `kind` | [CheckoutDeliveryKind](#checkoutdeliverykind) | Defaults to `"shipping"`. |
+
+## CheckoutDeliveryKind
+
+What kind of delivery a shipping rate is.
+
+One of:
+
+- `"shipping"`: Delivered to the address.
+- `"pick_up"`: Picked up in a store.
+- `"local"`: Delivered locally.
+
+## CheckoutPaymentMethod
+
+A payment method the local checkout offers.
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | **Required.** What payment customization Functions and the page call the method: `"card"`. |
+| `name` | string | What the buyer sees. Defaults to the handle. |
+| `placements` | array of [CheckoutPaymentPlacement](#checkoutpaymentplacement) | Where the method is offered, which payment customization Functions read as `placements`. Defaults to `["PAYMENT_METHOD"]`: the list of the checkout. |
+
+## CheckoutPaymentPlacement
+
+Where a payment method is offered.
+
+One of:
+
+- `"PAYMENT_METHOD"`: The list of payment methods of the checkout.
+- `"ACCELERATED_CHECKOUT"`: The express buttons (Shop Pay, Apple Pay, ...).
+
+## CheckoutDiscount
+
+A discount backed by a discount Function of the app.
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | integer | The number of the discount's id, which its Function reads (`gid://shopify/DiscountAutomaticNode/<id>`, or `DiscountCodeNode` with a code) and the Admin API gives it. Defaults to its position in the list, from 1. |
+| `function` | string | **Required.** The handle of the discount Function in the app. |
+| `title` | string | What the buyer sees. Defaults to the handle of the Function. |
+| `code` | string | The code that triggers the discount. Without one the discount is automatic. |
+| `classes` | array of [CheckoutDiscountClass](#checkoutdiscountclass) | What the discount may reduce. All three when omitted. |
+| `metafields` | [OwnerMetafields](#ownermetafields) | The metafields of the discount, which its Function's input query reads, by `"namespace.key"`: `{"$app.function-configuration": {"type": "json", "value": {"percentage": 10}}}` for `metafield(namespace: "$app", key: "function-configuration")`. Shopify's list of `{namespace, key, type, value}` is taken too. |
+
+## CheckoutDiscountClass
+
+What a discount may reduce.
+
+One of: `"PRODUCT"`, `"ORDER"`, `"SHIPPING"`.
+
+## OwnerMetafields
+
+The metafields of a discount or of the owner of a Function: by `"namespace.key"`, or as
+Shopify's Admin API takes them (`metafieldsSet`, `discountAutomaticAppCreate`), a list of
+`{namespace, key, type, value}`.
+
+One of:
+
+- map of [Metafield](#metafield): `{"$app.function-configuration": {"type": "json", "value": {…}}}`.
+- array of [OwnerMetafield](#ownermetafield): `[{"namespace": "$app", "key": "function-configuration", "type": "json", "value": {…}}]`.
+
+## OwnerMetafield
+
+A metafield as Shopify's Admin API takes it.
+
+| Field | Type | Description |
+|---|---|---|
+| `namespace` | string | **Required.** `$app`, `$app:<name>`, or another namespace. |
+| `key` | string | **Required.** |
+| `type` | string | The metafield type: `json`, `single_line_text_field`, … Inferred from the value when omitted. |
+| `value` | any JSON value | **Required.** The value: JSON, or the text Shopify stores (`"{\"percentage\":10}"` for `json`). |
+
+## CheckoutFunction
+
+A Function that is not a discount (cart transform, delivery or payment customization,
+validation): its owner in the shop, and its settings.
+
+| Field | Type | Description |
+|---|---|---|
+| `enabled` | boolean | Whether the shop has an owner of the Function (the payment or delivery customization, validation or cart transform an app creates for it), and it is enabled. As on Shopify, the Function runs at the checkout only through an enabled owner: `true` runs it, `false` is an owner that is turned off. Without it, the shop has no owner of it, as after an install: the Function runs only for a scenario that names it in `extensions`, or for `app function run <handle>`, with these metafields. |
+| `metafields` | [OwnerMetafields](#ownermetafields) | The metafields of the object the Function belongs to, by `"namespace.key"`: `{"$app.function-configuration": {"type": "json", "value": {…}}}` for `metafield(namespace: "$app", key: "function-configuration")`. Shopify's list of `{namespace, key, type, value}` is taken too. |
+
+## CheckoutExtension
+
+A checkout or customer account UI extension of the app, as the merchant set it up.
+
+| Field | Type | Description |
+|---|---|---|
+| `settings` | map of any JSON value | The values of the fields of its `[extensions.settings]`, by `key`, as the merchant fills them in the checkout editor: `{"title": "Free gift", "threshold": 50, "show": true}`. A field left out has no value (`undefined`), as on Shopify. |
+
+## AppInstallation
+
+The app of `--app` as the store has it installed, for its theme app extensions: its
+app-data metafields and the app embed blocks turned on.
+
+| Field | Type | Description |
+|---|---|---|
+| `metafields` | map of map of [Metafield](#metafield) | The app-data metafields of the installation, by namespace then key: `{"conditions": {"reviews_enabled": true}}`. The Liquid of the app's blocks reads them as `app.metafields.conditions.reviews_enabled`, and an `available_if` of a block tests them. |
+| `embeds` | map of [AppEmbed](#appembed) | App embed blocks turned on or off, by the name of their file in the extension's `blocks/` (`"chat-bubble"` for `blocks/chat-bubble.liquid`): `true` turns one on, with the settings `config/settings_data.json` gives it or else its defaults; `false` turns it off; `{"settings": {...}}` turns it on with these settings. The embeds of `config/settings_data.json` that this does not name stay as the theme has them. |
+
+## AppEmbed
+
+An app embed block turned on (`true`) or off (`false`), or turned on with its settings.
+
+One of:
+
+- boolean
+- [AppEmbedSettings](#appembedsettings)
+
+## AppEmbedSettings
+
+An app embed block turned on with settings of its own.
+
+| Field | Type | Description |
+|---|---|---|
+| `settings` | map of any JSON value | The values of the settings of the block's schema, by setting id. The others have their defaults. |
+
+## Checkout scenario
+
+A named setup of the local checkout: a file of `checkouts/`. It sets what a checkout
+depends on on top of the store data, and what it does not set stays as the store data says.
+
+| Field | Type | Description |
+|---|---|---|
+| `$schema` | string | Lets editors validate and autocomplete the file, e.g. `"../schema/checkout-scenario.schema.json"`. |
+| `title` | string | The name shown on the home page. Defaults to the name of the file. |
+| `description` | string | What the scenario is for and what to look at, shown on the home page. |
+| `session` | [Session](#session) | Who buys and what is in the cart, written as the `session` of the store data and applied on top of it: `customer`, `cart` (lines, quantities, selling plans, note, attributes), `country`, `company_location`. |
+| `entered` | [ScenarioEntered](#scenarioentered) | What the buyer already entered: email, address, discount codes, delivery and payment. |
+| `language` | string | The language of the buyer, by ISO code (`"fr"`): one of `localization.languages`. The checkout opens under its locale root. Defaults to the primary language. |
+| `checkout` | [Checkout](#checkout) | Overrides of the `checkout` section of the store data: every field that is present replaces the one of the store (`shipping_rates`, `payment_methods`, `discounts`, `tax_rate`), except `functions` and `extensions`, which replace the settings of the Functions and extensions they name. |
+| `variant` | [ScenarioLook](#scenariolook) | The look of the page. Defaults to the one of the server (`--variant`). |
+| `extensions` | array of string | The handles of the extensions (Functions and checkout UI extensions) that run, among those of the app that `--extension` allows. When omitted, every UI extension shows and the Functions run as at the shop's checkout: a payment or delivery customization, validation or cart transform Function only through an enabled owner of it. |
+| `expect` | [ScenarioExpect](#scenarioexpect) | What the checkout must look like once the Functions ran: `lsf app check` fails when it does not, and says what it expected and what it got. Without it, `app check` only checks that the Functions run without an error. |
+
+## ScenarioEntered
+
+What the buyer already typed and chose when a scenario opens.
+
+| Field | Type | Description |
+|---|---|---|
+| `email` | string | The contact email. A logged-in customer has theirs already. |
+| `phone` | string |  |
+| `shipping_address` | [ScenarioAddress](#scenarioaddress) | The delivery address. Its country is the country of the checkout. |
+| `delivery` | string | The handle of the shipping rate chosen (`checkout.shipping_rates`). The first one available is chosen when omitted. |
+| `payment` | string | The handle of the payment method chosen (`checkout.payment_methods`). |
+| `discount_codes` | array of string | The discount codes entered, in order. A code that no discount of `checkout.discounts` has is entered all the same, and refused as on Shopify. |
+
+## ScenarioAddress
+
+A postal address the buyer already entered.
+
+| Field | Type | Description |
+|---|---|---|
+| `first_name` | string |  |
+| `last_name` | string |  |
+| `company` | string |  |
+| `address1` | string |  |
+| `address2` | string |  |
+| `city` | string |  |
+| `country_code` | string | ISO 3166-1 alpha-2 code of one of the store's countries: `"US"`. |
+| `province_code` | string |  |
+| `zip` | string |  |
+| `phone` | string |  |
+
+## ScenarioLook
+
+The look of the checkout page.
+
+One of:
+
+- `"standard"`: Shopify's one-page checkout.
+- `"shop"`: The look of the Shop app and Shop Pay.
+
+## ScenarioExpect
+
+What the checkout of a scenario must look like once its Functions ran, which
+`lsf app check` checks. Each list (`payment_methods`, `express_methods`, `delivery_options`,
+`discounts`, `lines`, `errors`) takes `includes`, `excludes` and `equals`; `totals` takes
+exact amounts:
+
+```json
+"expect": {
+  "express_methods": { "excludes": ["paypal"] },
+  "payment_methods": { "includes": ["paypal"] },
+  "totals": { "total": "120.00" }
+}
+```
+
+| Field | Type | Description |
+|---|---|---|
+| `step` | [ScenarioStep](#scenariostep) | The step of the buyer journey the Functions run for: `completion` (the default), the order being placed, as `lsf app function run` runs them; `interaction`, the page as the buyer sees it before. Only a validation Function tells them apart (`buyerJourney.step`). |
+| `payment_methods` | [ExpectedPaymentMethods](#expectedpaymentmethods) | The payment methods of the list of the checkout (`PAYMENT_METHOD`), in order, once the payment customizations ran. A string matches the handle or the name. |
+| `express_methods` | [ExpectedPaymentMethods](#expectedpaymentmethods) | The express buttons (`ACCELERATED_CHECKOUT`), in order, once the payment customizations ran. A method can be in both lists. A string matches the handle or the name. |
+| `delivery_options` | [ExpectedDeliveryOptions](#expecteddeliveryoptions) | The delivery options, in the order the buyer sees them, once the delivery customizations and the shipping discounts ran. A string matches the handle or the title. |
+| `discounts` | [ExpectedDiscounts](#expecteddiscounts) | The discounts applied, product, order and shipping ones. A string matches the title (the message the Function gave) or the code. |
+| `lines` | [ExpectedLines](#expectedlines) | The lines of the checkout once the cart transforms ran. A string matches the SKU or the title. |
+| `errors` | [ExpectedErrors](#expectederrors) | The errors that block the order: those validation Functions report, and those of Functions that failed. A string matches the message. `{"equals": []}`: no error. |
+| `totals` | [ExpectedTotals](#expectedtotals) | The amounts of the checkout, each exactly. |
+
+## ScenarioStep
+
+The step of the buyer journey the Functions run for.
+
+One of:
+
+- `"completion"`: The buyer places the order (`CHECKOUT_COMPLETION`).
+- `"interaction"`: The buyer is on the page (`CHECKOUT_INTERACTION`).
+
+## ExpectedPaymentMethods
+
+What a list of the checkout must hold. Each entry is a string, which matches an entry of the
+list by its name (see the list), or an object of the fields the entry must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `includes` | array of string or [ExpectedPaymentMethod](#expectedpaymentmethod) | Each of these matches an entry of the list, in any order. |
+| `excludes` | array of string or [ExpectedPaymentMethod](#expectedpaymentmethod) | None of these matches an entry of the list. |
+| `equals` | array of string or [ExpectedPaymentMethod](#expectedpaymentmethod) | The whole list, in order: as many entries, the first matching the first, and so on. `[]` is an empty list. |
+
+## ExpectedPaymentMethod
+
+A payment method of `expect`: the fields it must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | Its handle (`checkout.payment_methods`). |
+| `name` | string | Its name, as the buyer sees it: the one a payment customization gave it, if any. |
+
+## ExpectedDeliveryOptions
+
+What a list of the checkout must hold. Each entry is a string, which matches an entry of the
+list by its name (see the list), or an object of the fields the entry must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `includes` | array of string or [ExpectedDeliveryOption](#expecteddeliveryoption) | Each of these matches an entry of the list, in any order. |
+| `excludes` | array of string or [ExpectedDeliveryOption](#expecteddeliveryoption) | None of these matches an entry of the list. |
+| `equals` | array of string or [ExpectedDeliveryOption](#expecteddeliveryoption) | The whole list, in order: as many entries, the first matching the first, and so on. `[]` is an empty list. |
+
+## ExpectedDeliveryOption
+
+A delivery option of `expect`: the fields it must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `handle` | string | Its handle (`checkout.shipping_rates`). |
+| `title` | string | Its title, as the buyer sees it: the one a delivery customization gave it, if any. |
+| `cost` | [Money](#money) | What it costs once the shipping discounts ran. |
+
+## ExpectedDiscounts
+
+What a list of the checkout must hold. Each entry is a string, which matches an entry of the
+list by its name (see the list), or an object of the fields the entry must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `includes` | array of string or [ExpectedDiscount](#expecteddiscount) | Each of these matches an entry of the list, in any order. |
+| `excludes` | array of string or [ExpectedDiscount](#expecteddiscount) | None of these matches an entry of the list. |
+| `equals` | array of string or [ExpectedDiscount](#expecteddiscount) | The whole list, in order: as many entries, the first matching the first, and so on. `[]` is an empty list. |
+
+## ExpectedDiscount
+
+A discount of `expect`: the fields it must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `title` | string | Its title: the message the Function gave, or the title of the discount. |
+| `code` | string | The code it applied with. An automatic discount has none. |
+| `class` | [CheckoutDiscountClass](#checkoutdiscountclass) | What it reduced: `PRODUCT`, `ORDER` or `SHIPPING`. |
+| `amount` | [Money](#money) | What it took off. |
+
+## ExpectedLines
+
+What a list of the checkout must hold. Each entry is a string, which matches an entry of the
+list by its name (see the list), or an object of the fields the entry must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `includes` | array of string or [ExpectedLine](#expectedline) | Each of these matches an entry of the list, in any order. |
+| `excludes` | array of string or [ExpectedLine](#expectedline) | None of these matches an entry of the list. |
+| `equals` | array of string or [ExpectedLine](#expectedline) | The whole list, in order: as many entries, the first matching the first, and so on. `[]` is an empty list. |
+
+## ExpectedLine
+
+A line of `expect`: the fields it must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `sku` | string | The SKU of its variant. |
+| `title` | string | Its title: the product's, or the one a cart transform gave it. |
+| `quantity` | integer | How many units it has. |
+| `price` | [Money](#money) | The price of one unit, before discounts. |
+| `total` | [Money](#money) | What the line costs once its discounts ran. |
+| `components` | array of string | The lines a cart transform made it of (merge) or split it into (expand), in order, each by its SKU or title. `[]`: none. |
+| `attributes` | map of string | Attributes it must have, by key; it can have others. |
+
+## ExpectedErrors
+
+What a list of the checkout must hold. Each entry is a string, which matches an entry of the
+list by its name (see the list), or an object of the fields the entry must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `includes` | array of string or [ExpectedError](#expectederror) | Each of these matches an entry of the list, in any order. |
+| `excludes` | array of string or [ExpectedError](#expectederror) | None of these matches an entry of the list. |
+| `equals` | array of string or [ExpectedError](#expectederror) | The whole list, in order: as many entries, the first matching the first, and so on. `[]` is an empty list. |
+
+## ExpectedError
+
+An error of `expect`: the fields it must have.
+
+| Field | Type | Description |
+|---|---|---|
+| `message` | string | The message, exactly. |
+| `target` | string | The target the Function gave (`$.cart`, `$.cart.buyerIdentity.email`). |
+
+## ExpectedTotals
+
+The amounts of the checkout `expect` checks, each exactly. Those left out are not checked.
+
+| Field | Type | Description |
+|---|---|---|
+| `subtotal` | [Money](#money) | The lines before discounts. |
+| `discounts` | [Money](#money) | The product and order discounts (the shipping discounts are in `shipping`). |
+| `shipping` | [Money](#money) | The selected delivery option, once the shipping discounts ran. 0 before the address has a country. |
+| `tax` | [Money](#money) | The tax (`checkout.tax_rate`). |
+| `total` | [Money](#money) | What the order costs in all, the part paid later included. |
+| `due_now` | [Money](#money) | What the buyer pays now. |
+| `due_later` | [Money](#money) | What the selling plans leave to pay later. |