OBI Channel Layer Integration (open beta)

OBI is a German home improvement retail chain that was founded in 1970. Since the opening of the first OBI store in Hamburg, OBI now operates more than 640 stores in 10 European countries and offers over 100,000 products for gardening, building and do-it-yourself projects.

Open beta test phase

The OBI integration is currently in the open beta test phase. This means that interested customers are welcome to register for the beta test phase.

1. Requirements for the beta test phase

To participate in the beta test phase, you must already be registered as a seller on OBI.

2. Register with OBI for the beta test phase

Register with OBI for the beta test phase. If you fulfil the criteria for the beta test phase, you receive your login details from OBI. You need these login details to set up OBI in PlentyONE.

3. Frequency of data exchange

After you have set up OBI in PlentyONE, data is exchanged with the market in the intervals described in Table 1:

Table 1. Frequency of data exchange
Data Interval

Offer update

hourly

Stock synchronisation

every 15 minutes
Note: During stock synchronisation, the stock of all offers is transferred with each run.

Price synchronisation

every 15 minutes

Order import

every 15 minutes
Note: During order import, all orders from the last 24 hours are imported if they have not already been imported.

4. Setting up the data exchange

In order for the interface to successfully carry out the item export, the order import and the stock synchronisation, certain settings are mandatory. Pay attention to the following list.

Table 2. Mandatory settings for OBI
Settings section Settings

Stock synchronisation / Price synchronisation

Basic settings for the sales channel

  • An account for OBI is created.

  • The following channel settings for OBI are carried out:

    • Client ID is entered.

    • Client secret is entered.

  • The account is activated.

Catalogue settings

Listing settings

  • An offer listing is created.

  • The listing is activated.

  • The listing contains at least one variation.

Variation settings

  • The variation in the listing is active.

  • An SKU is set.

Order import

Basic settings for the sales channel

  • The following channel settings for OBI are carried out:

    • Client ID is entered.

    • Client secret is entered.

    • If you want to import cancellations that the buyer has requested directly at OBI:

      • Subscribe notifications is activated.

    • If you want to import returns that the buyer has requested directly at OBI:

      • Subscribe notifications is activated.

      • The return reasons have been mapped.

Variation settings for single items

  • The variation is active.

  • An SKU is set.

5. Workflow of an order

  • Your items are listed on OBI.

  • Customers place an order on OBI.

  • Customers make their payments to OBI.

  • The order is imported into PlentyONE.

  • The order is shipped.

  • The shipping confirmation must be sent to OBI by event procedure.

5.1. Workflow of a cancellation

  • Your items are listed on OBI.

  • Customers place an order on OBI.

  • Customers make their payments to OBI.

  • The order is imported into PlentyONE.

  • Customers can cancel the order as long as it has not been shipped.
    Note: Customers can only cancel the entire order. Partial cancellations are only possible for delivery orders and by the seller.

  • The cancellation is imported into PlentyONE.
    Note: To import cancellations that the buyer has requested directly at OBI, you have to activate the option Subscribe notifications in the channel settings.

  • You must ensure that the item or order is not shipped.

  • No further action is required on your part.

5.2. Workflow of a return

  • Your items are listed on OBI.

  • Customers place an order on OBI.

  • Customers make their payments to OBI.

  • The order is imported into PlentyONE.

  • The order is shipped.

  • The shipping confirmation must be sent to OBI by event procedure.

  • Customers can return the entire order or individual items.

  • The return is imported into PlentyONE.
    Note: To import returns that the buyer has requested directly at OBI, you have to activate the option Subscribe notifications in the channel settings and map the return reasons from OBI.

  • You must provide the customer with a return label or coordinate the return via email.

  • Customers send the return to you.

  • Once you have received the return, the return must be reported to OBI by event procedure.

  • With the event procedure, the return request is sent to OBI.

  • The refund is initiated.

6. Setting up OBI in PlentyONE

Use the Client ID and Client secret you received from OBI to set up the sales channel in PlentyONE. To do so, proceed as described below.

6.1. Creating an account

In the Sales Channels » Accounts menu, create an account for OBI.

Note: Only one account per user can be created for OBI. Once you have created an OBI account, the button Add account (add) will be disabled.
Once created, the OBI account cannot be deleted. But you can edit the account details at any time. If you no longer need the OBI account, you can remove your login details instead of deleting the account.

Creating an account:

  1. Open the Sales Channels » Accounts menu.

  2. Click on Create account (add).
    → The window Create account opens.

  3. Select OBI from the drop-down list Platform.

  4. Select the Client (Shop) from the drop-down list.

  5. Enter a name for the account.

  6. Click on add CREATE.
    → The account for OBI is created.

6.2. Account overview

In the Sales Channels » Accounts menu, you can create your OBI account. In addition, you can find an overview of the account here.

Table 3 contains an overview of the accounts in the Sales Channels » Accounts menu.

Table 3. Accounts in the Sales Channels » Accounts menu.
Setting Explanation

bigtop_updates Connection

Connection status of the account.
Accounts can have the following connection statuses:

  • Connected (bigtop_updates) = The account is connected to the sales channel.

  • Disconnected (signal_disconnected) = The account is not connected to the sales channel.
    Note: If the account is Disconnected, this may be due to missing or incorrect basic settings for the sales channel.

