Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  • Import data
  • Starting the import
  • Mapping your data
  • Map data from file
  • Approve changes
  1. Tutorials
  2. Helpful guides
  3. How to use Import

How to import data into a list property on entities

PreviousHow to import productsNextHow to import categories

Last updated 23 hours ago

Import data

In a previous tutorial, , we imported a collection of jackets. This time around we want to populate a List property on these with new data.

To do this we will be using the excel spreadsheet shown below. The first line contains the headers ProductName, Color, Color Area and Writing which will be used to map to the and List property.

Starting the import

To start importing you choose the excel spreadsheet with the data you want to import, in this tutorial the spreadsheet is called "ColorListImportForJackets.xlsx".

While it is possible to include media assets when importing, this will not be covered in this guide. For this reason we leave 'Upload assets' untoggled.

Having chosen the correct file and import type you can click the "Start upload"-button to start the import.

Mapping your data

Having clicked the "Start upload"-button you are presented with a new page. This is where you will map your excel columns to data fields on entities.

You will need to choose the correct Entity type; Categories, Products, Variants or Variant groups.

Now you have to choose the import action, you can choose between:

  • Replace - Replace all rows with the rows in your file

  • Upsert - Update existing rows in the data or add new ones that are not already there

  • Delete matches - Delete rows that match the selected row key(s) (No rows are updated or added)

In this tutorial we want to add new ones from our file, so we choose 'Upsert'.

It is possible to add extra keys if needed.

Map data from file

Finally the 'Map data from file' field is where you map your list data.

As we have chosen the import action 'Upsert', we need to choose the columns to use for matching existing rows. In this tutorial we choose that 'Color' and 'Color Area' together is the key, so we choose them as our row keys.

What this means in practice is that, if another row in the list contains the same value for Color and Color Area as a row in the excel spreadsheet, this row will be updated with a new value in the Writing property.

Approve changes

Having reviewed the changes you can choose to approve the changes you are satisfied with. Only approved records will be commited.

When you have approved the records you want to keep, click the "Commit Import"-button in the bottom-right corner to finalize the import.

Next you need to choose the correct Import type. When importing data into list properties on , , variant groups or the 'List property import' type is used.

In this guide we are importing data into List properties on , so we choose 'Products' in the 'Entity type' dropdown, but the process for all entities are almost entirely similar from here.

Choose the List you are importing data into, in this tutorial we are importing data into 'Design'.

For List attribute key(s) you need to choose the column(s) in the excel spreadsheet which is used to identify the each row in the sheet maps to. In this tutorial we map from the 'ProductName' column to the 'ProductName' data field.

In this tutorial we have three column, each corresponding to an attribute in a complex list .

At this point you are shown a 'Review changes'-page. This page will show you the amount of new and updated list .

Subattributes that will be changed are colored green to easily distinguish between that will remain the same and that will change.

products
variants
categories
products
attribute
product
attribute
attributes
attributes
attributes
How to import products
products
product
Excel spreadsheet with headers and data
Import page
Data mapping