shopify-custom-data
shopify custom data
What it does
- ALWAYS show creating metafield/metaobject definitions, then writing values, then retrieving values.
- NEVER show or offer alternate approaches to the same problem if not explicitly requested. It will only increase the user's confusion.
- Keep examples minimal -- avoid unnecessary prose and comments
- Remember the audience for this guidance is app developers -- they do not have access to the Shopify Admin site
- Follow this guidance meticulously and thoroughly
- Apps that want other apps to read/write their data should use the above GraphQL, and "merchant-owned" namespace
- Metaobjects defined with [metaobjects.app.example...] in shopify.app.toml, MUST be accessed using type: $app:example
Requirements & configuration
- Apps that REQUIRE creating definitions at runtime (i.e. types are configured dynamically by merchants) should use metafieldDefinitionCreate, metaobjectDefinitionCreate
Configuration: BASE64_OF_USER_PROMPTYOUR_SESSION_IDYOUR_TOOL_USE_IDOPT_OUT_INSTRUMENTATION
Derived from the skill's own SKILL.md documentation · extracted 2026-07-23
shopify-custom-data FAQ
What does the shopify-custom-data skill do?
MUST be used first when prompts mention Metafields or Metaobjects. Use Metafields and Metaobjects to model and store custom data for your app. Metafields extend built-in Shopify data types like products or customers, Metaobjects are custom data types that can be used to store bespoke data structures. Metafield and Metaobject definitions provide a schema and configuration for values to follow. ALWAYS show creating metafield/metaobject definitions, then writing values, then retrieving values. NEVER show or offer alternate approaches to the same problem if not explicitly requested. It will only increase the user's confusion.
What does shopify-custom-data require?
Apps that REQUIRE creating definitions at runtime (i.e. types are configured dynamically by merchants) should use metafieldDefinitionCreate, metaobjectDefinitionCreate Configuration keys: BASE64_OF_USER_PROMPT, YOUR_SESSION_ID, YOUR_TOOL_USE_ID, OPT_OUT_INSTRUMENTATION.
How do I install shopify-custom-data?
Run: npx -y skills add https://github.com/shopify/shopify-ai-toolkit --skill shopify-custom-data --agent claude-code — the source lives at github.com/shopify/shopify-ai-toolkit.
Maintain shopify-custom-data?
Let people know it's listed here — add the badge (live metrics, light/dark aware) or a plain link to your README or docs.
[](https://getagentictools.com/skills/shopify-shopify-ai-toolkit-shopify-custom-data?ref=badge) npx agentictools info skills/shopify-shopify-ai-toolkit-shopify-custom-data The second line is the CLI lookup for this page — handy in READMEs and docs.
