Using standard formats

Use catalogue standard formats to export data from your PlentyONE System to a file. You can create export files in the formats CSV, JSON, TXT or XML. There are different standard format for exporting data. Not all types of data can currently be exported using catalogues. Until standard formats are available for all types of data, you can continue using the Formatdesigner.

This page is new and we always want to improve. Couldn’t find what you are looking for or do you think something could be explained better? Then let us know by using the feedback function at the bottom of this page. The more details you provide, the easier it is for us to improve this page.

1. Understanding the catalogue menu for default formats

When you open the menu Data » Catalogues, the first thing you see is the catalogue overview. You can get to know this catalogue overview here.

The catalogue menu for standard formats is what you see when you open a catalogue with standard format.

The catalogue menu is the same for all default formats:

menu structure standard format

Tip: Your catalogue still looks different? Then you probably opened a marketplace format. It is used to export item data to markets and price portals. Also useful and interesting. However, working with marketplace formats is described elsewhere.

When you open a catalogue, the view Data fields is shown by default. Use the navigation to switch to other views of the catalogue.

catalogue default navigation

Catalogues

Go back to the catalogue overview, that is to the list of catalogues.

List of opened catalogues

The navigation shows all catalogues that you accessed during your current session. This allows you to quickly switch between the catalogues you are currently working on. The catalogue that is currently on view is shown in blue. The names of the other catalogues are shown in grey.

Tip: If the list gets too long or you find it distracting, point your cursor to a catalogue in the list. An X is shown. Click on that X to close the catalogue.

Settings

Open the catalogue settings.

  • Basic settings = Name and format type of the catalogue. You enter this information to create a catalogue.

  • Format settings = Settings for the export file structure

  • Export settings = Settings for automatic export

  • Download settings = Settings for the URL that is used to access the export file

Data fields

Shown when you open the catalogue. In this view, you select the data fields that you want to export.

filter_alt Filter

Add filters to only export specific records.
Note: Filters are not available for all catalogues.

Tip: The number of filters that you activated for a catalogue is always shown. Template filters, i.e. filters that are applied by default, are not included in the count.

filters number of filters

Own data sources

Own data sources are currently not available for most exports.

The toolbar provides actions for the catalogue.

catalogue default toolbar

save Save

Saves the catalogue settings.

preview Preview

Creates a preview of the export data. The preview contains the first 5 data rows of the export file.

Important: The preview function is not available for all catalogue formats.

Asynchronous download

Starts a manual download of the catalogue data.

play_circle Live download

Downloads the catalogue data as a file. The download starts immediately. The file is automatically saved on your computer when the export is done.

playlist_play Status

Opens the menu Data » Catalogue export status and filters the list for this catalogue. Shows information about the status of the catalogue.

more_vert More

Shows additional actions.

history

Restores an earlier version of the catalogue. The last 100 versions of the catalogue are available.

How do I restore other catalogue versions?

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Alternative 1: In the catalogue overview

    1. In the row of the catalogue, open the further actions (more_vert).

    2. Click on Restore catalogue version (history).

  3. Alternative 2: In the catalogue menu

    1. Open the catalogue.

    2. In the toolbar, click on the additional actions ().

    3. Click on Restore catalogue version (history).

  4. In the window shown, select the version that you want to restore.
    Tip: The last 100 versions of the catalogue are available.

  5. Click on Restore.
    → The catalogue version is restored and displayed in the catalogue overview.

delete

Deletes the catalogue.

How do I delete a catalogue?

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. In the row of the catalogue that you want to delete, click on the further actions (more_vert).

  3. Click on Delete (delete).
    → You are asked to confirm your decision.

  4. Confirm the deletion.
    → The catalogue is deleted.
    Or: Open a catalogue.

  5. Click on the further actions (more_vert) at the top.

  6. Click on Delete catalogue (delete).
    → You are asked to confirm your decision.

  7. Confirm the deletion.
    → The catalogue is deleted.

To the right of the navigation, all PlentyONE data fields that you can export are listed in groups. To add a data field to the export, click on the Plus icon to the light of the data field.

catalogue default data fields

Tips:

  • Use the field Search data field to quickly find and add data fields.

  • In addition to the data fields listed, you can also add own values to the export. The same value is then exported for each record.

  • Add the option Formula to recalculate numerical values during the export. For example, you could update all exported variation prices during the export.

