Skip to content

Import and export pages

Pages can now be imported and exported into Elevate using the Pages API. Both the import and export of pages are based on the market attribute, which must be supplied as a query parameter for the export, and in the request body for the import. Both endpoints require the Api-Key header.

Pages that are imported via the pages API are automatically published. Pages that already exist will be updated if the permissions allow it.

Import permissions for pages

Permissions for changes to pages are based on the source of the change, either via the apps or the via API. Within each source, permissions can be set to allow for changes in the page and product selections, or in the product lists.

The import permission settings for pages can be configured in Configuration tab in the Admin app. The Pages API can always create and remove pages.

Import permissions for pages

Page & product selection changes

The following actions can be performed with Page & product selection changes allowed:

  • Create pages
  • Remove pages
  • Add lists
    • Set the list algorithm
    • Limit the product selection
    • Change the product selection of a list
  • Remove lists
  • Edit the page heading
  • Set if a selection should be inherited by child pages

Product list changes

The following actions can be performed with Product list changes allowed:

  • Pin products
  • Block products
  • Change list keywords
  • Change list facet selections
  • Change list sort orders

Locale-specific settings

While most settings on a page are locale independent, a few are set per locale. These settings take a mapping from the locale attribute to a setting value. Each locale is optional, meaning the settings can be set for only a subset (or none) of the available locales if desired.

In the full import example below, the headings and paths fields are locale-specific.

Examples

Full import

A full import will replace all existing pages of the specified market with the content of addOrUpdate.

JSON
{
  "market": "UK",
  "type": "FULL",
  "addOrUpdate": [
    {
      "id": "/",
      "heading": "",
      "recLists": [
        {
          "id": "home-1",
          "rules": "rule incl discount [5, 100]",
          "pinned": ["ABC123"],
          "blocked": ["DEF456"]
        }
      ]
    },
    {
      "id": "/tools/power-tools",
      "headings": {
        "en-GB": "Power tools",
        "sv-SE": "Elverktyg"
      },
      "paths": {
        "en-GB": "categories/power-tools", 
        "sv-SE": "kategorier/elverktyg"
      },
      "primaryList": {
        "rules": "rule incl custom.category_name { \"Power tools\" }",
        "pinned": [],
        "blocked": [],
        "keywords": {
          "enabled": false
        },
        "facetsOverride": {
          "enabled": false
        },
        "sortOrderOverride": {
          "enabled": false
        },
        "restrictChildRules": false
      },
      "recLists": [
        {
          "id": "rec-list-1",
          "rules": "rule incl newness 10d",
          "pinned": ["GHI789"],
          "blocked": []
        }
      ]
    }
  ]
}

Partial import

A partial import will add pages to the specified market.

JSON
{
  "market": "UK",
  "type": "PARTIAL",
  "addOrUpdate": [
    {
      "id": "/home/lighting",
      "headings": {
        "en-GB": "Lighting"
      },
      "primaryList": {
        "rules": "rule incl custom.category_name { \"Lighting\" }",
        "pinned": [],
        "blocked": [],
        "keywords": {
          "enabled": true,
          "headingAsKeyword": true,
          "additional": {
            "en-GB": ["lights", "lamp"]
          },
        },
        "facetsOverride": {
          "enabled": true,
          "facets": [
              { "attribute": "brand", "sortOrder": "ALPHABETICAL" }
              { "attribute": "newness" }
          ]
        },
        "sortOrderOverride": {
          "enabled": true,
          "sortOrders": [" RELEVANCE",
                        "NEWEST_FIRST",
                        "PRICE_INCREASING",
                        "PRICE_DECREASING",
                        "DISCOUNT",
                        "RATING"]
        },
        "restrictChildRules": false
      },
      "recLists": [
        {
          "id": "rec-list-1",
          "rules": "rule incl discount [5, 30]",
          "pinned": [],
          "blocked": []
        }
      ]
    }
  ],
  "remove": ["KLM012"]
}
×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE