The Related Items add on allows you to display items that are related to a specific item in your catalog in a carousel format on the Item Information page. The association of the items is based on data that you will upload to Pepperi.
Related Items is supported on both web and mobile apps.
For example - for a certain Sales Order, the item "Gouda Cheese" CH001 has 5 related items displayed in the carousel - CH002, CH003, CH004, CH005, CH006.
These items could be marked as related to Gouda Cheese for multiple reasons:
- Substitutions in case of low stock
- Recommended to purchase together
- Same group/sub-group
- Same promotional pricing on these items
To configure Related Items use the instructions below and watch the video guide:
Configure Related Items
1. Install the Related Items Add On
2. Add Collections in the "Related Items" add on
3. Add the relevant Collections to the Transaction Type (Sales Order, B2B Order, etc.)
1. Install the Related Items Add On
Install the Related Items Add on (you may need to contact your Pepperi Success Manager if the add on is not included in your current Pepperi plan). For the Beta version Pepperi will install the Add on for you.
2. Add Collections in the "Related Items" add on
A collection is a list of items and all the items that are related in some way to each of them.
They could be related because of item type, or because they are suggested items, or any other connection you wish to make between an item and it's "related" items.
It's structured as the Item ExternalID - and then a list of the items related to that Item ExternalID.
The items will be displayed in the carousel in the order they are listed in the collection.
LIMITATION: There is a limit of 25 related items related to the main "parent" item. You can display only up to 25 related items per item.
For example:
Collection "Related Items" contains:
Item | Related Items |
Item43 | Item11, Item12, Item13, Item14, Item15, Item22 |
Item25 | Item14, Item18, Item32, Item51 |
Item11 | Item17, Item18, Item33 |
Collection "Recommended Items" contains:
Item | Recommended Items |
Item71 | Item56, Item86, Item99, Item83 |
Item72 | Item32, Item33, Item64, Item35, Item63 |
Collection "Bought Together" contains:
Item | Bought Together Items |
Item71 | Item70, Item42, Item55, Item 76 |
Item55 | Item71, Item99, Item86 |
You can add collections manually or by importing a CSV file.
Go to Settings -> Items -> Item Collections
Click Add Collection to enter the Item ExternalID values manually (instructions below).
Adding a Collection by importing a CSV file
Click on the menu -> Import to import a CSV file containing all of your collections in bulk.
Note: when uploading related items to collections only 100 entries will be displayed in the user interface in the back office, however all the related items will be displayed in the catalogs. The user interface is limited to 100 related items that can be added/edited manually.
You can upload a partial list of updates, you don't have to upload the entire file each time.
The items will be displayed in the carousel in the order that they are uploaded in the file.
The file format contains 3 columns as follows (an example file can be downloaded here):
CollectionName | ItemExternalID | RelatedItems (max 25 items) |
Related Items | Item43 | ["Item11","Item12","Item13","Item14","Item15","Item22"] |
Related Items | Item25 | ["Item14","Item18","Item32","Item51"] |
Recommended Items | Item71 | ["Item56","Item86","Item99","Item83"] |
Recommended Items | Item72 | ["Item32","Item33","Item64","Item35","Item63"] |
LIMITATION: There is a limit of 25 related items related to the main "parent" item. You can display only up to 25 related items per item.
NOTE: Do not use special characters in the CollectionName (+, -, %, &, etc..). Use regular text characters.
Updated values for RelatedItems column will be overwritten (replace the current values).
If you want to delete the main item from a collection upload it with empty brackets in the RelatedItems column - like this:
Example: delete Item71 from the "Recommended Items" collection, upload it like this:
CollectionName | ItemExternalID | RelatedItems |
Recommended Items | Item71 | [] |
Adding a Collection Manually
Give a name and description to the Collection
NOTE: Do not use special characters in the Collection Name (+, -, %, &, etc..). Use regular text characters.
Next you will add Item ExternalID and the related items associated with the Item ExternalID.
Click "Add" and enter the Item ExternalID of the original Item you wish to relate items to.
NOTE: you will only be able to add up to 100 related items to a collection manually. For more than 100 related items use the import/export method explained above.
The next screen will be displayed.
In this screen Add the related items by Item External ID.
Click Add and enter the Item ExternalIDs of the related items, one by one. You can also enter them all at once using a semi-colon as a separator:
The collection will be created as below:
The Items will be added to the list.
Add more Items and relations to the Collection as needed. In the example below, 3 Items were added to the collection "Related Items":
Create all the collections you require.
Once you have created all of your collections, you will need to configure which collections should be used in the Transaction Type (ie Sales Order, B2B Order, etc.).
3. Add the relevant Collections to the Transaction Type (Sales Order, B2B Order, etc.)
Go to Settings -> Sales Activities -> Transaction Types
Edit the Transaction Type you wish to add Collections of Related Items to.
Go to the "Related Items" tab.
In this tab, you will create a field name that you will add to the Item Information Page view in the Catalog. This field will contain the carousel component with the relevant related items (as created in the collection).
Click "Add Field"
Enter a Name for the field. The API Name will be automatically generated with the required TSA prefix.
Select the collection that should be associated with this field.
In this example the field name "Bought Together" is associated with the Bought Together collection.
If you wish to have more than one carousel in the Item Information Page, then add another field, and add another associated collection.
The last step is to add the field to the Item Information Portrait View in the "Views and Forms" tab of the Transaction Type.
Edit the Item Information Portrait View. Add the field from the Custom Transaction Line-Item fields to the layout.
Add it as one line across the entire width of the view, the height (number of rows) should be equal to that of the Small Thumbnail View configuration in this Transaction Type.
The related items carousel uses the Small View configuration to display the related items. YOU MUST HAVE THE SMALL VIEW ENABLED AND CONFIGURED WITH FIELDS otherwise the related items will fail to display and you will get an error.
To add a title to the carousel area add a "Splitter" field.
The result will look like this with in the app (mobile devices and web):
The items within the carousel are displayed according to the Small Thumbnail View configuration. Make sure the Small View contains all the fields you require (for example: custom fields for pricing, or other needs).
0 comments
Please sign in to leave a comment.