Difference between revisions of "API Page"

From Spiffy Stores Knowledge Base

Line 53: Line 53:
 
|-
 
|-
 
!created_at
 
!created_at
|<pre></pre>
+
|<pre>{ "created_at": "2008-07-15T20:00:00-04:00" }</pre>
 +
The date and time (ISO 8601 format) when the page was created.
 
|-
 
|-
 
!updated_at
 
!updated_at
|<pre></pre>
+
|<pre>{ "updated_at": "2008-07-16T20:00:00-04:00" }</pre>
 +
The date and time (ISO 8601 format) when the page was last updated.
 
|-
 
|-
 
!published
 
!published
|<pre></pre>
+
|<pre>{ "published" : true }</pre>
 +
Indicates whether the page is published and visible to customers.
 
}
 
}

Revision as of 17:14, 22 May 2018

Your Spiffy Store comes with a tool for creating basic HTML web pages. Store owners can create any number of pages to hold static content, such as an 'About us' page, a 'Contact us' page, or a page with customer testimonials.

These web pages are represented by the Page resource, and their HTML content is contained in the value of the body_html property. The Page resource lets you retrieve, create, update, and delete web pages for a store.

Pages are used for long-term, static content that rarely changes. Frequently updated content is best created with the Blog resource instead.

Page Properties

id
{ "id" : 123456789 }

A unique numeric identifier for the page.

title
{ "title" : "How to save Money" }

This is the page title.

handle
{ "handle" : "how-to-save-money" }

A unique, human-friendly string for the page, generated automatically from its title. In online store themes, the Liquid templating language refers to a page by its handle.

body
{ "body" : "This is a *sample* page."}

The text content of the page in Textile markup. This is automatically translated into body_html for display on a browser.

body_html
{ "body_html" : "<p>This is a <b>sample</b> page.</p>"}

The text content of the page, complete with HTML markup.

created_at
{ "created_at": "2008-07-15T20:00:00-04:00" }

The date and time (ISO 8601 format) when the page was created.

updated_at
{ "updated_at": "2008-07-16T20:00:00-04:00" }

The date and time (ISO 8601 format) when the page was last updated.

published
{ "published" : true }

Indicates whether the page is published and visible to customers. }