Create Company | BigCommerce Developer Center

Create a company.

When the independent company behavior is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the customerGroupId field. If the customerGroupId field is not provided, the B2B company will be associated with your configured default customer group. If you have not configured a default customer group, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to “No Group” in BigCommerce.
When the independent company behavior is turned off, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the customerGroupId field.

Create a company. * When the `independent company behavior` is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the `customerGroupId` field. If the `customerGroupId` field is not provided, the B2B company will be associated with your configured default customer group. If you have not configured a default customer group, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to "No Group" in BigCommerce. * When the `independent company behavior` is turned off, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the `customerGroupId` field.

Authentication

authTokenstring

Required to authenticate requests. Include the token in a header parameter called authToken.

Request

User Extra Field Values

companyNamestringRequired>=1 character

The company name, if you want to specify it.

companyPhonestringRequired

companyEmailstringRequiredformat: "email">=1 character

countrystringRequired>=1 character

Country full name or ISO2 country code. For Example:

A Country full name: Afghanistan

ISO2 Country code: AF

adminFirstNamestringRequired>=1 character

The company first admin user first name

adminLastNamestringRequired>=1 character

The company first admin user's last name

adminEmailstringRequiredformat: "email">=1 character

The company first admin user email

extraFieldslist of objectsOptional

userExtraFieldslist of objectsOptional

addressLine1stringOptional

addressLine2stringOptional

citystringOptional>=1 character

statestringOptional>=1 character

zipCodestringOptional

adminPhoneNumberstringOptional>=1 character

The company first admin user phone number

catalogIdintegerOptional

BigCommerce price list ID that company related

acceptCreationEmailbooleanOptionalDefaults to false

True: Sends an email notification about the company creation to the admin user; False: Does not send the notification.

channelIdslist of integersOptional

BigCommerce channel ID list

originChannelIdintegerOptional

BigCommerce channel ID, used for BigCommerce customer origin channel ID. This field takes effect only when you do not configure the store default B2B channel.

customerGroupIdintegerOptional

BigCommerce Customer Group ID. Used to associate a BigCommerce Customer Group to a B2B company when the independent company behavior is enabled.

Response

Created

codeinteger

dataobject

metaobject

Errors

400

Bad Request Error

422

Unprocessable Entity Error

Create a company.

When the independent company behavior is enabled, the system will not automatically create a dedicated customer group for each new Company account. Instead, you can assign a customer group to a Company account as needed using the customerGroupId field. If the customerGroupId field is not provided, the B2B company will be associated with your configured default customer group. If you have not configured a default customer group, the B2B company will not be associated with any customer group, and the company users within the company will have their corresponding customer record assigned to “No Group” in BigCommerce.
When the independent company behavior is turned off, a new customer group will be automatically created and associated with each new Company account. In this case, you will not use the customerGroupId field.

1	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies \
2	-H "authToken: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"companyName": "string",
6	"companyPhone": "string",
7	"companyEmail": "user@example.com",
8	"country": "string",
9	"adminFirstName": "string",
10	"adminLastName": "string",
11	"adminEmail": "user@example.com",
12	"extraFields": [
13	{
14	"fieldName": "string",
15	"fieldValue": "string"
16	}
17	],
18	"addressLine1": "string",
19	"addressLine2": "string",
20	"city": "string",
21	"state": "string",
22	"zipCode": "string",
23	"adminPhoneNumber": "string",
24	"catalogId": 0,
25	"acceptCreationEmail": false,
26	"channelIds": [
27	1,
28	2
29	],
30	"originChannelId": 1,
31	"uuid": "string"
32	}'

1	{
2	"code": 200,
3	"data": {
4	"companyId": 1,
5	"customerId": 1,
6	"customerGroupId": 1
7	},
8	"meta": {
9	"message": "SUCCESS"
10	}
11	}