Overview

The PartnerStack importer allows company users to create or update objects in PartnerStack by uploading a CSV (comma separated value) file into PartnerStack via their program dashboard or through the REST API.

Importing Data is a simple, secure way to bring data into PartnerStack:

• Only users with elevated permission can access the importer
• All objects follow the same patterns of import
• Alerts prevent you from importing incorrect headers
• Post import reports provide a detailed breakdown of imported and skipped rows
• All importer activity is captured in the audit log

Supported Objects

The importer currently supports these objects:

• Partners
• Customers
• Transactions
• Commissions
• Leads
• Deals

These objects cannot currently be imported:

• Partner Teams
• Actions

📘

Company only feature

At this time, only Company users can import data. Partner users cannot import data.

Importing Data

To import data into PartnerStack, follow these steps:

1. Ensure you have permission to access the Importer
2. Understand your business use case
3. Know your data and program configuration
4. Select your object type
5. Follow the guide for the object type you’re importing

1. Import Permissions

A user's access to the importer is controlled by their permission configurations. By default ‘Admin' and ‘Technical Teammates’ have access to the importer.

Access to the importer can be provided as needed to individual teammates by using a ‘custom’ permission configuration.

Once a user has access to the importer page, that user has access to all import types available to the program. In other words, you cannot limit importer access to a subset of objects so please ensure to only grant import permissions to teammates who need them.

2. Understand your business use case

The importer can be used to complete a variety of tasks within your partner program. Before you import any data, it is important to understand how your program functions and what your business process is. Importing certain data types such as transactions and orders have the potential to generate financial rewards for partners.

To provide your partners the best possible experience we recommend double checking the expected outcome of your import with your teammate who setup your program Triggers, or PartnerStack support.

Common use cases and important notes:

3. Know your data and program configuration

Now that you know what you want to accomplish and the relevant objects, you’ll need to ensure you have the proper data for those objects. For instance, a Transactions import will require you to have access to the customer identifier and the net sales amount for each transaction line. You should also double check and field level requirements you might have setup in PartnerStack.

A simple way to check the needed data is to select the object of interest in the Importer object drop down and then view the required fields.

4. Select your object type

Navigate to the importer tool in your company dashboard, and select a data type from the dropdown.

Hover over “View Headers” to see a list of required and optional fields, or simply download a CSV template that includes all the headers.

Partner Import

The partner importer supports both updating existing partners, and adding new partners.

Customer Import

Transaction Import

In addition, you can include metadata (in the form of key-value pairs) to be attached to the transactions you upload. For example, you could include an agreement number as part of the transaction. Metadata is not used by PartnerStack, and will not be shown to your partners unless you choose to show it to them.

This metadata will be visible when retrieving the transactions via our API, or when exporting your program data to CSV.

To do so, include columns starting with metadata. followed by the name of the key you want to upload. For example, if you wanted to include a metadata attribute called the agreement number, you could add a column to your export called metadata.agreement_number.

The following restrictions apply:

• Metadata cannot be updated (as transactions cannot be updated once created)
• You can have a maximum of 25 metadata values stored in a single transaction
• Each metadata key (e.g agreement_number) can be at most 30 characters long
  • Metadata keys can only have letters, numbers or _ in them
• Metadata values can be either:
  • Empty
  • A string with a 100 character length limit
  • An integer, or a decimal value

Commission import

Lead import

Note that you can only import leads for one group at a time. You have to select a group in the dashboard. That is required.

Deal import

Note that you can only import deals for one group at a time. You have to select a group in the dashboard. That is required.