Documentation
Feedback
Guides
API Reference

Guides
B2B Suite
B2B Organizations
Bulk Import Buyer Organizations Spreadsheet

This guide will walk you through the process of filling out the bulk import spreadsheet for use with the Bulk Import API to efficiently manage Buyer Organizations, Cost Centers, and Members through bulk import functionality.

Before you begin

To use the bulk import of buyer organizations, you must first install and configure the B2B Suite which includes the B2B Organizations app.

Step-by-step

  1. Download the template file.
  2. Fill in the file with buyer organizations data following the specifications detailed in File structure for import.

Ensure your file is in .xlsx format and does not exceed 50MB.

  1. Once your file is ready, upload it by making a request to the Upload file endpoint.
  2. Validate file content by making a request to the Validate file endpoint.
  3. Once the file is successfully validated, start the bulk data import by making a request to the Start import endpoint.

File structure for import

Before starting the upload and import process, it is essential to understand the required file structure. Ensure your import file adheres to the guidelines outlined below.

File tabs

The import file should be structured with up to three tabs, each serving a distinct purpose:

  1. Buyer Orgs tab: Contains detailed information about buyer organizations.
  2. Cost Centers tab: Dedicated to managing cost centers within organizations.
  3. Members tab: Stores information regarding members associated with organizations and cost centers.

Columns in the Buyer Orgs tab

Each new organization should have one cost center in the Buyer Orgs tab. Additional columns for each custom field configured for the merchant can be added at the end of the Buyer Orgs tab.

Check the default columns present in this tab in the table below. Mandatory information is marked with *.

ColumnTypeDescription
Buyer Org ID*StringUnique identifier for the buyer organization, for tracking and future updates.
Buyer Org Name*StringOfficial name of the buyer organization.
Admin First Name*StringFirst name of the administrator overseeing the buyer organization.
Admin Last Name*StringLast name of the administrator overseeing the buyer organization.
Admin Email*StringAdministrator's email address serves as the organization's primary point of contact.
Cost Center ID*StringUnique identifier for the cost center essential for tracking and future updates.
Cost Center Name*StringName assigned to the cost center.
Address Type*StringClassification of the address (e.g., residential, commercial).
Postal Code*StringPostal code corresponding to the address.
Street*StringStreet name of the address.
Number*StringNumerical identifier for the location (house/building number).
Complement*StringAdditional information regarding the address if any.
Neighborhood*StringNeighborhood of the address.
City*StringCity where the address is located.
State*StringState where the address is situated.
Country*StringCountry of the address.
Receiver Name*StringName of the individual who is the point of contact at the address.
Phone Number*StringContact number for the receiver.
Business Document*StringDocument that contains essential business information (e.g., tax identification number).
CollectionsStringCollections allowed to the buyer organization, separated by comma.
Price TablesStringPrice tables allowed to the buyer organization, separated by comma.
Payment TermsStringPayment terms allowed to the buyer organization, separated by comma.
Trade PoliciesStringTrade policies allowed to the buyer organization, separated by comma.
SellersStringSellers allowed to the buyer organization, separated by comma.

Columns in the cost centers tab

This tab is required only for organizations with multiple cost centers. If the buyer organization has only one cost center, do not fill this tab.

Check the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with *.

ColumnTypeDescription
Buyer Org ID*StringUnique identifier for the buyer organization essential for tracking and future updates.
Cost Center ID*StringUnique identifier for the cost center essential for tracking and future updates.
Cost Center Name*StringName assigned to the cost center.
Address Type*StringClassification of the address (e.g., residential, commercial).
Postal Code*StringPostal code corresponding to the address.
Street*StringStreet name of the address.
Number*StringNumerical identifier for the location (house/building number).
Complement*StringAdditional information regarding the address.
Neighborhood*StringNeighborhood of the address.
City*StringCity where the address is located.
State*StringState where the address is situated.
Country*StringCountry of the address.
Receiver Name*StringName of the individual who is the point of contact at the address.
Phone Number*StringContact number for the receiver.
Business Document*StringDocument that contains essential business information (e.g. tax identification number).

Columns in the Members tab

This tab is required only for organization with multiple members. If the buyer organization has only one member, do not fill this information.

Check the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with *.

ColumnTypeDescription
Buyer Org ID*StringUnique identifier linking the member to a specific buyer organization.
Cost Center ID*StringIdentifier linking the member to a specific cost center within the organization.
Name*StringMember's full name used for identification and communication.
Email*StringEmail address of the member serving as a primary point of contact for communication.
Role Id*GUIDUnique identifier denoting the member's role within the organization.
Can ImpersonateBooleanIndicates if the member can impersonate another user within the system.
Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page