Pages

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.

The pages model

Fields

id

objectId

Unique identifier for the page.

name

stringrequired

Human-friendly name of the page.

slug

stringrequired

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.

content

string

HTML formatted page content.

date_created

date

Date and time the page was created.

date_published

date

Date and time the page was published.

date_updated

date

Date and time the page was updated.

meta_description

string

Page description used for search engine optimization purposes.

published

boolean

Indicates whether the page is published. Defaults to false.

redirect

string

URL to specify a page redirect.

Create a page

Create a new content page. If you wish to generate your own unique ID for the record, it must use BSON ObjectID format for compatibility.

Arguments

POST/giftcards

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.post('/content/pages', {
  title: 'Example page'
});

Response

{
  "id": "60f199509111e70000000022",
  "amount": 100,
  "amount_spent": 25,
  "balance": 75,
  "code": "C9X9L7D9Q3MAXC3P",
  "code_formatted": "C9X9 L7D9 Q3MA XC3P",
  "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.142Z",
  "date_updated": "2021-07-16T14:36:00.142Z",
  "last4": "XC3P",
  "redeemed": false,
  "send_email": "friend@example.com",
  "send_note": null
}

Retrieve a page

Retrieve an existing content page using the ID that was returned when created.

Arguments

id

objectIdrequired

ID of the gift card to retrieve.

expand

string

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.

fields

string

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

string

Include one or more arbitrary queries in the response, possibly related to the main query.

See including for more details.

GET/giftcards/{id}

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.get('/content/pages/{id}', {
  id: '60f199509111e70000000022',
});

Response

{
  "id": "60f199509111e70000000028",
  "amount": 100,
  "amount_spent": 25,
  "balance": 75,
  "code": "C9X9L7D9Q3MAXC3P",
  "code_formatted": "C9X9 L7D9 Q3MA XC3P",
  "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.142Z",
  "date_updated": "2021-07-16T14:36:00.142Z",
  "last4": "XC3P",
  "redeemed": false,
  "send_email": "friend@example.com",
  "send_note": null
}

Update a page

Update an existing page using the ID that was returned when created.

Arguments

PUT/giftcards/:id

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.put('/content/pages/{id}', {
  id: '60f199509111e70000000022'
});

Response

{
  "id": "60f199509111e70000000022",
  "amount": 100,
  "amount_spent": 25,
  "balance": 75,
  "code": "C9X9L7D9Q3MAXC3P",
  "code_formatted": "C9X9 L7D9 Q3MA XC3P",
  "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.142Z",
  "date_updated": "2021-07-16T14:36:00.142Z",
  "last4": "XC3P",
  "redeemed": false,
  "send_email": "friend@example.com",
  "send_note": null
}

List all pages

Return a list of content pages.

Arguments

expand

string

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.

fields

string

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

object

Include one or more arbitrary queries in the response which are potentially related to the main query.

See including for more details.

limit

int

Limit the number of records returned, ranging between 1 and 1000. Defaults to 15.

page

int

The page number of results to return given the specified or default limit.

search

string

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.

sort

string

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.

where

object

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.

GET/giftcards

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.put('/content/pages', {
  ...
});

Response

{
  "count": 51,
  "results": [
    {
      "id": "60f199509111e70000000022",
      "amount": 100,
      "amount_spent": 25,
      "balance": 75,
      "code": "C9X9L7D9Q3MAXC3P",
      "code_formatted": "C9X9 L7D9 Q3MA XC3P",
      "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
      "currency": "USD",
      "date_created": "2021-07-16T14:36:00.142Z",
      "date_updated": "2021-07-16T14:36:00.142Z",
      "last4": "XC3P",
      "redeemed": false,
      "send_email": "friend@example.com",
      "send_note": null
    },
    {...},
    {...}
  ],
  "page": 1,
  "pages": {
    "1": {
      "start": 1,
      "end": 25
    },
    "2": {
      "start": 26,
      "end": 50
    },
    "2": {
      "start": 51,
      "end": 51
    }
  }
}

Delete a page

Delete a content page permanently.

Arguments

id

objectIdrequired

The ID of the page to delete.

DELETE/giftcards/:id

const swell = require('swell-node').init('store-id', 'secret-key');

await swell.delete('/content/pages/{id}', {
  id: '60f199509111e7000000002b'
});

Response

{
  "id": "60f199509111e7000000002e",
  "amount": 100,
  "amount_spent": 25,
  "balance": 75,
  "code": "C9X9L7D9Q3MAXC3P",
  "code_formatted": "C9X9 L7D9 Q3MA XC3P",
  "code_pattern": "{XXXX} {XXXX} {XXXX} {XXXX}",
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.142Z",
  "date_updated": "2021-07-16T14:36:00.142Z",
  "last4": "XC3P",
  "redeemed": false,
  "send_email": "friend@example.com",
  "send_note": null
}

← Back: Gift card products Next: Models →

Pages

The pages model

Fields

id

name

slug

content

date_created

date_published

date_updated

meta_description

published

redirect

Create a page

Arguments

id

slug

title

content

published

date_published

meta_title

meta_description

meta_keywords

theme_template

Response

Retrieve a page

Arguments

id

expand

fields

include

Response

Update a page

Arguments

id

slug

title

content

published

date_published

meta_title

meta_description

meta_keywords

theme_template

Response

List all pages

Arguments

expand

fields

include

limit

page

search

sort

where

Response

Delete a page

Arguments

id

Response