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
Deals (if applicable)
Orders (if applicable)
Assets (if applicable)
Bills (if applicable)
Product Catalog and Price Rules (if applicable)

These objects cannot currently be imported:

Leads
PartnerTeams
Subscriptions
Rewards
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:

Ensure you have permission to access the Importer
Understand your business use case
Know your data and program configuration
Select your object type
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:

Use case	Important Notes	Related objects
Importing new partners	Double check the user of ‘send invite emails'. Toggling this option on will send all imported partners an email to ‘claim their account’. If you’re not ready for partners to login to the portal, ensure this is toggled off.	Partnership
Backfilling transactions	Backfilling Transaction due to an integration outage, or a migration from another platform, ensure that you have first uploaded all relevant customer objects into PartnerStack. Transaction without a corresponding customer record will not be imported.	Customer Transaction
Updating Catalog and Price Rules	Catalog must be uploaded to completion first, then the Price Rules can be imported.Uploading a catalog will increment the version and replace the current catalog. If you’re looking to ADD new product, ensure you’re uploading the entire catalog with the new items, rather than just the new items.	Product Catalog Price Rules

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

Field Name	Type	example	Required?
partner_first	string	“Bryn”	yes
partner_last	string	“Jones”	yes
partner_email	string	“[email protected]”	yes
partner_group	string	“group_ABC”	no
partner_tier	string	“tier_xyz”	no
partner_joined_date	string (ISO 8601 YYYY-MM-DD)	“2020-12-25”	no
partner_key	string	“PartnerBryn”	no
partner_phone_number	string	“1112223333”	no
shipping_address_city	string	“Toronto”	no
shipping_address_country	string	“Canada”	no
shipping_address_line1	string	“123 Spadina ave”	no
shipping_address_line2	string	“Unit 12”	no
shipping_address_postal	string	“L5C3S9” or “32154”	no
shipping_address_state	string	“New York”	no
Tags	String	"tag1, tag2, tag3"	no

Customer Import

Field Name	Type	example	Required?
customer_key ⚠️	string	“cus_123xyz”	yes
email	string	“[email protected]”	yes
partner_key	string	“PartnerBryn”	yes
name	string	“Marlie the Dog”	no
created_at	string (ISO 8601 YYYY-MM-DD)	“2020-12-25”	no
company_name	string	“Marlie Co”	no
provider_key	string	"cus_123xyz"	no
state	string	“New York”	no
city	string	“Toronto”	no
unit	string	“Unit 12”	no
region	string	“Americas”	no
primary	boolean	TRUE	no
postal	string	“L5C3S9” or “32154”	no

Transaction Import

Field Name	Type	example	Required?
customer_key	string	“customer_123”	yes
amount_in_cents or amount_in_dollars	integer	40000	yes (one of)
created_at	string (ISO 8601 YYYY-MM-DD)	“2020-12-25”	no
currency	string	“USD”	no
key	string	“transaction_123”	no
product_key	string	“product_123'	no

Product Catalog Import

Field Name	Type	example	Required?
base_product_name	string	“Product ABC”	yes
product_family_name	string	“Premium”	yes
product_id	string	“LPP-1234”	yes
product_name	string	“Beginner Product Premium”	yes
base_product_type	string	one of [“base”, “price”, “discount”, “addon”, “product”]	no
default_price_amount	integer	100000	no
default_price_currency	string	“USD”	no

Product Price Rules Import

Field Name	Type	example	Required?
amount	integer	100000	yes
amount_type	string	“flat” or “percent”	yes
currency	string	“USD”	yes
per_unit	boolean	TRUE	yes
product_id	string	“LPP-1234”	yes
group_id	integer	1	no
max_seats	integer	1	no
min_seats	integer	2	no
tier_id	integer	1	no

Asset Import

Field Name	Type	example	Required?
created_at	epoch (UTC)	1587479311076	yes
customer_key	string	“customer_123”	yes
external_key	string	“asset_123”	yes
product_name	string	“Beginner Product Premium”	yes
product_sku	string	“SKU-123445”	yes
status	string	one of [“suspended”, “active”, “renewed”, “cancelled”, “active”]	yes
attributes	object	{”key1”:”val1”,”key2”:”val2”}	no
customer_can	string	“customer_can_123”	no
customer_company_id	string	“company_1234”	no
license_key	string	“license_123'	no
parent_external_key	string	“asset_123”	no
partnership_key	string	“partner_123”	no
trigger_eligible	boolean	TRUE	no
meta	object	{“custom_property”: “custom_value”}	no

Order Import

Field Name	Type	example	Required?
asset_key	string	“asset_123”	yes
attribute_line	string		yes
billing_freq	string	one of [“One-time”, “Monthly”, “Quarterly”, “Annual”, “Usage”]	yes
created_at	epoch (UTC)	1587479311076	yes
customer_key	string	“customer_123”	yes
item_amount	number	12	yes
item_external_key	string	“item_123”	yes
item_status	STRING	one of [“open”, “cancelled”, “complete”, “pending”]	yes
order_external_key	string	“order_123”	yes
order_status	string	one of [“draft”, “created”, “approved”, “declined”, “cancelled”, “paid”, “fulfilled”, “returned”]	yes
quantity	number	13	yes
sequence	integer	1	yes
type_	string	one of [“Data Migration”, “Registration”, “Renewal”, “Retail Bill Activation”, “Sales Order”, “Termination Order”, “Version Protection”, “Web Order”, “Add Request”, “Update Request”]	yes
item_type	string	one of [“add”, “delete”, “resume”, “suspend”, “update”]	no
partnership_key	string	“partner_123”	no
product_name	string	“Beginner Product Premium”	no
product_sku	string	“SKU-123”	no
meta	object	{“custom_property”: “custom_value”}	no

Bill Import

Field Name	Type	example	Required?
asset_external_key	string	“asset_123”	yes
created_at	epoch (UTC)	1587479311076	yes
currency	string	“USD”	yes
customer_key	string	“customer_123”	yes
external_key	string	“bill_123”	yes
offering_type	string	one of [“base”, “promotion”, “proration”, “shipping”]	yes
order_item_external_key	string	“order_item_12”	yes
partnership_key	string	“partner_123”	yes
status	string	one of [“paid”, “refunded”, “unpaid”	yes
subtotal	integer	123445	yes
taxes	integer	100	yes
total	integer	100000	yes
type_	string	one of [“adjustment”, “purchase”, “renewal”]	yes
trigger_eligible	boolean	TRUE	no
meta	object	{“custom_property”: “custom_value”}	no

PartnerStack

Welcome to the PartnerStack Integration Docs

Universal Importer

Overview

Supported Objects

📘
Company only feature

Importing Data

1. Import Permissions

2. Understand your business use case

3. Know your data and program configuration

4. Select your object type

Partner Import

Customer Import

Transaction Import

Product Catalog Import

Product Price Rules Import

Asset Import

Order Import

Bill Import

Universal Importer

Suggested Edits are limited on API Reference Pages

Overview

Supported Objects

📘Company only feature

Importing Data

1. Import Permissions

2. Understand your business use case

3. Know your data and program configuration

4. Select your object type

Partner Import

Customer Import

Transaction Import

Product Catalog Import

Product Price Rules Import

Asset Import

Order Import

Bill Import

📘
Company only feature