Class Pages

Returns a list of all CMS Pages. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.pages.list({
  bearer_token: '7381273269536713689562374856'
})

Returns a single CMS Page by its ID. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.pages.show({
  bearer_token: '7381273269536713689562374856'
  id: '1'
})

Creates a new CMS Page and returns its attributes. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.pages.create({
  bearer_token: '7381273269536713689562374856',
  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'
  }
})

Update selected CMS Page for the signed in User. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.pages.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  cms_page: {
    title: 'About Us',
    type: 'Spree::Cms::Pages::StandardPage',
    meta_title: 'Learn More About Super-Shop',
    content: 'Lots of text..',
    meta_description: 'Learn more about us on this page here...',
    visible: true,
    slug: 'about-us',
    locale: 'en-US'
  }
})

This endpoint removes the specified CMS Page for the current user. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.pages.remove({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})