To the right, the data fields that you can add to the export are shown. So these data fields will be exported to your file. Before you select a data field, you can see the message “No data fields were selected”. In the screenshot, a few the fields are already selected.

catalogue default added fields

Tips:

  • You can move the data fields using drag-and-drop. This will change the order in which the data fields are exported.

  • You can change the export key. The “Export Keys” are the names of the column headers, as they will appear in your export file. Every “Export Key” needs to be unique.

  • You can add fallback data fields. If the data field is empty or invalid, the first fallback data field is checked and the value of that fallback data field is exported instead.

2. Creating catalogues

You’ve gained a first understanding of the catalogues. Now let’s get started: It’s time to create your first catalogue!

Creating a catalogue:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on Create catalogue (add).
    → A new view opens.

  3. Carry out the settings. Pay attention to the explanations given in Table 1.

  4. Save (save) the settings.
    → The catalogue is created.
    → The tab Settings (settings) opens.

Table 1. Creating a catalogue
Setting Explanation

Name
(mandatory)

Enter a name for the catalogue.

Export type
(mandatory)

Select the option Standard format.

Format type
(mandatory)

Select a format type from the drop-down list. Use the format type to specify which type of data is exported.
Available format types

Format
(mandatory)

Select a format from the drop-down list.
Note: There is currently just one format type for each format. So just select the one available option from the drop-down list.

3. Setting up catalogue export

Now, customise the catalogue to your individual needs. This is how the information in this chapter is structured:

3.1. Carrying out the format settings

The format settings are used to specify the file format in which the data is exported and how the export file is formatted.

Configuring the settings:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue.
    → The catalogue opens.

  3. In the navigation on the left, click on the tab Settings (settings).
    → The different settings options are shown.

  4. Navigate to the section Format settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 2.

  6. Save (save) the settings.

Table 2. Carrying out the format settings
Setting Explanation

File name

Enter a file name. The exported file is saved with this name.
Tip: The file extension is automatically added during the export. As such, enter the file name without a file extension. File extensions are for example .csv and .txt.

Tip: Use placeholders: Placeholders automatically add additional information to the file name during export.

List of available placeholders

The following placeholders are available:

$$name

The catalogue name is added to the file name.

$type

The export type is added to the file name.

$format

The format type is added to the file name.

$timestamp

The time stamp of the export is added to the file name.

$datetime

The date and time of the export is added to the file name.

$year

The year of the export is added to the file name.

$month

The month of the export is added to the file name.

$day

The day of the export is added to the file name.

$hour

The hour of the export is added to the file name.

$minute

The minute of the export is added to the file name.

$second

The second of the export is added to the file name.

$lastChangeTimestamp

The timestamp of when the catalogue was last changed is inserted into the file name.

$lastChangeDatetime

The date and time of when the catalogue was last changed is inserted into the file name.

$lastChangeYear

The year in which the catalogue was last changed is inserted into the file name.

$lastChangeMonth

The month in which the catalogue was last changed is inserted into the file name.

$lastChangeDay

The day on which the catalogue was last changed is inserted into the file name.

$lastChangeHour

The hour in which the catalogue was last changed is inserted into the file name.

$lastChangeMinute

The minute at which the catalogue was last changed is inserted into the file name.

$lastChangeSecond

The second at which the catalogue was last changed is inserted into the file name.

Examples for using placeholders:

Entry Result

item-export_$year_$month_$day

  • item-export_2022_01_02.csv

$type_$format_$year_$month_$day

  • order_order_2022_01_02.csv

    • check24_offer_2020_10_25.csv

Format

Select the file format for the export.

Possible values:

  • CSV

  • CSV - Array to JSON

  • JSON

  • TXT

  • XML

Field separator

Which field delimiter should separate the individual records from each other?

Possible values:

  • Comma = ,

  • Semicolon = ;

  • Pipe = |

  • Tabulator = ␉

Text delimiter

Which text delimiter should separate the individual records from each other?

Possible values:

  • "

  • '

Encode special characters ()

If you activate this option, unicode characters (e.g. umlauts: ä, ö, ü) will be exported in encrypted form.
Note: This option is only available for the formats JSON and CSV - Array to JSON.

Decimal separator

Select the character that is used for decimal values.

Possible values:

  • Comma = Default in German speaking countries
    Example: 20,00 Euro

  • Dot = Default in English speaking countries
    Example: 20.00 Euro