Name

Account name.

more_vert More

Click here to display more actions.

settings Account settings

Open the account settings.

error Errors

Open errors for Product listings oder Offer listings. The number of errors for the product listings or offer listings for this account is shown in brackets.

list Product listings

Open the overview of product listings for this account.

toggle_off Activate account

Activate the account.

delete Delete account

Delete the account.

Listings online

Hover over Listings online to see the number of product listings and offer listings that are listed on sales channels for this account.

Errors

Hover over Errors to see the number of errors that occurred for product listings and offer listings.

6.3. Carrying out channel settings

After you have created the account for OBI, you can carry out the settings for the account.

Carrying out the channel settings for OBI:

  1. Open the Sales Channels » Accounts menu.

  2. Click on the OBI tile.
    → A view with channel settings for OBI opens.

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

  4. Save () the settings.

Note: To activate the data exchange with OBI, the account must be activated.

Table 4. Channel settings for OBI
Setting Explanation

General

Client ID

Enter the client ID that you received from OBI.

Client secret

Enter the client secret (password) that you received from OBI.

toggle_off Subscribe notifications

Activate this option to retrieve cancellations and returns from OBI.

Note: The subscription to notifications is only active when you have entered your client ID and your client secret.

Orders

Status for cancelled orders

Select the order status for orders that were cancelled.

Note: The default status of the system is used as standard setting. You can also set a specific OBI cancellation status.

Status for returns

Select the order status for orders that were returned.

Note: The default status of the system is used as standard setting. You can also set a specific OBI return status.

Map return reasons

Map each OBI return reason to a PlentyONE return reason from the drop-down list. Returns can only be imported if a return reason has been mapped.

Tip: You can save return reasons in the menu Setup » Orders » Order types » Return.

OBI currently has the following reasons for return:

  • Gefällt nicht (Do not like the item)

  • Artikel defekt (Item defective)

  • Transportschaden (Transport damage)

  • Zu spät geliefert (Delivered too late)

  • Widerruf/keine Angabe (Cancellation/not specified)

6.4. Modifying the account settings

In the Account settings tab, you can adjust the account’s name.

Carrying out account settings:

  1. Open the Sales Channels » Accounts menu.

  2. Open the account for OBI.

  3. Open the settings Account settings tab.

  4. Enter the name.

  5. Save () the settings.

6.5. Activating the account

In the Sales Channels » Accounts menu, activate the account to enable the data exchange with OBI.

Activating the account for OBI:

  1. Open the Sales Channels » Accounts menu.

  2. Click More (more_vert) in the tile for OBI.
    → A drop-down list with further options appears.

  3. Select the Activate account (toggle_on) option from the drop-down list.
    → The account is activated and data can be exchanged with OBI.

6.6. Activating the order referrer

Go to Setup » Orders » Order referrer to activate the order referrer. This ensures that orders are assigned to the correct sales channel.

What is an order referrer?

An order referrer tags an order with the sales channel on which the order was generated. Sales channels can be e.g. your online shop or markets on which you sell your items. Each sales channel has an individual order referrer. Some order referrers are available by default in your PlentyONE system. Further order referrers are added e.g. if you install a new plugin. For further information about the order referrer, see the page Order referrer of the PlentyONE manual.

Activating the order referrer for OBI:

  1. Go to Setup » Orders » Order referrer.

  2. Click Search (search).

  3. In the list, navigate to the option OBI with the ID 177.

  4. On the right of the referrer’s line, click on Edit (edit).
    → The window Edit referrer opens.

  5. Activate the option Visible in selection (toggle_on).

  6. Click on Save (save).
    → The referrer is active.

6.7. Setting the variation availability

You need to activate the variations that you want to sell on OBI. This is done in the Availability and visibility section of a variation within the Item » Items » [Open item] » [Open variation] menu.

  • For one variation

  • Using variation group function

  • Using batch processing

Making a variation available for OBI:

  1. Go to Item » Items » [Open item] » [Open variation].
    Tip: To sell all variations of an item on OBI, carry out the settings for the item’s main variation. If the inheritance function is active for the variations, then this activates the availability of all variations of the item.

  2. In the Availability and visibility section, activate the option Active.

  3. In the Sales channels section, click Add sales channels (add).
    → The window Add sales channels opens.

  4. In the drop-down list Sales channels, select the option OBI.

  5. Click Apply.
    → The sales channel is added.

  6. Save () the settings.
    → The variation is available for OBI.

Use the variation group function to edit multiple variations at once. You select the variations that you want to edit.

Making several variations available for OBI using the variation group function:

  1. Go to Item » Items.

  2. Set search filters as needed and start the search.

  3. Select () the variations to be edited.

  4. In the toolbar, click on layers » layers Variation group function.
    → The Variation group function window opens.

  5. Select the action Sales channels from the drop-down list Actions.
    → The action is added to the lower part of the window.

  6. In the drop-down list Sales channels, select the option OBI.

  7. Select the action Active from the drop-down list Actions.
    → The action is added to the lower part of the window.

  8. Activate the option Active.

  9. Navigate to the area Availability.

  10. Click Execute to apply the settings.

Batch processing allows you to edit several variations at once. You use filters to limit which variations are edited.

