For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Types
Inputs
CompanyInputType
INPUT
Copy page
Input fields
storeHash
String
Required
The store hash. This field is required.
customerId
String
Required
Company admin manager's customer user ID in BigCommerce. This field is required.
companyName
String
Required
Company name. This field is required.
addressLine1
String
Required
Company address line. This field is required.
city
String
Required
City where company is located. This field is required.
country
String
Required
Country where company is located. This field is required.
state
String
Required
State where company is located. This field is required.
zipCode
String
Required
Zip Code for the company. This field is required.
customerEmail
String
Optional
Company admin manager's customer email.
companyEmail
String
Optional
Company email
addressLine2
String
Optional
Another company address line
companyPhoneNumber
String
Optional
Company phone number.
extraFields
list of optional
CompanyExtraField
Optional
extra fields of this company
Show 2 fields
fileList
list of optional
CompanyAttachedFile
Optional
attach file list of this company
Show 4 fields
userExtraFields
list of optional
CompanyUserExtraField
Optional
user extra fields
Show 2 fields
channelId
Integer
Optional
Admin user's channel ID of this company
addressExtraFields
list of optional
CompanyAddressExtraField
Optional
extra fields of this address
Show 2 fields
Referenced by
Mutations
companyCreate(companyData)