Line break

How do you want to handle line brakes in the export file?

Possible values:

  • Carriage return

  • Line feed

  • Carriage return an line feed

Header is included

Activate the option if you want the export file to contain a header line. The export keys are used as headings for the columns.

3.2. Carrying out the export settings for order items

The export settings for order items are only available for catalogues of the export type Order. The export settings for order items determine whether order items should be skipped in the export file.

Carrying out the export settings for order items:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue for which you want to carry out the export settings.
    → The catalogue opens.

  3. In the navigation on the left, click on the tab Settings (settings).
    → The different settings options are shown.

  4. Navigate to the section Export settings for order items.

  5. Carry out the settings. Pay attention to the explanations given in Table 3.

  6. Save (save) the settings.

Table 3. Carrying out the export settings for order items
Setting Explanation

Skip order items

Do you want to skip order items during export?

Do not skip

No order items are skipped during export.

Skip if quantity is greater than 0

Order items whose quantity is greater than 0 are skipped during export.

Skip if quantity is 0

Order items whose quantity is 0 are skipped during export.

3.3. Carrying out the export settings

The export settings determine where your export file is saved.

Carrying out the export settings:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue for which you want to carry out the export settings.
    → The catalogue opens.

  3. In the navigation on the left, click on the tab Settings (settings).
    → The different settings options are shown.

  4. Navigate to the section Export settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 4.

  6. Save (save) the settings.

Table 4. Carrying out the export settings
Setting Explanation

Limit

Do you want to limit the number of records that is exported?

Provisioning

Where do you want to save the export?
Important: This setting does not export data to markets.

None

The export is not saved.

FTP

The export is saved on an FTP server.

SFTP

The export is saved on an SFTP server.

FTPS

The export is saved on an FTPS server.

Server
(for FTP, SFTP, FTPS)

Enter the server where you want to save the export.
Recommendation: Do not enter al protocol prefix. Some examples for protocol prefixes are ftp:// and ftps://.

Port
(for FTP, SFTP, FTPS)

Enter a port or use the default setting.

Recommended port settings:

  • For FTP and FTPS = Port 21

  • For SFTP = Port 22

User name
(for FTP, SFTP, FTPS)

Enter the user name for the server.

Password
(for FTP, SFTP, FTPS)

Enter the password for the server.

Path
(for FTP, SFTP, FTPS)

Where should the export be saved? Enter the path to a storage location.
Note: If you use SFTP, enter the complete path.

Test connection
(for FTP, SFTP, FTPS)

Tests the server settings that you entered:

  • Can PlentyONE connect to the server?

  • Can an export file be saved at the storage location?

Tip: A test file is saved at the storage location. This test file is called plentymarkets_ConnectionTestFile.txt.

Transfer

When do you want to start the export?

Never

No data is exported.

Every 20 minutes;
Once per hour;
Once per day

Current data is exported in the selected interval.

Schedule: times

The option Schedule: times is shown.

Schedule: times
(for option Schedule)

Click into the field. In the drop-down list shown, select one or more points in time. The export starts at these times.

Weekdays
(for Transfer ≠ Never)

By default, all weekdays are selected. To deactivate exports for specific days of the week:

  1. Click in the field Weekdays.
    → A drop-down list with weekdays is shown.

  2. Uncheck the checkbox for one or more weekdays (icon:check_box_outline_blank).
    → Exports are only started on weekdays with a check mark ().

Tip: The setting Weekdays is only shown if you select an interval or schedule for the setting Transfer.

3.4. Setting up the download

In the Download settings of the catalogue you can generate a URL. This URL gives you direct access to the export file.

  • The admin link only allows you to access the exported file if you are currently logged into your PlentyONE System as an admin.

  • You can protect public links from inappropriate access by adding a version and/or token.

The catalogue must be active to create an export file. The export file can only be accessed after the first export.

Setting up the download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Select the catalogue.
    → The catalogue opens.

  3. In the navigation on the left, click on Settings (settings).

  4. Navigate to the area Download settings.

  5. Carry out the settings. Pay attention to the explanations given in Table 5.

  6. Save the settings.
    → The URL for downloading the file is shown. The export can be accessed using this URL after the first export is completed.
    → The menu always shows the URL of the last exported file.

  7. Click on the URL or copy the URL (content_copy) to use it.