Making several variations available for OBI using batch processing:

  1. Go to Item » Batch processing.

  2. Click on the tab Variations in the upper left corner.

  3. Use the filters on the left to specify which variations should be processed.

  4. Navigate to the area Market availability.

  5. Activate the checkbox to the left of the option obi.

  6. Activate the checkbox to the right of the option obi.

  7. Navigate to the area Availability.

  8. Activate the checkbox to the left of the option Active.

  9. Activate the checkbox to the right of the option Active.

  10. Click on Apply to apply the settings to the variations.

7. Importing active offers into PlentyONE

In the Channel settings menu of your OBI account, you can manually import active offers on OBI (= active SKUs on OBI) into PlentyONE. This is done by clicking on the download button in the Listings section.

With this function, PlentyONE retrieves all active SKUs on OBI and compares them with your offer listings in PlentyONE to check whether offer listings have already been created in PlentyONE for the active offers on OBI.
If no offer listing has yet been created in PlentyONE for an active offer on OBI, an offer listing will be created automatically or linked to an existing product listing, if possible.
If you only have one offer catalogue for OBI, the new offer listing will automatically be linked to this offer catalogue.

This saves you time, as you no longer have to manually create offer listings for offers that are already active on OBI, and the newly created offer listings are automatically linked to the appropriate product listing and offer catalogue.

Importing active OBI offers:

  1. Open the Sales Channels » Accounts menu.

  2. Open the OBI account.

  3. In the Listings section, click download IMPORT.
    → PlentyONE retrieves all active SKUs from OBI and compares them with your offer listings in PlentyONE.
    If no offer listing has yet been created in PlentyONE for an active offer on OBI, an offer listing will be created automatically.
    → If you only have one offer catalogue for OBI, the new offer listing will automatically be linked to this offer catalogue. If you have multiple offer catalogues for OBI, then you have to link the offer listing with the desired catalogue.
    → If active SKUs cannot be imported, a CSV error report is created. You can view this error report in the Data » Log menu.

If you have imported active offers from OBI into PlentyONE and use multiple offer catalogues for OBI, you must then link the imported offer listings to an offer catalogue. This is done in the group view of the offer listings.

Linking offer listings with an offer catalogue:

  1. Open the Sales Channels » Accounts menu.

  2. Open the OBI account.

  3. Open the tab list Offer listings.

  4. Open the group view of the offer listings. To do so, click folder in the top right corner.

  5. Use the creation date to check which offer listings have been newly imported and are not yet assigned to an offer catalogue. You can see this in the Catalogue column.

  6. In the Catalogue column, click edit.
    → The catalogue assignment can now be edited.

  7. Select a catalogue for the newly imported offer listings from the drop-down list.

  8. Save () the settings.

7.2. Viewing error reports

If active offers from OBI cannot be imported into PlentyONE via the manual import, a CSV error report is generated in the Data » Log menu. This report contains all errors that occurred during the manual import of active offers.

Retrieving error reports:

Retrieving error reports:

  1. Go to Data » Log.

  2. Click Filters (tune) at the top of the menu.

  3. In the field Level, enter REPORT to search for reports on the import of active offers.

  4. Optional: Select a date if you only want to see entries for a specific day.

  5. Click Search (search) to display the results.

The following errors may occur during the import of active offers:

  • No variation found with appropriate EAN.
    → There is no suitable variation for the active offer in PlentyONE.

  • Multiple variations found with the same EAN.
    → The active offer could not be assigned to an EAN because several variations with the same EAN were found in PlentyONE.

  • Multiple catalogues found.
    → Solution: The offer listing could not be linked to an offer catalogue because there are multiple offer catalogues. Link the offer listing to an offer catalogue.

  • No catalogue available.
    → Solution: Create an offer catalogue and link the offer listing to an offer catalogue.

8. Exporting offer data

Offer data is exported to OBI using catalogues. Go to Data » Catalogues to create catalogues for OBI.

What is a catalogue?

Catalogues are used to export data from your PlentyONE system. There are two different catalogue formats:

  • Marketplace formats are used to export item data to markets.

  • Standard formats are used to export data from your PlentyONE system into a file.

Catalogues with marketplace formats allow you to tailor your item information exactly to the needs of the market. Because here, you assign a suitable PlentyONE data field to each of the data fields of the market. When your variation data is exported to the market, the market’s data fields are then filled with the correct PlentyONE data.

8.1. Creating a catalogue

Offer data is exported to OBI via a catalogue. Go to Data » Catalogues to create catalogues for OBI. Afterwards, link the OBI data fields with offer data saved in PlentyONE in the catalogue you created. If you have activated the catalogue, the account, the listing and the variations, the offer data is automatically exported to OBI every 15 minutes.

Creating a catalogue:

  1. Go to Data » Catalogues.

  2. Click on Create catalogue (add).

  3. Enter a name for the catalogue.

  4. In the drop-down list Marketplace, select the option obi-de.
    → A new drop-down list for Account is added.

  5. In the drop-down list Export type, select the option Listing.

  6. From the drop-down list Category, select the option Offer Obi.
    Tip: You can only create offer catalogues for this sales channel.

  7. In the drop-down list Account, select the account for which the catalogue is to be created.
    Tip: This is the account you created for OBI in the Sales Channels » Accounts menu.

  8. Click CREATE CATALOGUE.
    → The catalogue is created.
    → The catalogue is opened for editing.

