Import Export API

The Import/Export API is made up of a pair of REST endpoints that are exposed on the Elastic Path Integration Server. These endpoints allow data to be exported from the system or imported into the system using standard Import/Export XML formats.

All Integration Server endpoints, including these APIs, are secured with HTTP Basic Authentication. The credentials are the same as the username and password in Commerce Manager for an existing user.

Export Endpoint

The following endpoint returns an XML document containing data from Elastic Path for the requested data type:

GET integration/api/importexport/export

For more information, see Exports.

Import Endpoint

The following endpoint accepts an XML document containing data to be imported into Elastic Path:

POST integration/api/importexport/import

For more information, see Imports.

Manual Testing

Use the following steps to manually test the Import/Export API with Elastic Path’s Postman collection:

1. Download the Import/Export API Postman Collection.
2. Download and install Postman.
3. Start the Postman client.
4. In the upper-left corner, click Import.
5. Select the postman-import-export-api.json that you downloaded in step 1.

Exports

1. In the Import/Export API collection, click the Export node.

2. Update the URL to match the location of your Integration Server.

   note

   The URL defaults to http://localhost:8083 which is correct if you start the Integration Server locally.

3. Click the Params tab.

4. Update the query and type parameters as required.

   For more information, see Exports.

5. Click Send.

Imports

1. In the Import/Export API collection, click the Import node.

2. Update the URL to match the location of your Integration Server.

   note

   The URL defaults to http://localhost:8083 which is correct if you start the Integration Server locally.

3. Click the Body tab.

4. Paste the Import/Export XML that you want to import.

   For more information, see Imports.

5. Click Send.