Get Live Page Content

GET

/merchants/{merchantCode}/shops/{shopCode}/pages/{slug}/resolved

const url = 'https://cms.shopgate.io/v1/merchants/example/shops/example/pages/example/resolved';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://cms.shopgate.io/v1/merchants/example/shops/example/pages/example/resolved

Fetches the fully resolved (published & localized) version of a page by its slug.

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

shopCode

required

string

<= 255 characters

slug

required

string

<= 255 characters

Query Parameters

localeCode

string

<= 5 characters

Locale code to change the language of the name, descriptions, properties and media

Responses

200

Get published page response

application/json

object

page

object

code

Code of the entity

string

>= 1 characters <= 255 characters

name

string

>= 1 characters <= 255 characters

pageTitle

string

slug

string

>= 1 characters <= 255 characters

type

string

Allowed values: cms

isFavorite

boolean

isProtected

boolean

dropzones

object

cmsWidgetList

Array<object>

object

code

required

Code of the entity

string

>= 1 characters <= 255 characters

widgetConfigDefinitionCode

required

Code of the entity

string

>= 1 characters <= 255 characters

widgetConfig

required

object

key

additional properties

any

visibility

required

object

isHidden

boolean

scheduleStartDate

required

null | string format: date-time

scheduleEndDate

required

null | string format: date-time

layout

required

object

marginTop

required

number | null

marginBottom

required

number | null

marginLeft

required

number | null

marginRight

required

number | null

createDate

string format: date-time

updateDate

null | string format: date-time

publishDate

null | string format: date-time

Example

{
  "page": {
    "code": "8b2802a6-ab0e-4310-97d4-096ae8b3610f",
    "type": "cms",
    "isFavorite": false,
    "isProtected": false,
    "dropzones": {
      "cmsWidgetList": [
        {
          "code": "8b2802a6-ab0e-4310-97d4-096ae8b3610f",
          "widgetConfigDefinitionCode": "8b2802a6-ab0e-4310-97d4-096ae8b3610f",
          "visibility": {
            "isHidden": false,
            "scheduleStartDate": "2018-12-12T14:27:23.114Z",
            "scheduleEndDate": "2018-12-12T14:27:23.114Z"
          }
        }
      ]
    },
    "createDate": "2018-12-12T14:27:23.114Z",
    "updateDate": "2018-12-12T14:27:23.114Z",
    "publishDate": "2018-12-12T14:27:23.114Z"
  }
}