8.1.1. Mapping data fields in the catalogue

After you have created a catalogue, map the market’s data fields to item data saved in PlentyONE. This chapter describes how you map data fields and what particularities apply for item exports to OBI.

  • The market expects product data that cannot be saved in the PlentyONE item menu? Then create a property for this data. Link this property with your variations. The actual values are saved as property values for this property. Is this your first time working with properties? Then read up on the principles of properties first.

Getting to know the catalogue menu for marketplace formats
catalogue menu colours
Availability Explanation

Navigation

When you open a catalogue, the view Mapping is shown. On the very left is the navigation.

  • Switch to other views of the catalogue.

  • Open the catalogue settings.

  • Use filters that limit the data that is exported.

  • Go back to the list of catalogues.

  • Create a new catalogue.

Toolbar

The toolbar provides actions for the catalogue. For example, save your mappings, restore an older version of the catalogue or hide or show optional marketplace data fields.

Marketplace data field

To the right of the navigation, all data fields available for the market are listed. Mandatory fields are marked with an asterisk (✱).
Tip: Show or hide optional marketplace data fields in the toolbar. To do so, click on the further actions (more_vert).

PlentyONE data fields

On the right side of the catalogue, you map the marketplace data fields to appropriate PlentyONE data fields. In the screenshot above, a few of the fields are already mapped.

Mapping catalogue fields:

  1. Go to Data » Catalogues.

  2. Click on the catalogue.
    → The Mapping tab opens.
    → In the left-hand column, the market’s data fields are listed.
    Tip: Mandatory fields are flagged with an asterisk (*).
    → In the right column, you map the PlentyONE data fields. Any PlentyONE data fields that you already mapped are also shown in this column.

  3. Map suitable PlentyONE data fields to the market data fields.
    For each marketplace data field, you have a number of mapping options. Expand the info boxes below to get more information about each of these mapping options.

    • Simple 1:1 mapping

    • Simple 1:1 mapping with properties

    • Complex 1:1 mapping

    • 1:1 mapping with fallback data fields

    • 1:n mapping

    • Own value mapping

    • Mapping with mathematical calculations

  4. Save () the catalogue.
    → The mappings are saved.

Simple 1:1 mapping: 1 marketplace data field, 1 PlentyONE data field

In a simple 1:1 mapping, you map a PlentyONE data field to the marketplace data field. If no suitable setting exists in PlentyONE. you can map a property instead.

As such, simple 1:1 mappings allow you to:

  • I want to fill this marketplace data field with the data from this PlentyONE setting.

  • If the data field is empty for a variation, no value is exported for this variation.

Creating a simple 1:1 mapping:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. Click on the group you need.
    → The PlentyONE data fields of the group 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 to the right.

  4. Click on Confirm.

Example: Sales price and RRP for Otto Market

This gif shows you how to map the marketplace data fields Sales price and RRP for Otto Market to PlentyONE data fields:

gif catalogue mapping simple en
Simple 1:1 mapping: with properties: 1 marketplace data field, no PlentyONE data field

Reminder: In a simple 1:1 mapping, you map a PlentyONE data field to the marketplace data field. However, what can you do if PlentyONE does not offer a suitable data field? Then it’s the properties' moment to shine. Properties allow you to save any kind of information in your properties.

Creating a property:

  1. Create a property with the necessary values.
    Tip: Find out how to do that here.

Creating a simple 1:1 mapping with properties:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. Expand the group Property.
    → The property groups are shown.

  3. Expand the group you need.

  4. Click on the Plus sign on the right of the property you want.

  5. From the drop-down list Language, select the language in which you send the data to the market.

  6. Click on Confirm.
    → The property is mapped to the marketplace data field.

Complex 1:1 mapping: 1 marketplace data field, 1 PlentyONE data field

Like with the simple 1:1 mappings, you map a PlentyONE setting or property to a marketplace data field. Complex mappings are necessary whenever a marketplace data field has more than one possible value. Instead of mapping data fields, for complex mappings you map individual values of these data fields. For example, you cannot simply map the PlentyONE data field Shipping profile to the marketplace data field Shipping method. Why? The market cannot know which of your shipping profiles in PlentyONE corresponds to which of their shipping methods.

Do not enter own values for complex mappings. All values that you enter must be saved for the variations, either in a setting or as a property value. This also applies if the value Comparative value is shown. You still need to enter exactly the value of the setting or property that you mapped.

In complex mappings, the value of the market is always exported. Only when you map an own value, the own value that you enter is exported.

You can recognise complex mappings from the field that is shown below the name of the marketplace data field. Click on the field to show the values available for the marketplace data field.

catalogue complex mappings

Examples for complex 1:1 mappings are:

  • Categories

  • Brands

  • Shipping setting

Important: For complex mappings, do not map own values or properties of the type None.

