Bulk Create Companies | BigCommerce Developer Center

Creates multiple Company accounts at once. You can create up to 10 Companies in a single request.

See Create a Company for recommendations on formatting individual Companies in the array.

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Request

This endpoint expects a list of objects.

acceptWelcomeEmailbooleanOptional

If user accepts, the system sends a welcome email.

addressLine1stringOptional<=200 characters

Address line 1 of ths company.

addressLine2stringOptional<=200 characters

Address line 2 of ths company.

adminEmailstringOptional1-100 characters

Email address of the company's administrator.

adminFirstNamestringOptional1-100 characters

First name of the company's administrator.

adminLastNamestringOptional1-100 characters

Last name of the company's administrator.

adminPhoneNumberstringOptional1-100 characters

Phone number of the company's administrator.

catalogNamestringOptional

Name of this company's catalog.

channelIdslist of integersOptional

The storefront channel IDs in which buyers can access their Company’s Buyer Portal. Use 1 for your store’s default storefront channel.

citystringOptional<=100 characters

City name of the company.

companyEmailstringOptionalformat: "email"<=200 characters

Contact email of this company.

companyNamestringOptional1-200 characters

Name of this company

companyPhonestringOptional<=50 characters

Phone number of the company.

countrystringOptional<=200 characters

Country of the company.

customerGroupIdintegerOptional

The ID of the BigCommerce customer group assigned to the Company account. This field can be static or configurable depending on whether or not your store uses Independent Companies behavior. See Independent Companies Behavior for more information.

extraFieldsobjectOptional

Extra fields you want to add to the company fields.

originChannelIdintegerOptional

The storefront channel ID designated as the origin for the Company administrator. Use 1 for your store’s default storefront channel.

statestringOptional<=50 characters

State of the company.

userExtraFieldslist of objectsOptional

zipCodestringOptional<=50 characters

Zip code of the company.

Response

codeinteger

metalist of objects

dataobject

Errors

400

Bad Request Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/companies/bulk"
4
5	payload = [{}]
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"code": 200,
3	"meta": [
4	{
5	"companyId": 1
6	}
7	],
8	"data": {
9	"id": "string"
10	}
11	}