Dokumentation Entwickler API

Page Ressource

Aktualisiert am 16.03.2017

Page Ressource

Page Ressource

Get Pages

GET /api/pages.json

  • GET /api/pages.json will return all pages. See the Filter Pages endpoint for more info.

Page Ressource


Status: 200 OK
[
{
"page": {
"active": true,
"content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
"content_meta_description": null,
"content_meta_keywords": null,
"content_title_tag": null,
"created_on": "2013-10-08",
"custom_url": null,
"custom_url_routing": "standard_url_is_canonical",
"format": "tinymce",
"handle": "about-us",
"height": null,
"id": 100,
"mall_id": null,
"option_01": "",
"option_02": "",
"option_03": "",
"properties_count": 0,
"shop_id": 953,
"title": "About us",
"updated_on": "2013-10-08",
"width": null
}
},
{
"page": {
"active": true,
"content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
"content_meta_description": null,
"content_meta_keywords": null,
"content_title_tag": null,
"created_on": "2013-10-08",
"custom_url": null,
"custom_url_routing": "standard_url_is_canonical",
"format": "tinymce",
"handle": "shipping",
"height": null,
"id": 101,
"mall_id": null,
"option_01": null,
"option_02": null,
"option_03": null,
"properties_count": 0,
"shop_id": 953,
"title": "Shipping",
"updated_on": "2013-10-08",
"width": null
}
}
]

Page Ressource

Get Page

GET /api/pages/100.json

  • GET /api/pages/100.json will return the specified page.

Page Ressource

Status: 200 OK
{
"page": {
"active": true,
"content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
"content_meta_description": null,
"content_meta_keywords": null,
"content_title_tag": null,
"created_on": "2013-10-08",
"custom_url": null,
"custom_url_routing": "standard_url_is_canonical",
"format": "tinymce",
"handle": "about-us",
"height": null,
"id": 7629,
"mall_id": null,
"option_01": null,
"option_02": null,
"option_03": null,
"properties_count": 0,
"shop_id": 953,
"title": "About us",
"updated_on": "2013-10-08",
"width": null
}
}

Page Ressource

Create Page

POST /pages.json

  • POST /pages.json will create a new page from the parameters passed.

Page Ressource

Status: 200 OK
{
"page": {
"title": "This is my new page!",
content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...
}
}

Page Ressource

This will return 201 Created, with the location of the new page in the Location header along with the current JSON representation of the page if the creation was a success. See the Get page endpoint for more info.

Update Page

PUT /pages/1.json

  • PUT /pages/1.json will update the page from the parameters passed.

Page Ressource

Status: 200 OK
{
"page": {
title": "This is my new page title!
}
}

Page Ressource

This will return 200 OK if the update was a success along with the current JSON representation of the page. See the Get page endpoint for more info.

Delete Page

DELETE /pages/1.json

  • DELETE /pages/1.json will delete the page specified and return 200 OK if that was successful.

Get Pages Count

GET /api/pages/count.json

  • GET /api/pages/count.json will return the pages count.

Page Ressource

Status: 200 OK
{
"count": 8
}

Page Ressource

Filter Pages

GET /api/pages.json?filter_name1=filter_value1&filter_name2=filter_value2

  • GET /api/pages.json?filter_name_1=filter_value_1&filter_name_2=filter_value_2 will return a filtered list of pages. See the Get pages endpoint for more info about the output.

Available Filters and Options

Filter-/Optionname
Description
Type
limit
The amount of results, defaults to 150, maximum are 250
Integer
offset
The amount of results to omitInteger
include
Include one or more page associations (format: properties,links,shop,…)
String
title
Filter by title
String
handle
Filter by handle
String
  • GET /api/pages.json?include=links will return all pages with all links to each page (nested). See the Get pages endpoint for more info about the output

Page Ressource

Status: 200 OK
[
{
"page": {
"active": true,
"content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
"content_meta_description": null,
"content_meta_keywords": null,
"content_title_tag": null,
"created_on": "2013-10-08",
"custom_url": null,
"custom_url_routing": "standard_url_is_canonical",
"format": "tinymce",
"handle": "shipping",
"height": null,
"id": 101,
"mall_id": null,
"option_01": null,
"option_02": null,
"option_03": null,
"properties_count": 0,
"shop_id": 953,
"title": "Shipping",
"updated_on": "2013-10-08",
"width": null,
"links": [
{
"active": true,
"auto_open": false,
"children_count": 0,
"handle": "shipping",
"id": 10001,
"linkable_id": 101,
"linkable_type": "Page",
"linklist_id": 1001,
"links_to": "/pages/shipping",
"name": "Shipping",
"parent_id": null,
"position": 19,
"title_text": null
},
{
"active": true,
"auto_open": false,
"children_count": 0,
"handle": "shipping",
"id": 10002,
"linkable_id": 101,
"linkable_type": "Page",
"linklist_id": 1002,
"links_to": "/pages/shipping",
"name": "Shipping",
"parent_id": null,
"position": 3,
title_text": "
}
]
}
}
]