Creating a complex 1:1:n mapping:

  1. Click on the field for the marketplace data field.
    → A list of the available values is shown.

  2. Select the value that you want to map a PlentyONE data field to.
    → The value is mapped.

  3. Next to the marketplace data field, click on + Add data field.
    → To the left, the available PlentyONE data fields are listed in groups.

  4. Click on a group.
    → The PlentyONE data fields of the group are shown.

  5. Click on the PlentyONE data field for which you want to map values.
    Important: Do not map own values or properties of the type None.

  6. Your next steps depend on the PlentyONE data field you selected:

    • Alternative 1: The available values for the PlentyONE data value are shown on the left.

      • Next to the value you want to select, click on the plus.
        → The value is added to the field on the right.

      • Click on Confirm.

    • Alternative 2: The PlentyONE data field is inserted and the field Comparative value is shown.

      • In the field Comparative value, enter a value that is saved in the setting or the property of the mapped PlentyONE data field.

      • Click on Confirm.

    • Alternative 3: The PlentyONE data field is inserted and a drop-down list is shown.

      • Select a value from the drop-down list.

      • Click on Confirm.
        → The value of the marketplace data field is exported, not the value of the PlentyONE data field.
        Exception: Only when you map an own value, the own value that you enter is exported.

Example: Delivery time in days for Otto Market

This gif shows you how to map suitable PlentyONE values to the values of the marketplace data fields Delivery time in days for Otto Market:

gif catalogue mapping complex en
1:1 mapping with fallback data fields: 1 marketplace data field, 1 PlentyONE data field with alternative(s)

In a 1:1 mapping with one or more fallback data fields, you map a PlentyONE data field to the marketplace data field. In addition, you specify one or more fallback data fields. This ensures that the system keeps looking if the first PlentyONE data field is missing or empty.

So this mapping specifies:

  • I want to fill the marketplace data field with the data from the selected PlentyONE setting.

  • If that data field is missing or empty for a variation, the first fallback data field is checked. The value of that fallback data field is exported instead.

  • If the first fallback data field is also missing or empty for the variation, the second fallback data field is checked. If a value is found, the value of the second fallback data field is exported for the variation etc.

Two separate fallback conditions are available:

Null (default)

The fallback data field is used if the data field above is mapped in the catalogue but not linked to the variation.

The condition "Null" is useful when you want to map fallback data fields for the following types of PlentyONE data fields:

  • SKU

  • Barcodes

  • Sales prices

  • Properties

Important: When you add a fallback data field, the fallback condition "null" is selected automatically. To apply the fallback condition "leer", you need to change the default setting.

Empty

The fallback data field is used if the data field above is mapped in the catalogue and linked to the variation, but is empty.

The condition "Empty" is useful when you want to map fallback data fields for the following type of PlentyONE data fields:

  • PlentyONE data fields that are available for variations by default

Important: When you add a fallback data field, the fallback condition "null" is selected automatically. To apply the fallback condition "leer", you need to change the default setting.

Note: Even if you assign one or more fallback data fields, the value of only one of those fields is exported. For each variation, the mapped 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 for a variation, the first fallback data field is exported etc.

Creating a 1:1 mapping with fallback data fields:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. Click on the group you need.
    → The PlentyONE data fields of the group 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 to the right.

  4. In the list of PlentyONE data fields, click on the plus icon next to the PlentyONE data field that you want to map.
    → The fallback data field is added with the fallback condition "null".

  5. Alternative 1: To add the fallback data field with the fallback condition "null":

    1. Click on Confirm.
      → The fallback data field is exported if the data field above is not linked to the variation.

  6. Alternative 2: To add the fallback data field with the fallback condition "empty":

    1. To the left of the fallback data field, click on the cog ().
      → The window Data column settings is shown.

    2. For the setting Fallback condition, select the option Empty.

    3. Click on Save.
      → The fallback data field is added with the fallback condition "empty".

    4. Click on Confirm.
      → The fallback data field is exported if the data field above is empty for the variation.

Example: Fallback data field for SKU for Otto Market

This GIF shows you the mapping for the OTTO Market marketplace data field SKU. The PlentyONE data field SKU is mapped to this marketplace data field. The PlentyONE data field Variation ID is mapped as the fallback data field. The fallback condition "null" is applied automatically.

Result: The fallback data field Variation ID is exported if the data field SKU is not linked to the variation.

gif catalogue mapping fallback en
1:n mapping: 1 marketplace data field, several PlentyONE data fields

In a 1:n mapping, you map several PlentyONE data fields to the marketplace data field. You can link these data fields with a separator.

So this mapping specifies:

  • I want to combine these PlentyONE data fields during export so that the marketplace data field is filled with the data of these two or more PlentyONE settings.

Creating a 1:n mapping:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. Click on the group you need.
    → The PlentyONE data fields of the group 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 to the right.

  4. Click on Confirm.

  5. To the right of the mapped PlentyONE data field, click on Add data field ().
    → To the left, the list of available PlentyONE data fields again are shown in groups.

  6. Map one or several additional PlentyONE data fields to the marketplace data field as described above.

  7. Click on Confirm.

  8. To the very right of the row, click on Settings ().

  9. Select a separator from the drop-down list Separator or add a custom separator.

  10. Click on Save.

  11. Save () the catalogue.
    → The mappings are saved.
    → During the export, the content of the PlentyONE data fields is combined and exported as one field.

Own value mapping: 1 marketplace data field, the same value for all variations

You are sure that you want to export the same value for all variations of a catalogue for a marketplace data field? Then specify an own value. This own value is then exported for all variations.

