Company Management
Introduction
A Company in B2B Edition is the business account for B2B clients, which connects buyers in the business within its instance of the Buyer Portal.
BigCommerce customer groups determine the products and pricing that a Company’s buyers see. Assign Company accounts to these groups as needed. Multiple Companies may share the same customer group, or remain unassigned to access the default catalog and pricing. The customerGroupId field maps Companies to customer groups.
NOTE: If your store uses legacy Dependent Companies behavior, each Company account has a one-to-one relationship with a BigCommerce customer group. Once created, you cannot reassign the Company to another customer group; you can only delete it. See Companies and Customer Groups in B2B Edition (Help Center) (opens in a new tab) to learn more about how Independent and Dependent Company behaviors work.
Available Resources
| Resource | Description |
|---|---|
| Companies (opens in a new tab) | Account details, settings, and attachments for B2B Edition Companies |
| Company Roles and Permissions (opens in a new tab) | User roles and permissions for B2B buyers associated with a Company account |
| Account Hierarchies (opens in a new tab) | Parent-child relationships between companies in a hierarchy |
Company Status Codes
The companyStatus object indicates the activity status of a particular Company account in the response body of the following endpoints:
- Get All Companies (can also be used as a parameter in the query)
- Get Company Details
- Update a Company’s Status
This is expressed as a string or integer, with numeric values that correspond to a possible status. See the table below for more information:
| Value | Company Status | Description |
|---|---|---|
| 0 | Pending | A buyer has applied for a Company account, but the application has not been processed. |
| 1 | Approved | The Company account is active. |
| 2 | Rejected | The application has been rejected and the Company account cannot be used. |
| 3 | Inactive | The Company account does not have any buyers assigned to it. |
Company Account Hierarchy
Account Hierarchy functionality establishes parent-child relationships between multiple Company accounts belonging to a single client business. Buyers assigned to Companies on higher layers can access the Buyer Portal for their subsidiaries. This functionality allows you to support clients with complex businesses, such as chain stores, franchises, and global corporations.
NOTE: This functionality is available upon request for stores using the Buyer Portal experience and Independent Companies behavior. You can request Account Hierarchy by contacting our support team.
Account Hierarchy adds support for the following endpoints:
- Get Company Subsidiaries — View all accounts in lower layers of Account Hierarchy compared to a particular Company account.
- Delete Company Subsidiary — Removes the parent-child relationship between a specified subsidiary account and its parent Company.
- Attach a Company as the Parent of a Current Company — Assigns one Company account to the hierarchy layer directly above another Company.
- Get Company Hierarchy — View all accounts in the same hierarchical structure as a particular Company.
You can create up to 5 layers of hierarchy for a given organization, and each hierarchy can have a maximum of 500 Companies assigned to it.
Company Roles and Permissions
Buyers in a Company account, or Company users, are assigned a role that determines what they can view and configure within the Buyer Portal. B2B Edition includes predefined Company user roles, but you can also create custom roles with a unique set of permissions.
Additionally, you can use the Company Roles and Permissions API to create custom permissions for more complex role-based access control. Note that custom permissions are not configurable from the B2B Edition control panel.
Permission Codes
When creating or updating Company user roles, you must specify the permissions that are enabled for the role and their scopes. The code field accepts the following default permission code strings, but you can also add the code value for custom permissions.
| Permission Code | Permission Name | Description | Supported Permission Levels |
|---|---|---|---|
get_addresses | Get addresses | View the Addresses area of the Buyer Portal | 2 (Company), 3 (Company and subsidiaries) |
get_address_detail | Get address detail | View the details of specific addresses | 2 (Company), 3 (Company and subsidiaries) |
get_default_shipping | Get default shipping address | Set the default shipping address for the Company | 2 (Company), 3 (Company and subsidiaries) |
get_default_billing | Get default billing address | Set the default billing address for the Company | 2 (Company), 3 (Company and subsidiaries) |
create_address | Create address | Create a new Company address | 2 (Company), 3 (Company and subsidiaries) |
update_address | Update address | Edit an existing Company address | 2 (Company), 3 (Company and subsidiaries) |
delete_address | Delete address | Delete an existing Company address | 2 (Company), 3 (Company and subsidiaries) |
get_invoices | Get invoices | View the Invoices area of the Buyer Portal | 2 (Company), 3 (Company and subsidiaries) |
get_invoice_detail | Get invoice detail | View the details of specific invoices | 2 (Company), 3 (Company and subsidiaries) |
export_invoices | Export invoices | Export invoices to a CSV file | 2 (Company), 3 (Company and subsidiaries) |
get_invoice_pdf | Get invoice pdf | Print or download invoice PDFs | 2 (Company), 3 (Company and subsidiaries) |
get_invoice_payments_history | Get invoice payments history | View a log of partial payments on a particular invoice | 2 (Company), 3 (Company and subsidiaries) |
pay_invoice | Pay invoice | Make a full or partial invoice payment | 2 (Company), 3 (Company and subsidiaries) |
get_orders | Get orders | View the My orders and Company orders area of the Buyer Portal, depending on the permission level | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_order_detail | Get order detail | View the details of specific orders | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_quotes | Get quotes | View the Quotes area of the Buyer Portal | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_quote_detail | Get quote detail | View the details of specific quotes | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
create_quote | Create quote | Request a quote from the Buyer Portal | 1 (User), 3 (Company and subsidiaries) |
update_quote_message | Update quote message | Submit a message on an existing quote | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
checkout_with_quote | Checkout with quote | Purchase a finalized quote | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_quote_pdf | Get quote pdf | Print or download quote PDFs | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_shopping_lists | Get shopping lists | View the Shopping lists area of the Buyer Portal | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_shopping_list_detail | Get shopping list detail | View the details of specific Shopping Lists | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
create_shopping_list | Create shopping list | Create a new Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
deplicate_shopping_list | Deplicate shopping list | Make a copy of an existing Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
update_shopping_list | Update shopping list | Edit the details of an existing Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
submit_shopping_list_for_approval | Submit shopping list for approval | Submit a Shopping List to a user with approval permissions | 1 (User), 3 (Company and subsidiaries) |
approve_draft_shopping_list | Approve draft shopping list | Approve a pending Shopping List for purchase | 2 (Company), 3 (Company and subsidiaries) |
delete_shopping_list | Delete shopping list | Delete an existing Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
create_shopping_list_item | Create shopping list item | Add products to a Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
update_shopping_list_item | Update shopping list item | Update product information in a Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
delete_shopping_list_item | Delete shopping list item | Delete products from a Shopping List | 1 (User), 2 (Company), 3 (Company and subsidiaries) |
get_users | Get users | View the User management area of the Buyer Portal | 2 (Company), 3 (Company and subsidiaries) |
get_user_detail | Get user detail | View a Company user’s role and contact information | 2 (Company), 3 (Company and subsidiaries) |
create_user | Create user | Create a new Company user | 2 (Company), 3 (Company and subsidiaries) |
update_user | Update user | Edit an existing Company user | 2 (Company), 3 (Company and subsidiaries) |
delete_user | Delete user | Delete an existing Company user | 2 (Company), 3 (Company and subsidiaries) |
get_roles | Get roles | View available Company user roles | 2 (Company), 3 (Company and subsidiaries) |
purchase_enable | Purchase Enable | Allow the user to complete checkout | 2 (Company), 3 (Company and subsidiaries) |
get_company_subsidiaries | Get company subsidiaries | View the Company hierarchy area of the Buyer Portal | 3 (Company and subsidiaries) |