Table 5. Generate URL
Setting Explanation

Shop URL

Select a client. The domain name of this client is used for the URL.

Receive notifications

Activate to get a notification at the top right of the system once the export is completed.

catalogue export

Options for admin link

Use version

Select whether a version should be used.

No version is used.

Every time you make a change to the catalogue, a new URL with a version key is created. As such, the version represents all settings that are relevant for the catalogue export. If these settings change, the version changes and all future URL will include the new version. Older URL will be valid for 15 days from the last export with that version.
Tip: Do not activate this option if you always want to access the most current export file using the same URL.

Options for admin link

Admin link

An admin link is automatically created for each file. This admin link only allows you to access the exported file if you are currently logged into your PlentyONE System as an admin.

Tip: Click on the icon to the right (content_copy) to copy the URL to your clipboard.

Options for public link

Activate options

No public link is created. The options Use version and Use token cannot be selected.

A public link is created. After the first export, the file can be accessed by anyone who knows this link.

Tip: In the row Public link, click on the icon to the very right (content_copy) to copy the URL to your clipboard.

Use version

Select whether a version should be used.

No version is used.

Every time you make a change to the catalogue, a new URL with a version key is created. As such, the version represents all settings that are relevant for the catalogue export. If these settings change, the version changes and all future URL will include the new version. Older URL will be valid for 15 days from the last export with that version.
Tip: Do not activate this option if you always want to access the most current export file using the same URL.

Use token

No token is generated.

A token is added to the download URL. The file is then only accessible if the token is known.

Security token

Click on the symbol on the right () to generate a new token.

Tip: The token is added to the URL of the public link. So when you copy the URL, you copy the token at the same time. When you generate a new token, the URL also changes.

Public link

Shows the public link. After the first export, the file can be accessed by anyone who knows this link.

Tip: In the row Public link, click on the icon to the very right (content_copy) to copy the URL to your clipboard.

4. Selecting data for export

Now decide what PlentyONE data you want to export with this catalogue.

This is how the information in this chapter is structured:

4.1. Adding data fields to export

Now it’s time to decide which PlentyONE data field data fields you want to export from PlentyONE with this catalogue. To do so, add the data fields to the export as described below.

You can also use more complex export features:

Adding data field to the export:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Click on the catalogue.
    → The view Data fields () of the catalogue opens.
    → The available PlentyONE data fields are listed in groups. In addition, the options Own value and calculate Formula are shown.

  3. Expand a data field group to see the list of data fields in that group.

  4. Click on the plus icon next to the data field that you want to export.
    Tip: Alternatively, enter the name of the data field into the search field. Select the data field from the search results.
    → The data field is added to the export.

  5. Check if the export key suits your needs.
    What is an export key and how should it be structured?
    The Export Key is the name of the column header that will be shown in your export file.

    • Each export key can only be used once in this catalogue.
      Important: If several data fields have the same export key, only one data field is exported.

    • Export keys cannot contain any spaces.

    • If the export key contains a dot, the data is exported in a tree structure. In most cases, this means that the data is not exported as expected. As such, we recommend that you do not use dots in export key names.

  6. Add all data fields that you want to export.

  7. Save (save) the settings.
    → The data fields are exported with this catalogue.
    Tip: You can also use more complex export features. Curious? Then expand the info boxes underneath this description.

Optional: Export a different data field if the first data field is empty (Add fallback data field)

Fallback data fields are used like this:

  • I want the first PlentyONE data field to be exported.

  • If this data field is empty or invalid for a record, the first fallback data field is checked and the value of that fallback data field is exported instead.

  • If the first fallback data field is also empty or invalid, the second fallback data field is checked and the value of that fallback data field is exported instead and so on.

Adding fallback data fields:

  • Initial situation:
    → You added a data field to the export. For this data field, you want to specify an alternative in case the data field is empty or invalid for one or more records.

    1. Below the data fields, click on + Add fallback data field.
      → The editing mode opens.

    2. On the right, click on a group to expand the associated PlentyONE data fields.
      → The PlentyONE data fields are shown.

    3. Click on the plus to the right of the PlentyONE data field you want to select.
      → The PlentyONE data field is added as a fallback data field to the field on the right.
      → The fallback data field is exported when the first data field does not exist or is empty.

