Importing promotions

You can import the promotion created in external sources, so you can manage them in Synerise. The output of the import is a promotion added to the list of promotions in Communication > Promotions

Import methods

Before you proceed to importing promotions to Synerise, decide on the method of import and then see Requirements for the import method of your choice.

• Simple import wizard - This method allows you to upload only a .csv file from your device and map the columns contained in the file with the equivalent parameters in your workspace.
  Recommended use: Single import of .csv files.
• Automation - This method allows you to import a file from a server or from your device. The supported file formats include: .csv, .json, .jsonl, and .xml. You will be redirected to a workflow template which you can adjust to your business assumptions. The template contains a Data Transformation node that allows you to select transformation rules if the imported data need modification before the import to Synerise to meet Synerise data standards.
  Recommended use: Imports of files stored in external servers (using HTTP and SFTP protocol), periodic imports;
• Through API by using the Create or update promotion method.

Requirements

Tips for preparing a file

• We recommend importing promotions in JSON files (through the Automation module).

  • To include multiple values in one parameter, for example 3 colors in the colors parameter, do it in the following way:

    "colors": [
    "white",
    "green",
    "blue"
    ]

• If you import a CSV file, these file metacharacters are recommended:

  • A character that marks the end of a column (delimiter): ,
  • A character that is used to contain the text (quotation mark): "
  • A character (escape character) that changes the default interpretation of a sign or string followed by the escape character: \
  • To include multiple values in one column, for example, 3 colors in the colors column, do it in the following way:

    color.0,color.1,color.2
    white,green,blue   
        

• For more details about parameters that can be defined for a promotion, you can check the API Reference.

Importing in Simple import wizard

1. Go to Settings > Import > New import.
2. As the data type for import, select Promotions.
3. As the import method, select Import a local file.
4. From the Promotion parameters column, select the Synerise counterparts for the columns from the imported file. This way, you will point which parameters in Synerise will contain the promotion information from the imported file.
   • If you are not sure of the purpose of a parameter from the Promotion parameters list, see the Request schema body, where you can find the description of all parameters from this list.
   • To toggle between including/excluding a parameter, click / icons.
   • During the mapping process, you can’t add new columns to the imported file.

   

5. When mapping is completed, click Next.
   Result: A summary of import mapping is displayed.
6. Verify the mapping summary. If it is correct, click Run import.
   Result: Promotions will be available on the list of promotions in Communication > Promotions and the import logs will be available in Data Management > Data import.

Importing in Automation

1. Go to Settings > Import > New import.
2. As the data type for import, select Promotions.
3. As the import method, select Import in Automation.
4. Select the method of delivering the file:
   • Local File - This option allows you to upload a file from your device.
   • SFTP protocol - This option allows you to fetch a file from a server using the SFTP protocol.
   • HTTPS protocol - This option allows you to fetch a file from a server using the HTTPS protocol.
5. Click Go to import template.
   Result: You are redirected to a workflow template for importing promotions.

   

6. Define the settings of the Scheduled Run node.
7. Depending on the method of delivering the file, configure the settings of Local File or replace the node with the Get File node that uses HTTP protocol or the Get File node that uses SFTP protocol.
8. If the data requires modification, configure the settings of the Data Transformation node. If you have prepared the transformation rules for the data structure of the imported file, select it from the dropdown list. If not, create it from scratch.
   If your data doesn’t require transformation, you can remove this node.
9. The rest of the nodes in the default template don’t require any further configuration.
10. If your workflow is ready, click Save & Run.
    Result: Promotions will be available on the list of promotions in Communication > Promotions and the import logs will be available in Data Management > Data import.

Importing through API

To import promotions to Synerise through API, send a POST request to this endpoint.