Metafield Definitions
The store’s metafield schema: what each metafields value on a product, a product variant, a collection or a blog post means, its type and allowed values. One owner type per read: owner_type=product (the default), variant, collection or post, whose fields are public only when the merchant made them visible. Values are already public on the resource; this exposes only their shape, never a value, and never a definition belonging to another store.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Query Parameters
What the fields hang off. Defaults to product, the only owner type this list served before: an existing caller sends nothing and reads exactly what it always did.
Value in
- "product"
- "collection"
- "post"
- "variant"
- null
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/metafield-definitions?owner_type=product" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Metafield definitions", "data": [ { "p_id": 512, "handle": "custom.fabric", "owner_type": "product", "namespace": "custom", "key": "fabric", "type": "single_line_text", "storefront_visible": true, "customer_visible": false, "app_owned": false, "merchant_access": "read_write", "pinned": true, "pinned_position": 1, "name": "Fabric", "description": "The fabric a piece is cut in: cotton, wool, silk or linen.", "validations": { "choices": [ "cotton", "wool", "silk", "linen" ] }, "created_at": "2026-02-10T10:00:00.000000Z", "updated_at": "2026-02-10T10:00:00.000000Z" }, { "p_id": 513, "handle": "custom.care", "owner_type": "product", "namespace": "custom", "key": "care", "type": "multi_line_text", "storefront_visible": true, "customer_visible": false, "app_owned": false, "merchant_access": "read_write", "pinned": false, "pinned_position": null, "name": "Care instructions", "description": "How to wash and keep the piece.", "validations": [], "created_at": "2026-02-10T10:05:00.000000Z", "updated_at": "2026-02-10T10:05:00.000000Z" } ]}