Imports

Endpoint Details

Use the following import endpoint to insert or update data in Import/Export XML format: POST integration/api/importexport/import.

HTTP statuses

If the operation is successful, the API returns a 200 HTTP status with a summary in XML format.

If the operation fails due to a business validation issue, the API returns a 400 HTTP status with a text-based message describing the issue.

If the operation fails due to an unexpected issue, the API returns a 500 HTTP status with the stack trace.

Endpoint parameters

The following query parameters are supported:

Parameter	Required/Optional	Description
changesetGuid	Optional	The GUID of a changeset to populate when inserting or updating the objects. The changeset must already exist in the database and be in the OPEN state.
configuration	Optional	Override the import configuration that controls the import strategy for each object (INSERT vs INSERT_OR_UPDATE) and for each dependent element (CLEAR_COLLECTION vs RETAIN_COLLECTION). By default, this configuration is defined within importconfiguration.xml, but if this parameter is specified, then ${configuration}-importconfiguration.xml will be used. These import configuration files must be defined in advance and placed in the extensions/importexport/ext-importexport-api/src/main/resources folder.

Sample request

POST integration/api/importexport/import?changeSetGuid=865223FE-4B81-6971-ED99-0BE65A82C8C2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<stores>
    <store code="mobee" enabled="true">
        <globalization timeZone="Europe/London" country="CA" sub_country="BC" content_encoding="UTF-8" default_locale="en" default_currency="CAD"/>
        <url>https://mobee.elasticpath.com/storefront</url>
        <name>Mobee</name>
        <state>200</state>
        <type>B2B</type>
        <description></description>
        <catalog>Mobile</catalog>
        <display_out_of_stock>true</display_out_of_stock>
        <email_sender_name>CustomerService@elasticpath.com</email_sender_name>
        <email_sender_address>CustomerService@elasticpath.com</email_sender_address>
        <store_admin_email>StoreAdmin@elasticpath.com</store_admin_email>
        <credit_card_cvv2_enabled>true</credit_card_cvv2_enabled>
        <store_full_credit_cards>false</store_full_credit_cards>
        <locales>
            <locale>en</locale>
            <locale>fr</locale>
            <locale>fr_CA</locale>
        </locales>
        <currencies>
            <currency>CAD</currency>
            <currency>EUR</currency>
        </currencies>
        <warehouses>
            <warehouse>MOBEE_Warehouse</warehouse>
        </warehouses>
        <tax_codes>
            <guid>500</guid>
            <guid>501</guid>
            <guid>502</guid>
        </tax_codes>
        <tax_jurisdictions>
            <jurisdiction>CATaxJurisdiction</jurisdiction>
            <jurisdiction>GBTaxJurisdiction</jurisdiction>
            <jurisdiction>USTaxJurisdiction</jurisdiction>
        </tax_jurisdictions>
        <payment_provider_configurations>
            <payment_provider_configuration_guid>happy-path-payment-provider-config</payment_provider_configuration_guid>
        </payment_provider_configurations>
        <credit_card_types>
            <type>American Express</type>
            <type>Diners Club</type>
            <type>Discover</type>
            <type>MasterCard</type>
            <type>Visa</type>
        </credit_card_types>
        <cart_types>
            <cart_type>
                <name>SHOPPING_CART</name>
                <guid>5364a6ef-5f8e-4ea0-ac40-54e6fff10ec0</guid>
                <modifiergroups>
                    <code>multicart</code>
                </modifiergroups>
            </cart_type>
            <cart_type>
                <name>default</name>
                <guid>5364a6ef-5f8e-4ea0-ac40-54e6fff10ec0</guid>
                <modifiergroups>
                    <code>multicart</code>
                </modifiergroups>
            </cart_type>
        </cart_types>
    </store>
</stores>

Sample response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<summary>
    <failures/>
    <warnings>
        <message>
            <code>IE-31014</code>
            <params>
                <param>StoreDTO</param>
            </params>
            <message>Object of type StoreDTO is not supported by change sets.</message>
        </message>
    </warnings>
    <comments/>
    <objectCounters>
        <entry>
            <jobType>STORE</jobType>
            <counter>1</counter>
        </entry>
    </objectCounters>
</summary>