ArchiveB2B EditionV2 APICompany

Update Company Basic Information

Deprecated
Update a company's basic info, you can update on or more options

Authentication

authTokenstring
API Key authentication via header

Path parameters

companyIdstringRequired

Headers

authTokenstringRequired
Auth token in header.

Request

Request body
addressLine1stringOptional
Address string line 1
addressLine2stringOptional
Address string line 2
catalogIdstringOptional

BigCommerce price list Id that company related(If put its 0 will clear the catalog).

citystringOptional
companyEmailstringOptional
companyNamestringOptional
companyStatusstringOptional

Company status:

0=PENDING 1=APPROVED 2=REJECTED 3=INACTIVE 4=DELETED

countrystringOptional

Country full name or ISO2 country code. For Example:

A Country full name: Afghanistan

ISO2 Country code: AF

descriptionstringOptional
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.

phoneNumberstringOptional
statestringOptional
zipCodestringOptional
priceListAssignlist of objectsOptional

Response

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

Errors

404
Not Found Error