Note the following logic for fallback data fields:

  • Even if you assign one or more fallback data fields, the value of only one field is exported.

  • For each record, the PlentyONE data fields are checked in the order in which you mapped them. This means that if the first data field does not provide a value, the first fallback data field is exported etc.

  • Tip: You can also add Own value as a fallback data field.

The following GIF shows the standard format Manufacturer. The data field Manufacturer > External name is to be exported. However, if no external name is saved for one or more manufacturers, you want to export the Internal name instead.

gif standardformats fallback
Optional: Export the same value for every record (Own value)

The data field Own value is used like this:

  • For a column of your export file, the same value is exported for all records of the catalogue.

Exporting an own value:

  1. In the list of the data fields, click on Own value.
    → The data field for an own value is added to the export.

  2. Check the export key. Own values are automatically assigned the export key own-value. As such, make sure that you adjust the export key, especially when you want to export more than one own value.
    Important: If several data fields have the same export key, only one data field is exported.

  3. Enter a value into the input field Value.
    → This value is exported for all records.

The following GIF shows the standard format Stocks.

  • You want the export file to include a column with your company name.

gif standardformats own value

Result in the export file:

  • Every exported record has a cell that contains your company name:

result export companyname
Optional: Combining several data fields

When you combine data fields, the following logic is applied:

  • The data fields are to be combined during the export.

  • The values of the data fields are added to the same column of the export file.

  • The character between the values is specified with the option Separator.

Combining data fields:

  • Initial situation:
    You already added a data field to the export. You want to combine this data field with another data field.

    1. Next to the marketplace data field, click on + Add data field ().
      → The editing mode opens.

    2. Click on the plus to the right of the data field you want to select.
      → The data field is added to the right of the first data field.

    3. Click on Confirm.

    4. To the right of the column, click on Settings ().

    5. Select a separator from the drop-down list Separator or specify a custom separator.

    6. Click on Save.

    7. Save () the catalogue.
      → The settings are saved.
      The content of these data fields is combined in the same column.

The following GIF shows the standard format Manufacturer.

  • Instead of exporting the data fields Street and House number in two separate columns, these data fields are combined into one column.

  • Select a space as the separator.

gif standardformats combination

Result in the export file:

result export street
Optional: Recalculating numerical values (Formula)

Mathematical calculations allow you to change numerical values automatically during the export.

  • The preview function is not available for all catalogue formats.

  • This function only works for data fields that contain numerical values.

Recalculating numerical values:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.
    → The tab Data fields opens.

  3. In the list of data fields, click on the plus next to Formula (calculate).
    → The field Formula is added to the view on the right.

  4. Click on the field Formula.
    → The Modify value window opens.

  5. Select a decimal separator from the drop-down list.

  6. At the bottom right of the window, select a data field to add it to the calculation (add).
    Tip: Use the search function. This helps you to find data fields quickly.
    → The data field is added to the calculation.

  7. Optional: If the symbol more_vert is shown in the data field, select the correct assignment for the data field.
    Tip: A number tells you how many assignments are necessary for the data field.

    1. Click on the icon more_vert.

    2. In the window shown, select the assignments from the drop-down list.

    3. Save the settings.

  8. Enter numbers and mathematical operators with the on-screen calculator or the keyboard.

  9. Save the settings.
    → The entered formula is displayed in the overview.
    Tip: If a preview is available for the format, check the result by using the preview function (preview).
    → The calculation will be carried out in the next export.

Optional: Changing the order of data fields

In the export file, the data fields are sorted in the same order as in the catalogue list. As such, the first column of a CSV file contains the data of the data field that is at the very top of the catalogue and so on.

To change the order of data in the export file, you can either move individual data fields or whole rows:

  • To move a single data field:

    • Point your mouse at the data field and drag and drop it to the new position.

  • To move a whole column:

    • Click on the symbol (drag_indicator) on the left side and drag and drop the row to the new position.

4.2. Removing data fields from export

In the Mapping tab of a catalogue with a standard format you can remove individual or several data fields at once.

Removing data fields from export:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open a catalogue with standard format.
    → The tab Data fields () with all available data fields opens.

  3. Click on the further actions (more_vert) on the right of the data field that you want to remove.

  4. Click on Delete data field (delete).
    → The data field is removed.
    Or: If you want to remove a complete row, click on Delete data row (delete) on the right.
    → The complete row is removed.
    Or: Tick the box on the left for all rows containing data fields that you want to remove. Then, click on Delete selected data fields (delete) at the top right.
    → All selected data fields are removed.