So this mapping specifies:

  • For this marketplace data field, I want to export the value that I entered in the field Own value for all variations of this catalogue. The value you enter is always exported. The value overwrites the market value also in complex mappings where usually the value of the market is exported. As such, make sure you enter an own value that the market accepts for this marketplace data field.

Creating an own value mapping:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. Click on the plus next to Own value at the top of the list.
    → The field for the own value is added to the view.

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

Example: Diameter information

You want to export diameter information for some of your variations. The diameter is saved in centimetres for all your variations. Instead of creating a property for the unit and linking this property to the variations, you can enter the own value cm.

This is an example of how you can map an own value for the diameter unit:

gif catalogue own value en
Mapping with mathematical calculations: 1 Marketplace data field, the PlentyONE value is recalculated using the formula during export

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

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

  • This functionality is new and not available for all catalogue formats.

So this mapping specifies:

  • I want the numerical value of a PlentyONE data field to be recalculated during the export. Basic arithmetic operations are available for the formulas.

Recalculating numerical values:

  1. Next to the marketplace data field, click on + Add data field.
    → To the left, the list of available PlentyONE data fields are shown in groups.

  2. At the very top of the list, click on the plus icon next to Formula (calculate).
    → The data field Formula is added to the field on the right.

  3. Click into the data field.
    → The window Modify value is shown.

  4. Enter a numerical value or select a PlentyONE data field at the bottom right of the window to add it to the calculation (add).
    Tip: Use the search function. This helps you to find data fields quickly.

  5. 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.

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

  7. Save the settings.
    → The entered formula is displayed in the overview.
    → The calculation will be carried out in the next export.

To help you with mapping your data fields for the catalogue, we have created a list of recommended data field mappings. Note that these mappings are recommendations only. Depending on how you manage your item data, other mappings may be more appropriate than the recommendation given here.

  • Need more information about the PlentyONE data fields? All data fields are described on the manual page for the export type Listing.

List of recommended data field mappings for the format Offer

8.1.3. Activating the catalogue export

You have set up OBI in PlentyONE and created a catalogue for exporting your offer data? Then activate the catalogues you want to export to OBI in the Data » Catalogues menu and continue with creating offer listings.
Once you have activated the offer catalogue, the OBI account, the offer listing and the variations, the offer data will be automatically exported to OBI every 15 minutes.

Activating the catalogue export to OBI:

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

  2. Scroll to the OBI catalogue.

  3. In the Active column, move the toggle button to the right ().
    → The catalogue is active.
    → The catalogue data is exported to OBI every 15 minutes.
    Tip: Go to Data » Catalogue export status for information about the status of the export.

8.2. Managing listings

You create and manage offers for OBI via listings. The Sales channels » Accounts » [Open account] menu offers you an overview of your listings. Here you can create and manage product listings and offer listings. Click on the tile for OBI to create product listings or offer listings for OBI.

Right now, product listings cannot be created for OBI. Instead create offer listings.

8.3. Offer listings

In the list offer listings menu of the account you gain an overview of your offer listings.

Tip: You can switch between specific views of offers and the listing group view via the menu button and folder.

  • menu gives you an overview of all the offer listings.

  • folder shows you the listing groups of the offer listings. Extend a listing group by clicking chevron_right, to see all listings within the group.

Applying search filters
If you only want to take a look at certain offer listings, apply filters and narrow down the listings which are displayed. To do so, click on Filters (tune) at the top of the menu.

Applying filters:

  1. Open the Sales Channels » Accounts » [Open account] » Offer listings menu.

  2. Click on Filters (tune) at the top of the menu.

  3. Select one or multiple filters.

  4. Click Search (search).
    → The selected filters are applied and the appropriate offer listings are displayed.
    → The filters that were applied are displayed at the top of the menu.

Tip: You can also reset (refresh) the selected filters. Then all offer listings will be displayed again.

  • Single listing view

  • Group view

Table 5 offers an overview of the single listing view of offer listings.

Table 5. Offer listings overview
Column Explanation

Data sync

This column indicates whether data exchange for the offer listing is active or paused.
Tip: You can activate the data exchange in the listing’s line via more_vert » toggle_on Activate data sync .

Group ID

The ID of the listing group to which the offer listing is assigned. By clicking on the ID, you can open the listing group view.

Listing Name

Name of the offer listing.

SKU

SKU of the offer listing.
Note: You can edit the SKU. To do so, click Activate editing mode (edit). Make the changes and click Save (save) to apply them. If you want to exit the editing mode, click Deactivate editing mode (edit_off).

Variation ID

ID of the variation.

Channel

The sales channel to which the listing is exported.

Status on Channel

Displays the listing status on the sales channel, for example if the listing is already listed on the sales channel. Possible status are:

  • help = Unknown

  • progress_activity = Outstanding

  • progress_activity = Creation pending

  • cancel = Failed (before creation)

  • check_circle = Online

  • cancel = Failed (on update)

  • pause_circle = Paused

  • unpublished = Offline

Note: For platforms with multiple sales channels, the number after the status icon indicates on how many sales channels the offer listing has this status.

List on

The sales channels on which the offer listing is to be offered are displayed here.
Click on the pencil icon (edit) to add or remove sales channels.

