Products

Page size. Default 50, maximum 100. Values above 100 are clamped.

Opaque cursor from pagination.next_cursor. A cursor whose product no longer exists returns 400 with code invalid_cursor rather than silently restarting at page 1 - restart the list without a cursor.

Exact-match filter on the product's category.

Case-insensitive "name contains" filter. Applied after the query, so it narrows the page rather than the index - use sort/cursor normally.

ISO 8601 timestamp. Returns products whose updated_at is greater than or equal to this value. An unparseable value returns 400 with field updated_after. Supplying it forces sort=updatedAt regardless of what you pass in sort.

name or updatedAt. Default name. Directions are fixed per field: name is always ascending, updatedAt is always descending. A leading - is stripped and any other value falls back to name. Note the value is updatedAt (camelCase) even though the response field is updated_at.

Always active for anything the API returns. Other statuses 404.

SEO slug, falling back to the product id when none is set.

Plain URL strings, in author order. Storage paths and original filenames are never exposed.

true unless explicitly turned off.

The advertised "from" price: the cheapest variant price plus the unavoidable upcharge any required choice forces (its cheapest option). It is a display headline, not a line price - never send it as a price. Per-variant price is the raw base.

ISO currency code for every amount on the product, resolved from the account's settings. Not present on list items.

true only when the product has more than one variant and those variants have more than one distinct price. A multi-variant product priced identically across variants reports false.

How the product is sold: mode (each or weight), label, min, step. In each mode quantities are whole numbers with a minimum of 1. In weight mode quantities are fractional in units of label (for example kg), clamped to min and stepped by step, and the variant price is the price per unit of label - the line total is price x quantity.

id, name, price, servings. id is what you send as the variant/size on an order line. price is the raw base for that variant and excludes every choice and custom-field upcharge. servings defaults to 1.

The methods this product can be fulfilled by, a subset of pickup, delivery, dispatch, in that canonical order. A product that declares none falls back to ["pickup", "delivery"]. pickup_available, delivery_available, and dispatch_available are booleans derived from this list, so they can never disagree with it.

id, name, type, required, options (value, label, price_modifier), default_value. Supply order custom_fields keyed by id. Back-of-house fields are never exposed here.

The resolved prefill for a custom field, or null. A field the product defers to the customer emits null even when a default is configured, because prefilling it would satisfy the field at checkout and the deferred collection step would never fire. Treat null as "leave empty".

ISO 8601, or null on a document with no stored timestamp. Same for updated_at.

single or multi.

Minimum options to select. single choices report 1. For multi, the minimum is clamped down to the number of options currently visible and available, so a "pick at least 3" choice with only 2 valid options requires 2.

Maximum options to select, or null for unbounded (again clamped to the visible option count). single choices report null; submit at most one option regardless.

When true, the choice must be answered - unless it is currently hidden by its dependency or has no available options, in which case it is skipped.

The option the baker configured as the default, or null. Also flagged as is_default on the option itself. It is not applied server-side: pricing resolves only the selections you send, so an optional choice you omit adds no upcharge, whether or not it has a default.

null, or { choice_id, option_mappings }. choice_id is another choice on this same product (already resolved to its product-level id, so it matches a choices[].id directly). option_mappings maps a parent option id to the array of this choice's option ids allowed for that pick. Semantics: this choice does not apply until the parent is answered; a parent option absent from the map allows all of this choice's options; a parent option mapped to an empty array means this choice is not offered for that pick. Dependencies are single-level - a child is never itself a parent.

Upcharge added to the line when that option is chosen, resolved for the product's default variant. Amounts can differ per variant on size-laddered options, and order create resolves the applicable amount server-side from the variant on the line.

false means the option is disabled. Submitting it is rejected with 400.

Whether this option is flagged as the default.

Allergens the option itself introduces, in the same { allergen, level } shape as the product list, always at level contains. They are not merged into the product-level allergens array - union them with it when the option is selected.