Skip to content


Imports add data to Elevate and is done by posting XML with an Elevate 3 Enterprise data type to the Web API. The XML must be encoded using UTF-8 and include the operations that is to be performed and all other data type related information. Allowed operations for imports are add, update, remove, and clear.

When importing data via the Web API, an Api-Key header is required for authentication. Only one data type is allowed per import.



URL format



Name Type Description Example
type string Type of import. Only one data type is allowed per import. See Import types
name string Optional name of the import. products-2017-09-06
force boolean Optional, force set to true will disable harmful import protection. Defaults to false true
import XML The request body in XML. See Examples
blockingTimeout string Max duration to wait for a response, ISO-8601 formatted duration with a maximum of 5 min. PT1M

Import types

The following content types are allowed for the type parameter.

  • products (for products and categories)
  • ads
  • synonyms
  • configuration
  • panels

Read more about the import types and their file formats in the guide to working with imports.

Long running imports

If an import exceeds the maximum duration, a 202 ACCEPTED response will be returned containing information regarding the import. This information contains an id, which can be used to continuously poll the status of the import. For more information, see Import Status.


It is recommended that the import is compressed with gzip and the headers Content-Encoding is set to gzip.

Required headers

The header Api-Key is required.

Request body

An XML document containing the data to be imported, see Examples.

Request content-type


Response content-type



Response Description
202 The import has been accepted and will continue to be handled. An import status will be returned.
204 The import completed successfully.
403 Api-Key could not be validated.
404 Cluster not found.
409 An import of the same type is currently in progress.
4xx The request made by the client was invalid. This may mean that the import contained errors, that the cluster had not been defined prior the import, or that the import was rejected for being dangerous. The response body may contain more information about the error.
503 The server in the cluster that received the request is currently unavailable. It is recommended to retry the request. The time between request attempts should be increasing.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.


The following example is considered as importing a compressed file.



<?xml version="1.0" encoding="UTF-8"?>
        <category_tree />
        <product />
            <title>The Magical Programmer</title>


curl -i \
-T products-full-import-w-variants.xml.gz \
-H "Content-Type: application/xml" \
-H "Content-Encoding: gzip" \
-H "Api-Key: {PRIVATE-KEY}" \


HTTP/2 204 No Content

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.