Skip to navigation
RESTB2BManagementCompanyCompanies

Bulk Create Companies

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
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Request

This endpoint expects a list of objects.
companyNamestringRequired<=200 characters
The name of the business associated with the Company account.
companyEmailstringRequiredformat: "email"1-200 characters
The primary email address for the Company account.
companyPhonestringRequired<=50 characters
The primary phone number for the Company account.
countrystringRequired1-200 characters
The country of the primary address for the Company account. This must be either the full name or the ISO2 country code.
adminFirstNamestringRequired1-100 characters
The first name of the Company account administrator.
adminLastNamestringRequired1-100 characters
The last name of the Company account administrator.
adminEmailstringRequiredformat: "email"1-100 characters

The email address of the Company account administrator. If an existing BigCommerce customer account uses this email address, it is automatically linked to the administrator’s Company user account.

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.

addressLine1stringOptional<=200 characters
The first line of the primary address for the Company account.
addressLine2stringOptional<=200 characters
The second line of the primary address for the Company account.
citystringOptional1-100 characters
The city of the primary address for the Company account.
statestringOptional1-50 characters
The state of the primary address for the Company account, if applicable. This must be the full name and not an abbreviation.
zipCodestringOptional<=50 characters
The postal code of the primary address for the Company account.
adminPhoneNumberstringOptional1-100 characters
The phone number of the Company account administrator.
userExtraFieldslist of objectsOptional
Extra fields to apply to the Company administrator user.
acceptWelcomeEmailbooleanOptional
If user accepts, the system sends a welcome email.
extraFieldsobjectOptional
Extra fields you want to add to the company fields.
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.

originChannelIdintegerOptional

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

Response

OK
codeintegerOptional
metalist of objectsOptional
dataobjectOptional

Errors

400
Bad Request Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error