Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Create a CMS Page
Creates a CMS Page
curl --request POST \
--url http://{defaultHost}/api/v2/platform/cms_pages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cms_page": {
"title": "About Us",
"type": "Spree::Cms::Pages::StandardPage",
"meta_title": "Learn More About Super-Shop",
"content": "Lot'\''s of text..",
"meta_description": "Learn more about us on this page here...",
"visible": true,
"slug": "about-us",
"locale": "en-US"
}
}'
{
"data": {
"id": "5",
"type": "cms_page",
"attributes": {
"title": "Eligendi recusandae hic magnam at voluptates delectus quis.",
"meta_title": null,
"content": null,
"meta_description": null,
"visible": true,
"slug": "eligendi-recusandae-hic-magnam-at-voluptates-delectus-quis",
"type": "Spree::Cms::Pages::StandardPage",
"locale": "en",
"deleted_at": null,
"created_at": "2022-11-08T19:34:01.378Z",
"updated_at": "2022-11-08T19:34:01.378Z"
},
"relationships": {
"cms_sections": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Body
Give your page a title.
"About Us"
Set the type of page.
Spree::Cms::Pages::StandardPage
The language this page is written in.
"en-US"
Set the meta title for this page, this appears in the title bar of the browser.
"Learn More About Super-Shop"
The text content of a standard page, this can be HTML from a rich text editor.
"Lot's of text.."
Set a meta description, used for SEO and displayed in search results.
"Learn more about us on this page here..."
This page is publicly visible when set to true
.
Set a slug for this page.
"about-us"
Give your page a title.
"About Us"
Set the type of page.
Spree::Cms::Pages::StandardPage
The language this page is written in.
"en-US"
Set the meta title for this page, this appears in the title bar of the browser.
"Learn More About Super-Shop"
The text content of a standard page, this can be HTML from a rich text editor.
"Lot's of text.."
Set a meta description, used for SEO and displayed in search results.
"Learn more about us on this page here..."
This page is publicly visible when set to true
.
Set a slug for this page.
"about-us"
Give your page a title.
"Our Flash Homepage"
Set the type of page.
Spree::Cms::Pages::Homepage
The language this page is written in.
"en-US"
Set the meta title for this page, this appears in the title bar of the browser.
"Visit Our Store - Great Deals"
Set a meta description, used for SEO and displayed in search results.
"Discover great new products that we sell in this store..."
This page is publicly visible when set to true
.
Give your page a title.
"Featured Product"
Set the type of page.
Spree::Cms::Pages::FeaturePage
The language this page is written in.
"en-US"
Set the meta title for this page, this appears in the title bar of the browser.
"Learn More About This Featured Product"
Set a meta description, used for SEO and displayed in search results.
"Learn more about us this amazing product that we sell right here..."
This page is publicly visible when set to true
.
Set a slug for this page.
"about-us"
Was this page helpful?
curl --request POST \
--url http://{defaultHost}/api/v2/platform/cms_pages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cms_page": {
"title": "About Us",
"type": "Spree::Cms::Pages::StandardPage",
"meta_title": "Learn More About Super-Shop",
"content": "Lot'\''s of text..",
"meta_description": "Learn more about us on this page here...",
"visible": true,
"slug": "about-us",
"locale": "en-US"
}
}'
{
"data": {
"id": "5",
"type": "cms_page",
"attributes": {
"title": "Eligendi recusandae hic magnam at voluptates delectus quis.",
"meta_title": null,
"content": null,
"meta_description": null,
"visible": true,
"slug": "eligendi-recusandae-hic-magnam-at-voluptates-delectus-quis",
"type": "Spree::Cms::Pages::StandardPage",
"locale": "en",
"deleted_at": null,
"created_at": "2022-11-08T19:34:01.378Z",
"updated_at": "2022-11-08T19:34:01.378Z"
},
"relationships": {
"cms_sections": {
"data": []
}
}
}
}