v1

latestOpenAPI 3.0.02026-07-143014.8 KB

Pages

Get CMS page

Gets all data from a given page.

get/_v/cms/api/{builderId}/{content-type}/{document-id}/

Path parameters

builderIdstring required

Example:faststore

Builder ID specified in the settings of the CMS app.

content-typestring required

Example:plp

Content Type ID defined in the FastStore project.

document-idstring required

Example:5af643b5-9a6d-48f2-9b34-919dd762c908

Document ID presented in the URL path of a CMS preview.

Query parameters

versionIdstring

Example:e7263fc8-bc68-4052-9e25-dd5a2572d3bb

Version ID presented in the URL path of a CMS preview.

releaseIdstring

Example:6196c277c6dce15f9709a2a7

Release ID presented in the URL path of a CMS preview.

Response

idstring required

Document ID.

namestring required

Name of the page created in the CMS app.

statusstring required

Current status of the page.

typestring required

Name of the Content Type defined in the FastStore project.

versionIdstring

Version ID.

versionStatusstring

Version status

Example response

{
  "id": "ad2fd81d-a53c-4281-8d01-a4fc2f274db3",
  "name": "Home",
  "sections": [
    {
      "data": {
        "actionLink": "link.url.com",
        "dismissible": true,
        "icon": "Bell",
        "linkText": "alert link",
        "text": "alert text"
      },
      "id": "1651804180614",
      "name": "Alert"
    },
    {
      "data": {
        "imageAlt": "hero image",
        "imageSrc": "https://storeframework.vtexassets.com/assets/vtex.file-manager-graphql/images/299f7d32-bb6a-40fd-82a0-4af5573ba572___17239443c00c1e894cff10ca05018058.jpg",
        "link": "/office",
        "linkText": "See all",
        "subtitle": "At FastStore you can shop the best tech of 2022. Enjoy and get 10% off on your first purchase.",
        "title": "New Products Available"
      },
      "id": "1647286556072",
      "name": "Hero"
    },
    {
      "data": {
        "after": "0",
        "first": 5,
        "selectedFacets": [
          {
            "key": "productClusterIds",
            "value": "140"
          }
        ],
        "sort": "score_desc",
        "title": "Most Wanted!"
      },
      "id": "1649293076336",
      "name": "ProductShelf"
    },
    {
      "data": {
        "after": "0",
        "first": 3,
        "selectedFacets": [
          {
            "key": "productClusterIds",
            "value": "141"
          }
        ],
        "sort": "score_desc",
        "title": "Just Arrived"
      },
      "id": "1649293548351",
      "name": "ProductTiles"
    },
    {
      "data": {
        "actionLabel": "See all",
        "actionPath": "/office",
        "caption": "Enjoy and get 10% off on your first purchase!!",
        "title": "Receive our news and promotions in advance."
      },
      "id": "1647286735093",
      "name": "BannerText"
    },
    {
      "data": {
        "after": "0",
        "first": 5,
        "selectedFacets": [
          {
            "key": "productClusterIds",
            "value": "142"
          }
        ],
        "sort": "score_desc",
        "title": "Deals & Promotions"
      },
      "id": "1649293131632",
      "name": "ProductShelf"
    }
  ],
  "status": "published",
  "type": "home",
  "versionId": "e3867e2c-7082-4fe6-83ed-c473242b6970",
  "versionStatus": "publishing"
}