Content. 4 operations.
4 of them work. Each needs a bearer token with its scope. All operations.
Operations
POST/api/v1/content/pages/{slug}/deletecontent.delete-pagecontent.write
GET/api/v1/content/pagescontent.pagescontent.read
Read a page at a time: give limit (1 to 500; 100 when none is given) and after, the Next-Cursor of the page before. Follow the Link, rel next, to the rest.
Parameters
limitquery | integerThe most pages in the page: 1 to 500; 100 when the call gives no limit. The Next-Cursor and Link headers name the next page. |
afterquery | stringSee common parameters |
Answer
array of ContentPage
Errors: 400, 401, 403, 405, 422, 429
curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/content/pages
POST/api/v1/content/pagescontent.save-pagecontent.write
POST/api/v1/content/pages/{slug}/publishedcontent.set-page-publishedcontent.write
Schemas 5
ContentPage
ContentPage is a page the owner writes as the owner sees it: its slug, its path (/pages/{slug}, or the one segment the owner chose, such as /about), its title, its body in the safe Markdown subset, its meta description, whether buyers read it, and the actor and the time of the last write that changed it, "" and nil for a page the seed loaded that no one has changed since.
bodyrequired | string |
changed_at | string (date-time) |
changed_byrequired | string |
descriptionrequired | string |
pathrequired | string |
publishedrequired | boolean |
slugrequired | string |
titlerequired | string |
ContentPageChange
ContentPageChange is a page as an operation left it, and whether the operation changed it.
changedrequired | boolean |
pagerequired | ContentPage |
ContentPageRequest
ContentPageRequest is a page the owner saves: in place of the page at Old, keeping its publication, or added, unpublished, when Old is "". Slug "" is the title's slug; Path "" is the default path, /pages/{slug}.
body | string |
description | string |
old | string |
path | string |
slug | string |
titlerequired | string |
Deletion
Deletion is what a delete deleted: the slug of the category, the collection or the content page that is gone, or the name of the image.
deletedrequired | string |
PublishedRequest
PublishedRequest says whether buyers read a page.
publishedrequired | boolean |
Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.