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 |
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 |
Updated about a month ago