Create Company From CG

Deprecated

Create company from bigCommerce customer group. This API only enable for non-MSF store.

Authentication

authTokenstring
API Key authentication via header

Headers

authTokenstringRequired
Auth token in header.

Request

Request body
adminEmailstringRequired
Company admin user email
adminFirstNamestringRequired
Company admin user's first name
adminLastNamestringRequired
Company admin user's last name
companyEmailstringRequired
companyNamestringRequired
customerGroupIdstringRequired
BC customer group ID
phoneNumberstringRequired
acceptWelcomeEmailenumOptional

(0=will not receive email 1=will receive email)

Allowed values:
addressLine1stringOptional
Address string line 1
addressLine2stringOptional
Address string line 2
adminPhoneNumberstringOptional
Company admin user phone number
citystringOptional
countrystringOptional
extraFieldslist of objectsOptional

To use customized extra fields with field names you need to first add company extra fields in Settings > Extra fields inside B2B edition. eg. If you want to create a new company with an extra integer field named licenseNO, you can use this structure [{‘fieldName’: ‘LicenseNO’, ‘fieldValue’: 10342340323}] in the request body.

statestringOptional
userExtraFieldslist of objectsOptional
zipCodestringOptional

Response

Response Success
codedouble
Response status code
dataobject
Response data
messagestring
Response message

Errors

400
Bad Request Error
404
Not Found Error