Export data

Prerequisites and preparation

Permissions

To export data, the Administrators Team must grant you the following permissions for the Project:

• View all: Operations permission to access the export logs page and to download export files
• View all: Categories permission to export Categories
• View all: Customers permission to export Customers
• View all: Discount codes permission to export Discount Codes
• View all: Orders permission to export Orders
• View all: Products permission to export Products, Inventory, and Custom Objects

Use keys as identifiers

Keys are optional unique identifiers for resources in your Project, but they are required for exporting and importing. Before exporting, ensure that the resources to export and all related resources have keys. For example:

• When exporting Discount Codes, both the Discount Codes and the Cart Discounts they use should have keys.
• When exporting Products, the Products, their Product Variants, and Embedded Prices should have keys.

Resources without keys will be exported, but you will be unable to update their values by importing the exported file.

Improve performance

To speed up the export process and reduce the size of exported files, you should:

• Export a limited number of resources. Instead of exporting all the resources, you can filter or select specific resources to export.
• Select only the necessary locales and fields.
• Create multiple export files for large resources. For example, when exporting Products, create separate files for general fields, price fields, and asset fields.

If you intend to import the exported CSV file, the CSV file must be no larger than 35 MB and contain fewer than 80 000 rows.

Use a CSV template file to export

You can create a CSV template for a resource to control the structure of your exported data and streamline exports. To create a CSV template, you can export a file with the required fields for the resource, and then use it as a template for future exports.

Export Categories

1. Go to Categories > Categories search.

2. Click the Import / Export drop-down and select Export categories.

3. In the dialog, follow these steps:

   • Choose to export all Categories, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Export Customers

1. Go to Customers > Customer list.

2. Click the Import / Export drop-down and select Export customers.

3. In the dialog, follow these steps:

   • Choose to export all Customers, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Export Custom Objects

1. Go to Operations > Export.

2. Click Create new export.

3. In the Export data window, follow these steps:

   • For File name, enter a name for the file containing the export data.
   • For Query predicate, enter a condition to filter which Custom Objects to export. A Query Predicate is a filter that determines which objects are included in the export. For example, use container = "container-name" to only export Custom Objects with the matching container value.

4. Click Start export.

Export Discount Codes

1. Go to Discounts > Discount code list.

2. Click the Actions drop-down and select Export discount codes.

3. In the dialog, follow these steps:

   • Choose to export all Discount Codes, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Export Inventory

1. Go to Products > Product list.

2. Click the Actions drop-down and select Export inventories.

3. In the dialog, follow these steps:

   • Choose to export all Inventory entries, or only the ones associated with Products you have filtered or selected.

     You can only export up to 500 Inventory entries per Product Variant. Due to eventual consistency, updates made to Inventory entries just before the export may not be included.

   • For File format, choose to export the data as a CSV or JSON file.

   • For File name, enter a name for the file containing the export data.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Export Orders

1. Go to Orders > Order list.

2. Click the Import / Export drop-down and select Export orders.

3. In the dialog, follow these steps:

   • Choose to export all Orders, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.
   • To include the Order number, ID, and States in every row of the CSV file, select the checkbox. This will increase the size of the exported file, and the export task may also take longer to complete.

4. Click Continue.

5. Select the fields to be exported and click Start export.

Export Products

The exported CSV follows a hierarchical structure, where subitems (such as Variants and Prices) are nested under their parent items (like Products). The first subitem's values appear on the same row as the parent item, while each additional subitem is listed on a new row. By default, when a Product has multiple Variants or a Variant has multiple Prices, the parent item's values are listed only once in the row with the first subitem. Subsequent rows for the subitems will leave the parent item cells empty. If you prefer these cells to be filled for each row, you can configure the exporter to include Product- and Variant-level information. Please note that this will increase the size of the exported file, and the export may take longer to complete.

1. Go to Products > Product list.

2. Click the Actions drop-down and select Export products.

3. In the dialog, follow these steps:

   • Choose to export all Products, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.
   • To include Product- and Variant-level information in every row of the CSV file, select the checkbox.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Export Product Types

1. Go to Settings > Product types and attributes.

2. Click the Import product types drop-down and select Export product types.

3. In the dialog, follow these steps:

   • Choose to export all Product Types, or only the ones you have filtered or selected.
   • For File format, choose to export the data as a CSV or JSON file.
   • For File name, enter a name for the file containing the export data.

4. Click Step 2: Select content to export.

5. If you're exporting the data as a CSV file, you can select fields in the given list or select fields from an imported CSV.

6. For Locales, select the languages to export the data in. If you are using an imported CSV file to select the fields to export, you can choose to only export the locales specified in the fields within the CSV file.

7. Click Step 3: Confirm selection.

8. Preview the fields to export and click Start export.

Download the export files

The export operation is a background task. The time to complete the operation corresponds to the amount of data exported. If the data is large, the export can take longer. For quicker exports, you should export only the necessary resources, locales, and fields. To view the current status of your exports, and to download exported files, go to Operations > Export.

If several export operations are run within a short period, they will be queued to ensure smooth running of the export process. Queued exports are automatically processed in the order in which they were created.

View the export file

For CSV exports, the headers and values match those in the CSV import documentation:

• Categories
• Discount Codes
• Inventory
• Products
• Product Types

For JSON exports, the fields and types match those in the HTTP API documentation:

• Categories
• Customers
• Discount Codes
• Inventory
• Orders
• Products