For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
        • Overview
        • API Reference
              • GETList Companies
              • POSTCreate Company
              • GETGet Company Detail
              • PUTUpdate Company
              • DELDelete Company
              • POSTConvert from BigCommerce CustomerGroup into Company
              • POSTBulk Create Companies
              • PUTUpdate Companies (batch)
              • PUTUpdate Company's Catalog
              • PUTUpdate Company's Status
              • GETList Company Extra Field Configs
              • GETList Company Attachments
              • POSTAdd Company Attachment
              • DELDelete Company Attachment
              • GETList Company Subsidiaries
              • DELDelete Company Subsidiary
              • POSTAttach Company as Parent to Current Company
              • GETList Company Hierarchy
Dev Portal
LogoLogo
Closed Beta ProgramsB2B Edition UpdatesAPI ReferenceCompany

Convert from BigCommerce CustomerGroup into Company

Beta
POST
https://api-b2b.bigcommerce.com/api/v3/io/customer-groups/:customerGroupId/companies
POST
/api/v3/io/customer-groups/:customerGroupId/companies
$curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/customer-groups/customerGroupId/companies \
> -H "authToken: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "companyName": "Acme Industrial Supplies",
> "companyPhone": "+1-555-123-4567",
> "companyEmail": "contact@acmeindustrial.com",
> "country": "USA",
> "adminEmail": "j.doe@acmeindustrial.com",
> "adminPhoneNumber": "+1-555-987-6543",
> "addressLine1": "1234 Industrial Way",
> "addressLine2": "Suite 100",
> "city": "Springfield",
> "state": "IL",
> "zipCode": "62704",
> "adminFirstName": "John",
> "adminLastName": "Doe",
> "catalogId": 42,
> "acceptCreationEmail": true,
> "extraFields": [
> {
> "fieldName": "TaxID",
> "fieldValue": "98-7654321"
> }
> ],
> "description": "Leading supplier of industrial equipment and tools."
>}'
1{
2 "code": 200,
3 "data": {
4 "companyId": "147340"
5 },
6 "meta": {
7 "message": "SUCCESS"
8 }
9}
Create company from a BigCommerce customer group. * This API is turned off for the MSF store. * This API is turned off when the independent company feature is enabled.
Was this page helpful?
Previous

Delete Company

Next

Bulk Create Companies

Built with

Create company from a BigCommerce customer group.

  • This API is turned off for the MSF store.
  • This API is turned off when the independent company feature is enabled.

Authentication

authTokenstring

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

Path parameters

customerGroupIdstringRequired

Request

User Extra Field Values
companyNamestringRequired>=1 character
Company name
companyPhonestringRequired>=1 character
Company phone number
companyEmailstringRequired>=1 character
Company email
countrystringRequired>=1 character
adminEmailstringRequired>=1 character
adminPhoneNumberstringRequired>=1 character
addressLine1stringOptional>=1 character
addressLine2stringOptional>=1 character
citystringOptional>=1 character
statestringOptional>=1 character
zipCodestringOptional>=1 character
adminFirstNamestringOptional>=1 character
adminLastNamestringOptional>=1 character
catalogIdintegerOptional
The company catalog ID
acceptCreationEmailbooleanOptionalDefaults to false
If the company creation can accept email
extraFieldslist of objectsOptional
userExtraFieldslist of objectsOptional

Response

OK
codeinteger
dataobject
metaobject

Errors

400
Bad Request Error
404
Not Found Error