Skip to content

Imports

Imports add data to eSales and is done by posting XML with an eSales 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.

Method

POST

URL format

/api/v2/import/{type}?name={name}

Parameters

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
import XML The request body in XML. See Examples

Import types

The following content types are allowed for the type parameter.

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

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

Required headers

The header Api-Key is required.

Request body

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

Request content-type

application/xml

Response content-type

HTTP response code

Responses

Response Description
204 The import completed successfully.
403 Incorrect Api-Key.
404 Cluster not found.
4xx The request made by the client was invalid. This may mean that the import contained errors or that the cluster has not been defined prior the import. The response body may contain more information about the error.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Examples

Try out the API at the Apptus API Playground with your eSales Playground and API credentials.

Request

products-full-import-w-variants.xml

<?xml version="1.0" encoding="UTF-8"?>
<operations>
    <clear>
        <category_tree />
        <product />
    </clear>
    <add>
        <product>
            <product_key>P001</product_key>
            <market>UK</market>
            <locale>en-GB</locale>
            <title>The Magical Programmer</title>
            <category>Movies</category>
            <variants>
                <variant>
                    <variant_key>V001</variant_key>
                    <format>DVD</format>
                    <price>£11.99</price>
                </variant>
                <variant>
                    <variant_key>V002</variant_key>
                    <format>Blueray</format>
                    <price>£13.99</price>
                </variant>
            </variants>
        </product>
    </add>
</operations>

cURL

#!/bin/bash
curl -i \
-X POST \
-d @products-full-import-w-variants.xml \
-H "Content-Type: application/xml" \
-H "Api-Key: {PRIVATE-KEY}" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/import/products?name=full-prod-import-w-variants"

Response

HTTP/1.1 204 No Content
×