For agencies

Lists are part of a theme build, so they need to move with it and to survive the hand-over.

Build on a development store

Install the app on the development store, build the metaobject definitions and lists there, and write the theme against them. Definitions must exist on the live store with the same type handles and field keys before lists can be imported; the app checks this on import and tells you what is missing.

Export and import

Export on the home page downloads every list as one JSON file. Import takes the file and creates the lists on the target store, writing their metafields straight away.

• Lists are matched by handle. Tick Overwrite to replace lists that already exist.
• A list whose type or fields are missing on the target is skipped, with the reason shown.
• Relationship conditions are checked against the target's definitions too.

Keep the JSON file in the theme repository. It is small, readable, and diffs cleanly.

{
  "format": "metaobject-lists/1",
  "lists": [
    {
      "name": "Featured books",
      "handle": "featured-books",
      "definition": { "source": "book", "where": { "op": "and", "items": [ { "field": "featured", "op": "eq", "value": true } ] }, "sort": [ { "key": "title", "direction": "asc" } ], "limit": 8 }
    }
  ]
}

Notes on each list

Every list has a Notes field. Write down where the list is used in the theme and why it exists. The next developer will see the note on the home page and in the editor before they change anything.

Needs attention

The home page flags a list when a field it uses has been renamed or removed from the type, or when a relationship target no longer exists. The list keeps its last written result until it is fixed, so nothing disappears from the storefront without warning.

Handing over to a client

• Leave the app installed under the client's account and transfer billing to them from the Partner Dashboard, or install it fresh on their store and import the lists.
• Point them at the Concepts page. Content editors need to know only that lists update themselves when entries change.
• If the client later uninstalls, the metafields stay and the theme keeps rendering the last result. Nothing breaks; lists stop updating.

Pricing for agencies

There are two plans, billed to the store: Free, with three lists and every feature, and Pro at $29 a month for unlimited lists. Development stores are free on either plan, so build the whole theme on the development store and let the client's store move to Pro at go-live. If you manage several stores and want to talk about a partner arrangement, email [email protected].