One file to make your life easier as a Merchant. Learn how to create a CSV file to process your commissions in bulk. This is the easiest way to process your commissions if you don’t have the resources to use our API.
You can use a CSV file to process your commissions in bulk. Before uploading the file, please ensure it follows the specifications detailed on this page.
You can also watch the following tutorial to learn how to create the CSV file:
Specifications:
File type: CSV (comma-separated values)
Encoding: UTF-8 (default format if you download the CSV from Google Sheets)
File size: Max. 2Mb
Columns:
|
Column |
Details/restrictions |
|
id |
The ID of the commission |
|
status |
Can only be “accepted” or “rejected” |
|
reason |
Required when rejecting a commission or when changing the commission’s or sale’s value |
|
amount or sale_amount |
A positive number, no commas, fractions separated by '.' (e.g. "1000", "1000.12") amount > use it as the head of the table if you want to change the commission’s value sale_amount > use it as the head of the table if you want to change the sale’s value |
|
currency_code |
The currency in which the commissions are expressed, as set in Settings - Currency. Must be equal to the currency configured in 2Performant. Format: ISO 4217 code (3 letters) Must be one of the accepted currencies: https://api.2performant.com/public/currencies. json If this field doesn't appear, we'll add it based on info from Settings - Currency. |
|
The file must always contain all the fields above, even if they are not required (eg. if you only want to accept the commissions) |
- Accepting commissions
If you want to accept commissions, you have to complete in the file the following columns:
- id => the id of the commission
- status => accepted
Download here a model for accepting commissions.
By using this file you will accept all the commissions added to the CSV.
The file must contain all the fields as the head of the table, but you can only complete the necessary fields, in this case, “id” and “status”.
- Rejecting commissions
For rejecting commissions, besides the “id” and the “status” of the commission, “rejected”, you have to add a reason for rejecting the commissions (eg.: the order was canceled, the order was returned, etc. )
Download here a model for accepting commissions.
By using this file you, will reject all the commissions added to the CSV.
The file must contain all the fields as the head of the table, but you can only complete the necessary fields, in this case, “id”, “status”, and “reason”.
- Edit commissions
There might be some cases when the order is changed in your system after it was placed (some products were removed, others were added, etc.).
In this case, you can accept the commissions and change their value at the same time to reflect the final value of the order.
Depending on the commissioning type you use in your program, you have two options to process the commissions:
- Edit sale value
This option is recommended if you use a fixed percentage commission in your program.
The following columns are required for changing the sale’s value of a commission:
- id => the id of the commission
- status => accepted
- reason => the reason for changing the sale’s value
- sale_amount => final value of the sale
- currency_code => the currency in which the commissions are expressed
You will add to the file the final order value and the commission will be automatically changed accordingly.
Download here a model for accepting commissions and changing the sale value at the same time.
- Edit commission value
If you are using a variable percentage in your program, it’s recommended to change the commission’s value.
The CVS file has to contain the following information:
- id => the id of the commission
- status => accepted
- reason => the reason for changing the sale’s value
- amount => final value of the commission
- currency_code => the currency in which the commissions are expressed
Download here a model for accepting commissions and changing their value at the same time.
|
Info: You can create separate files for each status, but you can also create one file for all the commissions if the file will not exceed 2 MB. You can download here an example, a CSV file with all possible status changes for the commissions: |