Queek docs
Merchant endpoint reference

Content

GET
/posts

Requires scope merchant-posts-read.

Lists the store’s posts, each with its metafields (the store’s custom fields on a blog post, every definition; absent on a page or gallery).

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Query Parameters

limit?|

Maximum number of items to return in one page.

Range1 <= value <= 100
starting_after?|

Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.

type?|

One of page, post, gallery.

Value in

  • "page"
  • "post"
  • "gallery"
  • null
status?|

Only items with this status. One of draft, published.

Value in

  • "draft"
  • "published"
  • null

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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/posts?limit=2&status=published" \  -H "X-Client-Key: {{merchantKey}}"
{  "data": [    {      "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e01",      "p_id": 1301,      "parent_id": null,      "blog_category_ids": [],      "type": "post",      "template": null,      "slug": "how-we-smoke-our-party-chicken",      "title": "How we smoke our party chicken",      "content": [        {          "type": "content",          "data": {            "markdown": "Every tray starts over hickory at 5am in our New York kitchen."          }        }      ],      "excerpt": "Hickory, patience and a lot of spice rub.",      "cover_image_url": "https://media.usequeek.com/uploads/stores/1095/posts/party-chicken.jpg",      "status": "published",      "tags": [        "smokehouse",        "kitchen"      ],      "seo": {        "title": "How we smoke our party chicken | Northwind Goods",        "description": "Inside the Northwind Goods kitchen."      },      "metafields": {},      "position": 1,      "is_home": false,      "chrome": "full",      "show_page_title": true,      "published_at": "2026-09-12T08:00:00+01:00",      "created_at": "2026-09-10T16:20:00+01:00",      "updated_at": "2026-09-12T08:00:00+01:00"    },    {      "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e02",      "p_id": 1302,      "parent_id": null,      "blog_category_ids": [],      "type": "page",      "template": null,      "slug": "catering",      "title": "Catering",      "content": [        {          "type": "content",          "data": {            "markdown": "We cater events of 50 to 2,000 guests across New York."          }        }      ],      "excerpt": "Party, office and wedding catering across New York.",      "cover_image_url": "https://media.usequeek.com/uploads/stores/1095/posts/catering.jpg",      "status": "published",      "tags": [],      "seo": {        "title": "Event catering in New York | Northwind Goods",        "description": "Party, office and wedding catering for 50 to 2,000 guests."      },      "position": 2,      "is_home": false,      "chrome": "full",      "show_page_title": true,      "published_at": "2026-07-20T10:00:00+01:00",      "created_at": "2026-07-19T18:00:00+01:00",      "updated_at": "2026-08-30T12:10:00+01:00"    }  ],  "has_more": true,  "next_cursor": "eyJpZCI6IjAxOWEyZDExLTVhNmItN2M3ZC04ZTlmLTBhMWIyYzNkNGUwMiIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"}
POST
/posts

Requires scope merchant-posts-create.

Creates a markdown-body blog post (title required; draft unless published). metafields is a list of {namespace, key, value} checked against the store’s post definitions; values go live at once, even on a draft post.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST posts on the merchant API: a markdown-body blog-post create.

