# shopify-custom-data

A Claude and Claude skill that walks the agent through Metafields and Metaobjects in Shopify apps.

- skill · `type=skill` · Codex, ChatGPT · 1 install · ★ 7596
- Author: Shopify · official OpenAI repository
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/openai/plugins/tree/HEAD/plugins/shopify/skills/shopify-custom-data/SKILL.md
- Updated: 2026-10-08
- HTML: https://affpapa.org/en/nevibecode/skills/shopify-custom-data

## What it does

The skill kicks in when a prompt mentions Metafields or Metaobjects, and it fixes the order of work: definitions first, then writing values, then reading them. Definitions live in `shopify.app.toml`, so they are version controlled and installed automatically. Values are read and written through the GraphQL Admin or Storefront API afterwards.

Inside are the exact calls: `metafieldsSet` for metafields, `metaobjectUpsert` for metaobjects, reads with `jsonValue` and aliases. Checkout extensions get their own section on `useAppMetafields`, and Shopify Functions get a GraphQL input query. The skill insists on one approach and does not offer alternatives unless asked, which keeps the developer from juggling options.

Watch the namespaces. A metaobject declared as `[metaobjects.app.example]` is read as `$app:example`, not `app`. The author calls `namespace: app` a serious mistake, so check your queries. Node.js is required. For scaffolding apps and extensions the skill points to Shopify CLI only: `shopify app init`, `shopify app generate extension`, `shopify app dev`, `shopify app deploy`.

## Install

### Codex (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add openai/plugins --skill shopify-custom-data -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/shopify-custom-data/SKILL.md` — For all projects use ~/.agents/skills/

### Claude Code

1. **Skills CLI (Vercel)**
```bash
npx skills add openai/plugins --skill shopify-custom-data -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/shopify-custom-data/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/shopify-custom-data/

### Cursor

**Manually: put the files in place**
- File: `.cursor/skills/shopify-custom-data/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install openai/plugins shopify-custom-data
```

2. **Manually: put the files in place**
- File: `.github/skills/shopify-custom-data/SKILL.md`

### Gemini CLI

**Platform CLI**
```bash
gemini skills install https://github.com/openai/plugins --path plugins/shopify/skills/shopify-custom-data
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/shopify-custom-data/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/openai/plugins/tree/HEAD/plugins/shopify/skills/shopify-custom-data/SKILL.md

## When to use it
- declare a product metafield schema in `shopify.app.toml`
- write a metafield value with `metafieldsSet`
- create an author metaobject and link it to a product
- read a metafield in a checkout extension without a network call
- select metafields in a Shopify Functions GraphQL query

## Example prompts
- Add a care_guide metafield for a product in shopify.app.toml
- Write the example metafield value for product gid://shopify/Product/1234
- Show how to read a metaobject of type $app:author in the Storefront API

## Similar
- [shopify-expert](https://affpapa.org/en/nevibecode/skills/shopify-expert.md) — skill · 5000 installs
- [shopify](https://affpapa.org/en/nevibecode/skills/shopify.md) — skill · 4800 installs
- [shopify-development](https://affpapa.org/en/nevibecode/skills/shopify-development.md) — skill · 1900 installs
- [shopify-products](https://affpapa.org/en/nevibecode/skills/shopify-products.md) — skill · 1400 installs
- [shopify-setup](https://affpapa.org/en/nevibecode/skills/shopify-setup.md) — skill · 1200 installs
- [shopify-apps](https://affpapa.org/en/nevibecode/skills/sickn33-shopify-apps.md) — skill · 1000 installs

From the same set: [openai/plugins](https://affpapa.org/en/nevibecode/by/openai/plugins.md) — 337 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md