Errors

The error overview.
No entry = No errors occurred.
circle = Errors occurred. The number indicates the number of errors.

Template

The template selected for the listing.

Catalogue

The catalogue selected for the listing.

Creation date

The date and time on which the listing was created.

more_vert

Click here to display more actions.

toggle_on Activate data sync

Activate to permit the data exchange between the sales channel and the listing.
Note: Even if the Activate data sync option is activated, the listing will not be immediately listed on the sales channel. The listing data is only permitted to be exported to the sales channel. It depends on the respective sales channels when a listing is online.

delete Delete listing

delete Delete listing

preview Preview export results

Generates the preview of the export results. The preview opens in a separate window.

Table 6 offers an overview of the group view of offer listings.

Table 6. Group view of the offer listings
Column Explanation

Data sync

This column indicates whether data exchange for the listing group is active or paused.
Tip: You can activate the data exchange in the listing group’s line via more_vert » toggle_on Activate data sync.

Group name

Name of the listing group

SKU

SKU of the listing group.

Channel

The sales channel to which the listing group is exported.

Errors

The error overview.
No entry = No errors occurred.
circle = Errors occurred. The number indicates the number of errors.

Template

The template selected for the listing group.

Catalogue

The catalogue selected for the listing group.

Creation date

The date and time on which the listing group was created.

more_vert

Click here to display more actions.

toggle_on Activate data sync

Activate to permit the data exchange between the sales channel and the listing group.
Note: The data sync must also be activated for the single listing to list an offer listing on a sales channel.
Even if the Activate data sync option is activated in a listing group, the listings in this group will not be immediately listed on the sales channel. The listing data is only permitted to be exported to the sales channel. It depends on the respective sales channels when the listings are online.

delete Delete listing group

Delete listing group.

preview Preview export results

Generates the preview of the export results. The preview opens in a separate window.

8.3.1. Creating listings

Offers are transferred to OBI as listings. Carry out the following steps to create listings for OBI.

What are product listings and offer listings used for?

  • If the item you want to sell is not listed on the sales channel yet you will need to create a product listing for it first. Creating a product listing sends the product data to the sales channel and allows for the item to be listed.
    In order to actually be able to sell the item on the sales channel you will need to additionally create an offer listing. The offer listing contains data related to the sale of the item, such as its price and stock. In other words, a product listing allows you to list an item on a sales channel that did not previously exist on that sales channel, but in order to sell that item on that sales channel you also need an offer listing for that item.

  • If the item you want to sell is already listed on the sales channel you only need to create an offer listing. Offer listings send the data related to your offer, such as the price, stock, shipping costs etc., to the sales channel.
    In most cases you will only need an offer listing in order to offer a product on a sales channel. Many sales channels do not differentiate between product and offer listings. You only need to send offer listings to these kinds of sales channels.

Important: Existing offers on OBI cannot be imported. If you already have offers on OBI, you have to create new listings for them.

At the moment you can only create offer listings for OBI.
8.3.1.1. Creating offer listings
At OBI, you have the option to import active offers that are already listed on OBI into PlentyONE. This allows you to import offers which are already listed on OBI directly, without having to create offer listings manually. How to import active OBI offers into PlentyONE is described here.

Offer listings are created in three steps:

  • First, you enter listing details, meaning you select the platform, template, and catalogue for the listing.

  • Next, you select the variations from which the offer listings are created.

  • Lastly, check and confirm your selection and create the listings.

Step 1: Specify listing details:

  1. Open the Sales Channels » Accounts menu.

  2. Open the account for OBI.
    → The Offer listings menu opens.

  3. Click add Create offers.
    → The Create offers tab opens.

  4. Select the platform OBI.

  5. Select the template for the catalogue.
    Tip: Only templates that are available for the platform OBI are displayed.

  6. Select a catalogue with your mappings for offer data.
    Tip: If you have no fitting catalogue yet, click on add Create catalogue. You will be forwarded to the Data » Catalogues menu and can create a catalogue.

  7. Optional: Activate Automatically activate listings after creation, if listing data should be automatically transferred to OBI after the listing is created.

  8. Click arrow_forward NEXT.
    → The Select variations view opens. Next, select the variations you want to add to the listing.

Step 2: Select variations:

  1. Select the variations you want to create the offer listing for.
    Tip: Use the search to filter for variations.
    Note: Only variations that are linked to OBI in the Item » Items » [Open item] » [Open variation] menu are displayed.
    Tip: If you want to create offer listings for all available variations, click on Click here to create listings for all [] variations above. You will be automatically redirected to the Preview and confirmation step. Offer listings can be created for a maximum of 50,000 variations at a time.

  2. Click add ADD TO SELECTED VARIATIONS.
    → The selected variations are displayed in the Selected variations section.
    Note: If you check a variation in the Selected variations section, you can remove the variation from the selection by clicking Remove from list.

  3. Click arrow_forward NEXT.
    → The selected variations will be displayed in a new view. In the last step, you preview and confirm your selection.

Step 3: Preview and confirm selection:

  1. Preview your settings in the Listing details section.

  2. Preview your selected variations in the Listing preview section. The listings are grouped by items. Extend a listing group (chevron_right) to see which variations are contained in the respective listing group.

  3. If everything is set and done, click CREATE OFFER LISTINGS.
    Note: If you activated Automatically activate listings after creation a window with a summary of your settings opens. Click check CONFIRM to create the offer listings.

