Skip to content
ShopgateShopgateShopgate Documentation

Get Specific Published Version

GET
/merchants/{merchantCode}/shops/{shopCode}/pages/{pageCode}/versions/{versionNumber}
curl --request GET \
  --url https://cms.shopgate.io/v1/merchants/example/shops/example/pages/example/versions/1

Retrieves the full configuration of a published page as it existed at a specific version number.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
merchantCode
required
string
<= 255 characters
shopCode
required
string
<= 255 characters
pageCode
required
string
<= 255 characters
versionNumber
required
integer
>= 1

Number of the page version

Responses

Section titled “Responses”

200

Section titled “200”

Version of a page

Media typeapplication/json
object
page
object
code

Code of the entity

string
>= 1 characters <= 255 characters
name
string
>= 1 characters <= 255 characters
pageTitle

Localization object, see Entity Localization for further information.

object
key
additional properties
null | 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
lastPublishDate
null | string format: date-time
Example
{
  "page": {
    "code": "8b2802a6-ab0e-4310-97d4-096ae8b3610f",
    "pageTitle": {
      "en-us": "string in english",
      "de-de": "Zeichenkette auf Deutsch"
    },
    "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",
    "lastPublishDate": "2018-12-12T14:27:23.114Z"
  }
}

404

Section titled “404”

Resource not found

Media typeapplication/json
object
statusCode
number
code
required
string
message
required
string
Example
{
  "code": "NotFound",
  "message": "Merchant not found"
}