Configuring and activating feed

This guide will help you to get your feed up and running by configuring and activating it.

Configuration

Select countries

Select the shops for which feeds should be generated in the SCAYLE Panel:

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration
2. Select the respective shop countries.
3. Click SAVE.

Set include and exclude rules

Include and exclude rules allow you to define criteria for adding or removing specific data from your feed. In this section, you'll learn how to configure these rules.

Include and exclude products to feed

Products can be included or excluded base on categories, product IDs and attribute. As an example:

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the include criteria for products, enter a category to include.
3. Click SAVE.

Include and exclude categories from feed

If you selected Category as data type, you can include and exclude categories by name. As an example:

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the exclude criteria for categories, search for a category you want to exclude.
3. Click SAVE.

Set feed scheduler

The Masterfeed Add-on scheduler allows you to define the runtime of your feed base on pre-determined intervals.

When setting up the scheduler with the Add-on, you can choose between two main types: Full Feeds and Delta Feeds. Understanding the difference is key to optimizing data transfer and ensuring efficiency.

• A full feed considers the entire dataset each time it runs.
• A delta feed only considers changes made to the dataset since the last update. This could include new entries, updates to existing data, or deletions.

Set the interval in which the feed should be generated.

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the Masterfeed Scheduler, select the interval from dropdown.
3. Click SAVE.

Pick the file format

In this section, you are able to pick in which format the feed file should be generated. The masterfeed Add-on currently supports the generation of XML and CSV files.

Select the file format

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the section Feed file, select CSV or XML.
3. For a CSV file, select a separator from the dropdown options.
   For a XML file, define the header.
4. Click SAVE.

Choose an access option

In this section, you are able to define how you want to be provided with the feed files. The Masterfeed Add-on currently supports the following options to access the file:

Configure SFTP as an access option

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the section Feed access, select YOUR OWN SFTP from the dropdown options.
3. Enter the Host, Username and Password to access the SFTP
4. Click SAVE.

Access feed files via SCAYLE API

Access and manage your feed files using the Masterfeed API. You can either download specific files directly or list all available generated files.

1. Download a Feed

Use this endpoint to download a specific feed file.

HTTP Request

Copy

GET https://{{tenant-space}}-masterfeed.addon.scayle.cloud/api/mfapp/download/feedId/shopId

2. List All Feed Files

Returns a paginated JSON list of the latest generated files for each country/shop.

HTTP Request

url

Copy

Headers

Response

200401500

Copy

3. Understanding Pagination

How to read the pagination metadata:

In the meta and links sections of the response, you will see exactly where you are in the list:

How to see the next page:

If last_page is greater than 1, you can access the next set of files by adding ?page=2 to your URL:

GET https://.../api/mfapp/feed-country-files/{feedId}?page=2

Alternatively, you can simply follow the URL provided in the links.next field of the JSON response.

Define the feed fields

In this section, you are able to define the fields your feed should contain. Depending on the selected data type of your feed, you can select from a set of System Fields and Attribute Groups to map data from SCAYLE to a corresponding field in your feed.

Beside a one-to-one mapping you can also apply advanced extraction and transformation logic to define your feed fields. Please study our documentation on Advanced field mappings to understand more about the field mapping options.

Define mapping for feed fields

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration ➜ Field Mapping.
2. Click on Add Field.
3. In the column SCAYLE, select e.g. Name from the dropdown options.
4. In the column Feed, enter Product Name
5. Click SAVE.

Remove a mapping row

1. Select the Trash icon at the right end of the mapping row.

Manage feed state

Before your feed will run you have to activate the feed. The Masterfeed Add-on features the following states of a feed.

• Draft - Use this state to for work in progress feed configuration.
• Active - Use this state to enable the generation on the feed.
• Inactive - Use this state to pause the feed generation.

Activate feed

1. Go to Add-ons ➜ Masterfeed Add-on ➜ Feeds ➜ Feed Configuration.
2. In the top of the configuration page, Click on Save As.
3. Select Active from the dropdown options.
4. Click SAVE.