Objects

The Objects module is the platform's generic content model. A merchant defines object types (content types such as "FAQ", "Page", or "Store location") in the client dashboard, each with an ordered list of typed properties. Content editors then create records (entries) of those types. Your storefront reads both through the public API: the type definitions tell you what shape to expect, the records carry the content.

This makes the module a natural fit for LLM-driven and headless storefronts: fetch /v1/api/objects/types once to learn the schema, then render records generically.

All three endpoints live under /v1/api/objects, are read-only, require the objects:read scope on your API key, and require the objects module to be enabled (403 {"error":"Module not enabled: objects"} otherwise).

Object types and properties#

An object type has a key (a unique slug used in URLs; the values types, records, properties, and bulk are reserved and never appear), a singular name, and a plural_name. Every type automatically carries a required name text property; merchants add the rest.

A property definition has:

Property types and the value each produces inside values:

Properties can be archived in the dashboard. Archived properties are invisible on the public API: they are omitted from the type's property list and their keys are stripped from record values.

Records#

A record is {id, values, created_at} where values is a JSON object keyed by property key. Properties without a value are simply absent from values (null values are dropped on save), so always treat missing keys as "no value". created_at is an ISO 8601 timestamp.

Sections values#

A property of type sections holds page-builder content: its value is a list of section instances, returned verbatim by the API. Each instance has this shape:

{
  "_key": "sec_a1b2c3d4e5f60718293a4b5c",
  "type": "hero",
  "look": "default",
  "v": 1,
  "visible": true,
  "data": { "title": { "en": "Welcome" }, "cta": { "url": "/products", "label": "Shop now" } }
}

Section instances are validated on write against the store's section type definitions (key, name, icon, looks, schema version, fields, item label field), which are managed in the client dashboard. The public API does not expose section type definitions; your storefront and the merchant agree on the section vocabulary out of band.

Field kinds that can appear inside data:

Localized fields. A field flagged as localized stores a locale map instead of a bare value: {"en": "Hello", "nl": "Hallo"} with locale tags matching /^[a-z]{2}(-[A-Z]{2})?$/. The API returns whatever was stored, so any consumer of record values must handle both bare values and locale maps for the same field kind.

Limits. A sections property holds at most 100 sections (or the property's configured maximum) and at most 256KB of JSON.

Conventions#

• All ids are UUIDs. All data is implicitly scoped to your store by the API key.
• Money is always integer cents. Dates in date fields and range filters are YYYY-MM-DD strings. created_at timestamps are ISO 8601.
• Only the record list endpoint is paginated; the types list returns a plain data array.

Endpoints#