Join Program
This section is a work in progress, and subject to change.
API access is currently restricted. Interested? Please apply to our early access program.
Pages Resource
URL Endpoints
| Endpoint |
Supported Metods |
| /[store-handle]/api/v2/webstore/pages.json |
GET |
| /[store-handle]/api/v2/webstore/pages/[page-uuid or page-handle].json |
GET, PUT, DELETE |
Data Structure
If the url /store-name/shop/page/agreement would be requested, a page would be looked up by the handle agreement and rendered using the template defined by the page property, passing the content dictionary to the template context.
| Name |
Path |
Type |
Description |
Example |
| type |
type |
string (readonly) |
Resource type. Must match the resource type used in the endpoint. |
"orders", "products", "customers" |
| uuid |
uuid |
uuid |
Resource identifier. Must be a valid hex representation. |
"06429e75a8ea11de80c09314b8ee4e52" |
| revision |
revision |
timestamp (readonly) |
Resource version. Uses the timestamp format, precision up to seconds. |
1253783394 |
| handle |
handle |
limited string |
Reference to be used in the url. Accepts url friendly characters (a-z0-9-_). Needs to be unique amongst all pages. |
"agreement", "about-us", "welcome" |
| templatePage |
templatePage |
string |
Page file name in the current template. |
"page.html", "welcome.html" |
| content |
content |
dictionary with strings |
The pages will be rendered using this content. It can contain any key you wish. Default pages expect at least a value with key "main". See the page context for more info. |
|
| main |
content.main |
string |
Text content for the page. Can be either HTML, Plain Text or Textile data. |
"Lorem ipsum dolor sit amet." |