Backend API
The pages model contains data relating to content pages within your storefront and the content within them.
We recommend not making changes via the API for the pages model when possible and suggest using the dashboard model editor instead. If you do wish to make changes via the API, see our data model customization guide.
Fields
Unique identifier for the page.
Human-friendly name of the page.
Lowercase, hyphenated identifier typically used in URLs. When creating a product, a slug will be generated automatically from the name. Maximum length of 1,000 characters.
HTML formatted page content.
Date and time the page was created.
Date and time the page was published.
Date and time the page was updated.
Page description used for search engine optimization purposes.
Indicates whether the page is published. Defaults to false.
URL to specify a page redirect.
Create a new content page.
Arguments
Unique identifier for the page.
Slug identifier of the page. Defaults to a slug-formatted version of the title.
Title of the page.
HTML or text content of the page.
Indicates whether the page is published and should be displayed in the storefront.
Date the page was published. May be used to indicate the publish date in the storefront, or to delay publishing until a future date.
Title used for SEO purposes, if different than the page title.
Description used for SEO purposes. Typically the storefront will use a number of characters from the page's content if this is not defined.
Keywords used for SEO purposes.
Template used to render this page in a storefront theme, if applicable.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.post('/content/pages', {
title: 'Example page'
});
Response
{
"id": "60f199509111e70000000022",
"title": "Example page",
"slug": "example-page",
"content": null,
"published": true,
"date_published": "2021-07-16T14:36:00.142Z",
"meta_title": null,
"meta_description": null,
"date_created": "2021-07-16T14:36:00.142Z",
"date_updated": "2021-07-16T14:36:00.142Z"
}Retrieve an existing content page using the ID that was returned when created.
Arguments
ID of the gift card to retrieve.
Expanding link fields and child collections is performed using the expand argument.
- For example, expand=account would return a related customer account if one exists.
When the field represents a collection, you can specify the query limit.
- For example, expand=variants:10 would return up to 10 records of the variants collection.
See expanding for more details.
Return only the specified fields in the result. For example fields=name,slug would return only the fields name and slug in the response. Supports nested object and array fields using dot-notation. For example, items.product_id. The gift card id is always returned.
Include one or more arbitrary queries in the response, possibly related to the main query.
See including for more details.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.get('/content/pages/{id}', {
id: '60f199509111e70000000022',
});
Response
{
"id": "60f199509111e70000000022",
"title": "Example page",
"slug": "example-page",
"content": "<p>Welcome to our store.</p>",
"published": true,
"date_published": "2021-07-16T14:36:00.142Z",
"meta_title": "Example page",
"meta_description": null,
"date_created": "2021-07-16T14:36:00.142Z",
"date_updated": "2021-07-16T14:36:00.142Z"
}Update an existing page using the ID that was returned when created.
Arguments
Unique identifier for the page.
Slug identifier of the page. Defaults to a slug-formatted version of the title.
Title of the page.
HTML or text content of the page.
Indicates whether the page is published and should be displayed in the storefront.
Date the page was published. May be used to indicate the publish date in the storefront, or to delay publishing until a future date.
Title used for SEO purposes, if different than the page title.
Description used for SEO purposes. Typically the storefront will use a number of characters from the page's content if this is not defined.
Keywords used for SEO purposes.
Template used to render this page in a storefront theme, if applicable.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.put('/content/pages/{id}', {
id: '60f199509111e70000000022',
title: 'Updated page'
});
Response
{
"id": "60f199509111e70000000022",
"title": "Updated page",
"slug": "example-page",
"content": "<p>Welcome to our store.</p>",
"published": true,
"date_published": "2021-07-16T14:36:00.142Z",
"meta_title": "Example page",
"meta_description": null,
"date_created": "2021-07-16T14:36:00.142Z",
"date_updated": "2021-07-18T09:12:04.481Z"
}Return a list of content pages.
Arguments
Expand link fields and child collections by using the expand argument.
- For example, expand=account would return a related customer account if one exists.
When the field represents a collection, you can specify the query limit.
- For example, expand=variants:10 would return up to 10 records of the variants collection.
See expanding for more details.
Returns only the specified fields in the result.
- For example fields=name,slug would return only the fields name and slug in the response.
Supports nested object and array fields using dot-notation.
- For example, items.product_id. The product id is always returned.
Include one or more arbitrary queries in the response which are potentially related to the main query.
See including for more details.
Limit the number of records returned, ranging between 1 and 1000. Defaults to 15.
The page number of results to return given the specified or default limit.
A text search is performed using the search argument. Searchable fields are defined by the model.
- For example, search=red would return records containing the word "red" anywhere in the defined text fields.
See searching for more details.
Expression to sort results by using a format similar to a SQL sort statement.
- For example, sort=name asc would return records sorted by name ascending.
See sorting for more details.
An object with criteria to filter the result.
- For example, active=true would return records containing a field active with the value true.
It's also possible to use query operators, for example, $eq, $ne, $gt, and more.
See querying for more details.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.get('/content/pages', {
limit: 25,
page: 1
});
Response
{
"count": 51,
"results": [
{
"id": "60f199509111e70000000022",
"title": "Example page",
"slug": "example-page",
"content": "<p>Welcome to our store.</p>",
"published": true,
"date_published": "2021-07-16T14:36:00.142Z",
"meta_title": "Example page",
"meta_description": null,
"date_created": "2021-07-16T14:36:00.142Z",
"date_updated": "2021-07-16T14:36:00.142Z"
},
{...},
{...}
],
"page": 1,
"pages": {
"1": {
"start": 1,
"end": 25
},
"2": {
"start": 26,
"end": 50
},
"3": {
"start": 51,
"end": 51
}
}
}Delete a content page permanently.
Arguments
The ID of the page to delete.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.delete('/content/pages/{id}', {
id: '60f199509111e7000000002e'
});
Response
{
"id": "60f199509111e7000000002e",
"title": "Retired page",
"slug": "retired-page",
"content": null,
"published": false,
"date_published": null,
"meta_title": null,
"meta_description": null,
"date_created": "2021-07-16T14:36:00.142Z",
"date_updated": "2021-07-16T14:36:00.142Z"
}