Metaobjects
The store’s storefront-visible metaobject definitions: the custom content types a theme reads before rendering one.
Authorization
clientKey The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… 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
curl -X GET "https://example.com/store/metaobject-definitions" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Metaobject definitions", "data": [ { "type": "lookbook", "name": "Lookbook", "display_field": "title", "has_pages": true, "fields": [ { "key": "title", "name": "Title", "type": "single_line_text" }, { "key": "season", "name": "Season", "type": "single_line_text" }, { "key": "story", "name": "Story", "type": "multi_line_text" } ] } ]}Active entries of one storefront-visible definition, ordered by display name. Anything else 404s.
Authorization
clientKey The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
Path Parameters
Query Parameters
Keyset cursor: pass the previous page next_cursor. Walk while has_more is true; a stale, tampered, cross-list or filter-changed cursor answers 422 starting_after_invalid. Never combine with page.
Items per read (alias of per_page, clamps 1..50). page mode caps at page 50 (page_too_deep); walk the cursor past that.
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… 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
application/json
curl -X GET "https://example.com/store/metaobjects/lookbook?limit=15" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Metaobjects retrieved", "data": [ { "p_id": 1301, "type": "lookbook", "handle": "harmattan-26", "display_name": "Harmattan ’26", "status": "active", "fields": { "title": "Harmattan ’26", "season": "Harmattan 2026", "story": "Dusty-rose layers for December travel." } }, { "p_id": 1302, "type": "lookbook", "handle": "owambe-season", "display_name": "Owambe Season", "status": "active", "fields": { "title": "Owambe Season", "season": "Party season", "story": "Statement ankara for Saturday parties." } } ], "meta": { "definition": { "type": "lookbook", "name": "Lookbook", "has_pages": true } }, "has_more": false, "next_cursor": null}One storefront-visible metaobject entry by type and handle.
Authorization
clientKey The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
Path Parameters
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… 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/metaobjects/lookbook/harmattan-26" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Metaobject entry", "data": { "p_id": 1301, "type": "lookbook", "handle": "harmattan-26", "display_name": "Harmattan ’26", "status": "active", "fields": { "title": "Harmattan ’26", "season": "Harmattan 2026", "story": "Dusty-rose layers for December travel." } }, "meta": { "definition": { "type": "lookbook", "name": "Lookbook", "has_pages": true } }}