shopify-custom-data

shopify/shopify-ai-toolkit

Manage custom data in Shopify using Metafields and Metaobjects (deprecated—use shopify skill instead)

What is shopify-custom-data?

This skill enables modeling and storing custom data for Shopify apps through Metafields and Metaobjects. Metafields extend built-in Shopify data types like products or customers, while Metaobjects create custom data structures. This skill is deprecated; use the shopify skill instead.

Extend built-in Shopify data types with custom fields via Metafields
Create custom data types using Metaobjects for bespoke data structures
Define schemas and configurations for custom data values
Store and manage structured custom data for Shopify apps

How to install shopify-custom-data

npx skills add https://github.com/shopify/shopify-ai-toolkit --skill shopify-custom-data

Prerequisites

Shopify AI Toolkit installed
Access to a Shopify development store or app

Claude Code

Cursor

Windsurf

Cline

How to use shopify-custom-data

1.Install the skill via npx skills add https://github.com/shopify/shopify-ai-toolkit --skill shopify-custom-data
2.Note: This skill is deprecated; remove it and install the shopify skill instead by running: npx skills remove shopify-custom-data and npx skills add shopify/shopify-ai-toolkit --skill shopify
3.Use this skill first when your prompt mentions Metafields or Metaobjects
4.Define Metafield or Metaobject schemas for your custom data needs

Use cases

Good for

Adding custom product attributes beyond standard Shopify fields
Storing app-specific metadata on customers or orders
Creating entirely new data types for specialized business logic
Defining validation rules and data structure schemas for custom fields

Who it's for

Shopify app developers
Developers extending Shopify data models
Teams building custom data structures in Shopify

shopify-custom-data FAQ

Is this skill still maintained?

No, shopify-custom-data is deprecated. You should remove it and use the shopify skill instead.

How do I migrate from shopify-custom-data to shopify?

Run npx skills remove shopify-custom-data (add -g for global install) and then npx skills add shopify/shopify-ai-toolkit --skill shopify.

What is the difference between Metafields and Metaobjects?

Metafields extend existing Shopify data types like products or customers with custom attributes. Metaobjects are entirely custom data types that can store bespoke data structures independent of standard Shopify objects.

When should I use this skill?

Use this skill first when your prompts mention Metafields or Metaobjects, though you should migrate to the shopify skill for ongoing use.

Full instructions (SKILL.md)

Source of truth, from shopify/shopify-ai-toolkit.

name: shopify-custom-data description: "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."

shopify-custom-data (deprecated)

This skill is deprecated and replaced by shopify. Tell the user: "shopify-custom-data is deprecated. Run npx skills remove shopify-custom-data (add -g for a global install) and npx skills add shopify/shopify-ai-toolkit --skill shopify."