4.3. Filtering export data

You can use filters to limit the data that should be exported.

Adding a filter:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the navigation on the left, click on Filters (filter_alt).
    → The filter overview opens.

  4. Select a filter from the drop-down list.
    Tip: Different filters are available for different standard formats. You can find descriptions of the individual filters here:

  5. On the right, click on Add filter (add).
    → The filter is added.

  6. If an operator is available for this filter:

    • Select an operator from the drop-down list.

    • Enter a value into field next to it.

  7. Save (save) the settings.
    → The filter is saved.

  8. Add additional filters as necessary.
    → Only data that meets the filter criteria is exported.

5. Exporting catalogue data

There are several ways to export the catalogue data:

5.1. Creating an export preview

After you have selected data fields for export, you can test the catalogue export using the preview function. This preview function allows you to download the first 5 data rows of the export.

  • A preview function is not available for all catalogue formats.

  • Create a preview in the catalogue

  • Create a preview from the catalogue list

Creating a preview in the catalogue:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the toolbar at the top, click on Preview (preview).
    → A preview of the first 5 data rows of the export is shown in the Preview window.

  4. Check the data. Does the export work as expected?

  5. Optional: Click on Download data (file_download).
    → You can save a file with the first 5 data rows on your computer.

You can also create a preview from the list of catalogues.

Creating a preview from the catalogue list:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Navigate to the catalogue.

  3. Open the further actions () of the catalogue.

  4. Click on Preview (preview).
    → A preview of the first 5 data rows of the export is shown in the Preview window.

  5. Check the data. Does the export work as expected?

  6. Optional: Click on Download data (file_download).
    → You can save a file with the first 5 data rows on your computer.

5.2. Activating automatic catalogue export

You have added all data fields that you want to export? Then activate the export now.

  • Make sure that you have carried out all necessary export settings. Otherwise, no data is exported.

Activating automatic catalogue export:

  1. Go to Data » Catalogues.
    → The catalogues are listed.

  2. Scroll to the catalogue.

  3. In the column Active, move the toggle button () to the right.
    → The catalogue is active.
    → The data is exported to the storage location and at the intervals you selected in the catalogue settings.

5.3. Starting a manual export

Have you added at least one data field to the export? Then start a manual export of the export. The format in which the data is exported depends on the format settings of the catalogue. You can export data in CSV, TXT, JSON and XML files.

Have you added at least one data field to the export? Then download the catalogue data manually. The format of the download file depends on the format settings of the catalogue. You can export data in CSV, TXT, JSON and XML files.

There are two ways to manually export the catalogue data:

Asynchronous download

The export runs in the background. Once the download is completed, you download the export file from the Notifications (notifications).

Live download

The file is downloaded to your computer automatically. You can follow the export progress in real time.
However:

  • Do not close or reload the browser tab or the PlentyONE tab Data export while the export is in progress. If you do so, the export will be cancelled.

  • The import can run into a timeout if you try to import large amounts of data. If that happens, the download is cancelled. For lots of data or if a timeout occurs, use the asynchronous download instead.

  • Starting an asynchronous download

  • Starting a live download

For asynchronous downloads, the export runs in the background. So note that there will be no window for downloading the file straight away. Even exporting small amounts of data will take around 30 minutes. When the export is completed, you can download the export file from the Notifications (notifications).

Starting an asynchronous download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the toolbar at the top, click on Download data (file_download).
    Or: Even quicker: Start the download from the Additional actions (more_vert) in the catalogue overview.
    → The export starts.
    Important: The export runs in the background. Note that there will be no window for downloading the file straight away. Even exporting small amounts of data will take around 30 minutes.
    Once the export is finished, you will be notified (notifications_none) that the export file can be downloaded.

  4. In the notification centre, click on link Download.
    Tip: The notification is no longer shown? Use the URL shown in the Download settings to access the file at any time.

  5. Save the file on your computer.

catalogue export

The live download creates the file and automatically downloads it to your computer. In the tab Data export, you can follow the download progress in real time. However:

  • When you start the live download, a new browser tab opens. In this browser tab, the PlentyONE tab Data export is shown. Do not close or reload the browser tab and the PlentyONE tab Data export while the export is in progress. If you do, the export stops and is cancelled.

  • You can start live downloads for several catalogues at the same time. However, you can only start a new live download for the same catalogue once the current export is complete.

  • The import can run into a timeout if you try to import large amounts of data. If that happens, the download is cancelled. For lots of data or if a timeout occurs, use the asynchronous download instead.