9. Creating properties

Next, create properties and link the properties to variations. Then link the properties you have created to OBI properties.

Creating a new property:

  1. Go to Setup » Settings » Properties » Configuration.

  2. Click on Create property.

  3. Customise the settings to meet your needs.

  4. Save () the settings.

10. Permitting payment method in customer classes

The payment method OBI is automatically available in your PlentyONE system as soon as an active OBI account exists. No separate configurations are needed for this. You just need to permit the payment method in one or more customer classes.

What are customer classes?

Customer classes allow you to divide your customer base according to specific criteria. Examples of use for customer classes are:

  • Create two separate customer classes for end customers (B2C) and business customers (B2B) respectively. Depending on the customer class, customers either see net prices or gross prices in your plentyShop.

  • Give discounts to specific customer classes.

For more information about customer classes, head over to the to the Managing contacts page.

Permitting the payment method in a customer class:

  1. Go to Setup » CRM » Customer classes.

  2. Open the customer class for which you want to permit the payment method.

  3. For the setting Allowed payment methods, activate the option OBI.

  4. Save () the settings.

11. Automating order processing

Set up event procedures to automatically inform OBI about changes to the order status. The following event procedures are available for OBI:

  • Automatically inform OBI that the items have been shipped. (How?)

  • Automatically inform OBI about cancellations. (How?)

  • Automatically inform OBI about returns. (How?)

11.1. Send shipping confirmation to OBI

Set up an event procedure to automatically inform OBI when you have shipped all items of an order or individual items of a delivery order.

In order to successfully transfer a shipping confirmation, the following data must be saved for the order.

  • Package number

If an invoice number exists, the invoice number#OrderId is transferred as invoiceId.
If no invoice number is available, the OrderId is transferred as invoiceId.

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct name for the event procedure.

  4. Select the event according to {table-event-procedure}.

  5. Save () the settings.

  6. Carry out the additional settings according to {table-event-procedure}.

  7. Select the setting Active ().

  8. Save () the settings.

Table 7. Event procedure to send shipping confirmations to OBI
Setting Option Selection

Event

Order change: Status change
or Order change: Outgoing items booked

[7] Outgoing items booked

Note: To transmit invoice numbers, select a status that is after invoice creation.

Filter 1

Order > Order type

Order

Filter 2

Order > Referrer

OBI DE

Procedure

Plugin

Send shipping confirmation to OBI

11.2. Send cancellation to OBI

Set up an event procedure to automatically inform OBI of cancellations. Note that orders marked as shipped can no longer be cancelled.

Note:

  • For delivery orders, partial cancellation is possible.

  • If the cancellation is triggered for the main order, the entire order is cancelled.

  • To import cancellations that the buyer has requested directly at OBI, you have to activate the option Subscribe notifications in the channel settings.

Different event procedures can be created, depending on the reason for the cancellation. The following event procedures are available for OBI to report a cancellation:

  • Send cancellation because of customer wish to OBI

  • Send cancellation because of missing stock to OBI

  • Send cancellation because of wrong price to OBI

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct name for the event procedure.

  4. Select the event according to {table-event-procedure}.

  5. Save () the settings.

  6. Carry out the additional settings according to {table-event-procedure}.

  7. Select the setting Active ().

  8. Save () the settings.

Table 8. Event procedure to send cancellation to OBI
Setting Option Selection

Event

Order change: Status change

Select a status, for example [8] Cancelled.

Filter

Order > Referrer

OBI

Procedure

Plugin

Select an event procedure for Send cancellation to OBI with the appropriate reason.

11.3. Send return to OBI

Set up an event procedure to automatically inform OBI about returns. Note that the order must be flagged as shipped.

Note:

  • Customers can request a partial return.

  • To import returns that the buyer has requested directly at OBI, you have to activate the option Subscribe notifications in the channel settings and map the return reasons from OBI.

  • If a package number and a tracking URL are available for the return, this event procedure will also automatically send the package number, tracking URL and shipping service provider to OBI.

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct name for the event procedure.

  4. Select the event according to {table-event-procedure}.

  5. Save () the settings.

  6. Carry out the additional settings according to {table-event-procedure}.

  7. Select the setting Active ().

  8. Save () the settings.

Table 9. Event procedure to send returns to OBI
Setting Option Selection

Event

Order change: Package number

or

Order generation: New return

Note: If you select Order change: Package number as the event, your return must be linked to a package with a package number.

Filter 1

Order > Referrer

OBI

Filter 2

Order > Order type

Return

Procedure

Plugin

Send return to OBI

12. Viewing the data log

Events in your system are logged in the menu Data » Log. This allows you to check the data log for errors without relying on our support.

Viewing the data log:

  1. Go to Data » Log.

  2. Click on Filters (tune) at the top of the menu.

  3. In the Integration field, enter the option OBI.

  4. In the Reference type field, enter the option action. In the Reference value field, enter the option ImportActiveOffers.
    Note: This filter displays the log entry for active offers that could not be imported.

  5. Optional: Select a date if you only want to see entries for a specific day.

  6. Click on Search () to display the results.