Skip to navigation

userCompany

Get a company details by user id. Requires a B2B Token.

Arguments

userIdIntegerRequired
B2BEdition user id. This field is required.

Returns

an optional CompanyType
idString
Unique ID of this company
companyNameStringOptional
Company name
bcGroupNameStringOptional
The group name in BigCommerce's group. which must be unique
descriptionStringOptional
A brief introduction to the company
catalogIdStringOptional
Prices list ID of this company
companyStatusIntegerOptional
Company status
addressLine1StringOptional
Company address line 1
addressLine2StringOptional
Company address line 2
cityStringOptional
Company city
stateStringOptional
Company state
zipCodeStringOptional
Zip code of company city
countryStringOptional
Company country
extraFieldslist of optional ExtraFieldsValueTypeOptional
extra fields of this company
customerGroupIdIntegerOptional
Company customer group id