The key authorizes the store; no vendor_id input is read. slug is normalised to a URL-safe slug only when it arrives as a string. metafields are the post's custom fields (validated against the store's post definitions, saved with the post).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/posts" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "title": "How we smoke our party chicken",    "body": "Every tray starts over hickory at 5am in our New York kitchen.",    "excerpt": "Hickory, patience and a lot of spice rub.",    "status": "draft",    "tags": [      "smokehouse",      "kitchen"    ],    "cover_image_url": "https://northwindgoods.example/images/posts/party-chicken.jpg",    "seo": {      "title": "How we smoke our party chicken | Northwind Goods",      "description": "Inside the Northwind Goods kitchen."    },    "metafields": [      {        "namespace": "custom",        "key": "reading_level",        "value": "beginner"      }    ]  }'
{  "status": "success",  "message": "Storefront post created",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e01",    "p_id": 1301,    "parent_id": null,    "blog_category_ids": [],    "type": "post",    "template": null,    "slug": "how-we-smoke-our-party-chicken",    "title": "How we smoke our party chicken",    "content": [      {        "type": "content",        "data": {          "markdown": "Every tray starts over hickory at 5am in our New York kitchen."        }      }    ],    "excerpt": "Hickory, patience and a lot of spice rub.",    "cover_image_url": "https://media.usequeek.com/uploads/stores/1095/posts/party-chicken.jpg",    "status": "published",    "tags": [      "smokehouse",      "kitchen"    ],    "seo": {      "title": "How we smoke our party chicken | Northwind Goods",      "description": "Inside the Northwind Goods kitchen."    },    "metafields": {},    "position": 1,    "is_home": false,    "chrome": "full",    "show_page_title": true,    "published_at": "2026-09-12T08:00:00+01:00",    "created_at": "2026-09-10T16:20:00+01:00",    "updated_at": "2026-09-10T16:20:00+01:00"  }}
GET
/posts/{post}

Requires scope merchant-posts-detail.

Gets one blog post by p_id, UUID or slug, with its metafields (the store’s custom fields on it, every definition). {post} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

post*string

Identifier of the post, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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/posts/how-we-smoke-our-party-chicken" \  -H "X-Client-Key: {{merchantKey}}"
{  "status": "success",  "message": "Storefront post retrieved",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e01",    "p_id": 1301,    "parent_id": null,    "blog_category_ids": [],    "type": "post",    "template": null,    "slug": "how-we-smoke-our-party-chicken",    "title": "How we smoke our party chicken",    "content": [      {        "type": "content",        "data": {          "markdown": "Every tray starts over hickory at 5am in our New York kitchen."        }      }    ],    "excerpt": "Hickory, patience and a lot of spice rub.",    "cover_image_url": "https://media.usequeek.com/uploads/stores/1095/posts/party-chicken.jpg",    "status": "published",    "tags": [      "smokehouse",      "kitchen"    ],    "seo": {      "title": "How we smoke our party chicken | Northwind Goods",      "description": "Inside the Northwind Goods kitchen."    },    "metafields": {},    "position": 1,    "is_home": false,    "chrome": "full",    "show_page_title": true,    "published_at": "2026-09-12T08:00:00+01:00",    "created_at": "2026-09-10T16:20:00+01:00",    "updated_at": "2026-09-12T08:00:00+01:00"  }}
DELETE
/posts/{post}

Requires scope merchant-posts-delete.

Deletes a blog post by p_id, UUID or slug. {post} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

post*string

Identifier of the post, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/posts/how-we-smoke-our-party-chicken" \  -H "X-Client-Key: {{merchantKey}}"
{  "status": "success",  "message": "Storefront post deleted",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e01",    "slug": "how-we-smoke-our-party-chicken",    "deleted": true  }}
PUT
/posts/{post}

Requires scope merchant-posts-update.

Updates a markdown-body blog post by p_id, UUID or slug (publish/unpublish via status). metafields is a list of {namespace, key, value} checked against the store’s post definitions: a null value clears one, a key left out keeps its value; values go live at once. {post} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

post*string

Identifier of the post, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

PUT posts/{post} on the merchant API: a partial markdown-body update.

Absent stays untouched; explicit-null clears ONLY excerpt, cover_image_url, tags, and seo; null/blank slug keeps the existing slug. slug is normalised to a URL-safe slug only when it arrives as a string, and the scoped unique ignores the resolved row.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/posts/how-we-smoke-our-party-chicken" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "title": "How we smoke our party chicken",    "body": "Every tray starts over hickory at 5am in our New York kitchen, and serves fifty.",    "tags": [      "smokehouse",      "kitchen"    ],    "status": "published",    "metafields": [      {        "namespace": "custom",        "key": "reading_level",        "value": "beginner"      }    ]  }'
{  "status": "success",  "message": "Storefront post updated",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e01",    "p_id": 1301,    "parent_id": null,    "blog_category_ids": [],    "type": "post",    "template": null,    "slug": "how-we-smoke-our-party-chicken",    "title": "How we smoke our party chicken",    "content": [      {        "type": "content",        "data": {          "markdown": "Every tray starts over hickory at 5am in our New York kitchen."        }      }    ],    "excerpt": "Hickory, patience and a lot of spice rub.",    "cover_image_url": "https://media.usequeek.com/uploads/stores/1095/posts/party-chicken.jpg",    "status": "published",    "tags": [      "smokehouse",      "kitchen"    ],    "seo": {      "title": "How we smoke our party chicken | Northwind Goods",      "description": "Inside the Northwind Goods kitchen."    },    "metafields": {},    "position": 1,    "is_home": false,    "chrome": "full",    "show_page_title": true,    "published_at": "2026-09-12T08:00:00+01:00",    "created_at": "2026-09-10T16:20:00+01:00",    "updated_at": "2026-09-12T08:00:00+01:00"  }}
GET
/pages

Requires scope merchant-pages-read.

Lists the store’s pages, position order, with cursor pagination (limit + starting_after, has_more/next_cursor; at most 100 per page). Each page carries sections (what the storefront serves now), draft_sections (the unpublished draft, null when there is none) and has_draft. status narrows to draft or published pages.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Query Parameters

limit?|

Maximum number of items to return in one page.

Range1 <= value <= 100
starting_after?|

Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.

status?|

Only items with this status. One of draft, published.

Value in

  • "draft"
  • "published"
  • null

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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/pages?limit=2&status=draft" \  -H "X-Client-Key: {{merchantKey}}"
{  "data": [    {      "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e02",      "p_id": 1302,      "slug": "catering",      "title": "Catering",      "status": "published",      "is_home": false,      "sections": [        {          "type": "content",          "data": {            "markdown": "We cater events of 50 to 2,000 guests across New York."          }        }      ],      "has_draft": true,      "draft_sections": [        {          "type": "content",          "data": {            "markdown": "We cater events of 50 to 2,000 guests across New York, with live grills."          }        },        {          "type": "button",          "data": {            "text": "Request a quote",            "url": "/contact"          }        }      ],      "draft_updated_at": "2026-09-30T09:15:00+01:00",      "seo": {        "title": "Event catering in New York | Northwind Goods",        "description": "Party, office and wedding catering for 50 to 2,000 guests."      },      "position": 2,      "published_at": "2026-07-20T10:00:00+01:00",      "created_at": "2026-07-19T18:00:00+01:00",      "updated_at": "2026-09-30T09:15:00+01:00"    },    {      "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e12",      "p_id": 1303,      "slug": "wedding-packages",      "title": "Wedding packages",      "status": "draft",      "is_home": false,      "sections": [],      "has_draft": true,      "draft_sections": [        {          "type": "content",          "data": {            "markdown": "Three packages for 100, 250 and 500 guests."          }        }      ],      "draft_updated_at": "2026-09-30T10:05:00+01:00",      "seo": [],      "position": 3,      "published_at": null,      "created_at": "2026-09-30T10:05:00+01:00",      "updated_at": "2026-09-30T10:05:00+01:00"    }  ],  "has_more": true,  "next_cursor": "eyJpZCI6IjAxOWEyZDExLTVhNmItN2M3ZC04ZTlmLTBhMWIyYzNkNGUxMiIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"}
POST
/pages

Requires scope merchant-pages-create.

Creates a page as a DRAFT (title required; optional slug, seo and sections). The page is not on the storefront until the merchant publishes it in the dashboard; an app cannot publish, so status, published_at, is_home, template and chrome are refused. sections is the same section list the dashboard saves, validated the same way, limited to a safe subset for apps: no embed, video, contact or metaobjects sections, no raw HTML or script-capable URL anywhere (links are http(s), root-relative, #fragment, and mailto:/tel: on link fields), bg_color as a hex colour, and no tokens or dynamic-source bindings. At most 50 sections and 256 KB.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST pages on the merchant API: a page created as a DRAFT with optional draft sections. The scope is the row's own (authorize before validate); the store comes from the key, never the body.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/pages" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "title": "Wedding packages",    "slug": "wedding-packages",    "sections": [      {        "type": "content",        "data": {          "markdown": "Three packages for 100, 250 and 500 guests."        }      },      {        "type": "button",        "data": {          "text": "Request a quote",          "url": "/contact"        }      }    ],    "seo": {      "title": "Wedding catering packages | Northwind Goods",      "description": "Three wedding packages for 100, 250 and 500 guests."    }  }'
{  "status": "success",  "message": "Storefront page created as a draft",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e12",    "p_id": 1303,    "slug": "wedding-packages",    "title": "Wedding packages",    "status": "draft",    "is_home": false,    "sections": [],    "has_draft": true,    "draft_sections": [      {        "type": "content",        "data": {          "markdown": "Three packages for 100, 250 and 500 guests."        }      }    ],    "draft_updated_at": "2026-09-30T10:05:00+01:00",    "seo": [],    "position": 3,    "published_at": null,    "created_at": "2026-09-30T10:05:00+01:00",    "updated_at": "2026-09-30T10:05:00+01:00"  }}
GET
/pages/{page}

Requires scope merchant-pages-detail.

Gets one page by p_id, UUID or slug, with its live sections and its pending draft_sections. {page} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

page*string

Identifier of the page, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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/pages/catering" \  -H "X-Client-Key: {{merchantKey}}"
{  "status": "success",  "message": "Storefront page retrieved",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e02",    "p_id": 1302,    "slug": "catering",    "title": "Catering",    "status": "published",    "is_home": false,    "sections": [      {        "type": "content",        "data": {          "markdown": "We cater events of 50 to 2,000 guests across New York."        }      }    ],    "has_draft": true,    "draft_sections": [      {        "type": "content",        "data": {          "markdown": "We cater events of 50 to 2,000 guests across New York, with live grills."        }      },      {        "type": "button",        "data": {          "text": "Request a quote",          "url": "/contact"        }      }    ],    "draft_updated_at": "2026-09-30T09:15:00+01:00",    "seo": {      "title": "Event catering in New York | Northwind Goods",      "description": "Party, office and wedding catering for 50 to 2,000 guests."    },    "position": 2,    "published_at": "2026-07-20T10:00:00+01:00",    "created_at": "2026-07-19T18:00:00+01:00",    "updated_at": "2026-09-30T09:15:00+01:00"  }}
PATCH
/pages/{page}

Requires scope merchant-pages-update.

Saves a page draft: sections replaces the page’s pending draft, the live page is never touched, and the merchant publishes in the dashboard. title, slug and seo change a page that has never been published; on a published page they would change the live page, so they answer 409 (page_published) — send sections only. The same section rules as page create apply. {page} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

page*string

Identifier of the page, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

PATCH pages/{page} on the merchant API: a partial draft write. Absent stays untouched; sections replaces the page's draft; title, slug and SEO are accepted only while the page has never been published (a published page answers 409).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/pages/catering" \  -H "X-Client-Key: {{merchantKey}}" \  -H "Content-Type: application/json" \  -d '{    "sections": [      {        "type": "content",        "data": {          "markdown": "We cater events of 50 to 2,000 guests across New York, with live grills."        }      },      {        "type": "button",        "data": {          "text": "Request a quote",          "url": "/contact"        }      }    ]  }'
{  "status": "success",  "message": "Storefront page draft saved",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e02",    "p_id": 1302,    "slug": "catering",    "title": "Catering",    "status": "published",    "is_home": false,    "sections": [      {        "type": "content",        "data": {          "markdown": "We cater events of 50 to 2,000 guests across New York."        }      }    ],    "has_draft": true,    "draft_sections": [      {        "type": "content",        "data": {          "markdown": "We cater events of 50 to 2,000 guests across New York, with live grills."        }      },      {        "type": "button",        "data": {          "text": "Request a quote",          "url": "/contact"        }      }    ],    "draft_updated_at": "2026-09-30T09:15:00+01:00",    "seo": {      "title": "Event catering in New York | Northwind Goods",      "description": "Party, office and wedding catering for 50 to 2,000 guests."    },    "position": 2,    "published_at": "2026-07-20T10:00:00+01:00",    "created_at": "2026-07-19T18:00:00+01:00",    "updated_at": "2026-09-30T09:15:00+01:00"  }}
DELETE
/pages/{page}

Requires scope merchant-pages-delete.

Deletes a page that was never published. A published page or the home page answers 409 (page_live): taking a live page off the storefront is the merchant’s decision, in the dashboard. {page} is a p_id, UUID or slug of this store.

Authorization

merchantKey
X-Client-Key<token>

The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.

In: header

Path Parameters

page*string

Identifier of the page, as returned by the Merchant API.

Header Parameters

X-Client-Key*string

A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.

X-Request-Id?string

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.

Idempotency-Key?string

Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/pages/wedding-packages" \  -H "X-Client-Key: {{merchantKey}}"
{  "status": "success",  "message": "Storefront page deleted",  "data": {    "id": "019a2d11-5a6b-7c7d-8e9f-0a1b2c3d4e12",    "slug": "wedding-packages",    "deleted": true  }}