Starting a live download:

  1. Go to Data » Catalogues.
    → The catalogue overview opens.

  2. Open the catalogue.

  3. In the toolbar at the top, click on Live download (play_circle_outline).
    Or: Even quicker: Start the download from the Additional actions (more_vert) in the catalogue overview.
    → A new browser tab opens. PlentyONE and the tab Data export are shown.
    No new tab? Then you are probably using a pop-up blocker. Allow pop-ups for your system to continue.
    → The export starts.
    Important: Do not close or reload the browser tab or the PlentyONE tab Data export while the export is in progress. If you do, the export stops and is cancelled.
    → The progress is shown in real time.
    → The file is automatically saved on your computer when the export is done.

Stopping a live download

Do you want to stop a live download? No problem:

  • In the tab Data export, click on Cancel export (highlight_off) at the top right.
    → The download is stopped.
    Important: The download cannot be restarted. If necessary, start a new download.

6. FAQ: Questions and answers

Remind me: which catalogue format do I need for which export?
What does “Export Key” mean?

The “Export Keys” are the names of the column headers, as they will appear in your export file. Every “Export Key” needs to be unique.

  • Negative example: You use the data sources Item ID and Variation ID. You give both “Export Keys” the name “id”. As a result, the export file only includes one of the two IDs. A column is missing in the export file.

  • Positive example: You use the data sources Item ID and Variation ID. You give one “Export Key” the name “VariationID” and the other “ItemID”.

catalogue export keys
How should an export key be structured?
The Export Key is the name of the column header that will be shown in your export file.

  • Each export key can only be used once in each catalogue.
    Important: If several data fields have the same export key, only one data field is exported.

  • Export keys cannot contain any spaces.

  • If the export key contains a dot, the data is exported in a tree structure. In most cases, this means that the data is not exported as expected. As such, we recommend that you do not use dots in export key names.

My export file is missing a column. Why?

You might have data sources with the same “Export Key”. Every “Export Key” needs to be unique.

  • Negative example: You use the data sources Item ID and Variation ID. You give both “Export Keys” the name “id”. As a result, the export file only includes one of the two IDs. A column is missing in the export file.

  • Positive example: You use the data sources Item ID and Variation ID. You give one “Export Key” the name “VariationID” and the other “ItemID”.

catalogue export keys
Only the word “Array” is exported. Why?

If you export a file in CSV or TXT format, then you might only see the word "Array" instead of the actual export values. This happens e.g. when exporting multiple images or when exporting multi-selection properties. This is a known issue and it will be fixed in the future.

Possible workaround 1: Would it be an option for you to download a JSON or XML file instead? With these file types, you can see the actual export values.

  1. Click on Settings.

  2. Scroll down to the section Format settings.

  3. Select CSV - Array to JSON, JSON or XML from the drop-down list Format.

  4. Save () the settings and download the file (file_download).

    • Caution: If you want to revise the file and import it again. Note that the import tool only accepts the file types CSV and TXT.

Possible workaround 2: Export the data with the tools FormatDesigner and Elastic Export instead.

Can I revise the file and import it again?

Yes. Export the file in CSV or TXT format. Then revise the file and import it again. Note that the import tool only accepts the file types CSV and TXT.

No file is available through the catalogue’s download URL. Why?

  1. Is the catalogue active?

  2. Has an export taken place? Check the export settings.

  3. Did you use the right URL?

The download URL leads to the message "Unauthenticated." instead of to file. Why?

You used the admin URL. However, you are not logged into your PlentyONE system as an admin user.

  1. Log in as an admin user.

  2. Generate a public URL. The file can always be accessed with this URL.

Why can I not see the catalogues?

Users with back end access rights can only see catalogues if an admin gave them access.

  1. Find someone who has administrator rights for the PlentyONE system.

  2. This person will open the menu Setup » Settings » User » Rights » User.

  3. Then they will open your user account and activate the necessary rights:

    • Data > Data exchange > Export > Catalogue > Show

  4. Save () the settings.

  5. If the problem persists, ask our support team for help in the forum.

I want to import, export, delete, copy or restore catalogues. How do I do that?

No problem: