readonly
are snapshots supplied by the host; use the methods on an editor or draft when a model is
editable.
Products and variants
namespace.key form. The result is grouped by namespace.
metaFields is both a read-only accessor and a callable lookup. Read a value already present on
the product with product.metaFields.custom.material. Call it with keys to get their values
synchronously. Use getMetaFields when you need to fetch values; that promise also makes the
returned values available through the accessor.
Product tags
ProductTag runtime global. The package exports
ProductTag as a type only: construct tags with new ProductTag(...) and use
import type { ProductTag } when you need the type.
Cart
Collections and filters
Metaobject pagination
hasNextPage and endCursor with getMetaObjectsByType. The unbounded
getAllMetaObjectsByType method is available when the shop’s dataset is known to be small.
PDP media
ProductMediaItem.type is normally "image", "video", "external_video", or "model3d".
Media tags are keyed by id per media item and support text, an icon, or both.
GraphQL response envelope
errors even when the promise resolves. A resolved promise means the request completed; it
does not guarantee that the GraphQL operation had no errors.