Edit in GitHubLog an issue
Adobe Commerce only. Learn more

Manage company objects

This section describes the REST endpoints used to manage Company objects.

Service Name:

companyCompanyRepositoryV1

REST Endpoints:

Copied to your clipboard
POST /V1/company/
PUT /V1/company/:companyId
GET /V1/company/:companyId
DELETE /V1/company/:companyId
GET /V1/company/

CompanyInterface Parameters:

The following table lists the parameters defined in CompanyInterface.

NameDescriptionFormatRequirements
id
System-generated company ID
integer
Required for updates and deletes.
status
0 - Pending approval
1 - Approved
2 - Rejected
3 - Blocked
integer
Optional
company_name
Company name
string
Required to create or update a company.
legal_name
Legal name
string
Optional
company_email
Official email address of the company. It does not have to be unique.
string
Required to create or update a company.
vat_tax_id
The company's Value Added Tax ID
string
Optional
reseller_id
Unique ID of the company reseller
string
Optional
comment
Additional details about the company
string
Optional
street
Street address where the company is registered. The array can contain one or two lines.
Array[string]
Required to create or update a company.
city
The company's city
string
Required to create or update a company.
country_id
The country where the company is registered.
string
Required to create or update a company.
region
State or province
string
Required to create or update a company.
region_id
An ID assigned to a state or province
string
Optional
postcode
The company's ZIP or postal code
string
Required to create or update a company.
telephone
The company contact's phone number
string
Required to create or update a company.
customer_group_id
Defines the company's shared catalog. A value of 1 assigns the default shared catalog.
integer
Required to create or update a company.
sales_representative_id
User ID of the Sales Representative for the company
integer
Optional
reject_reason
Specifies why a company's request to be a B2B customer is rejected
string
Optional
rejected_at
A timestamp indicating when the company was rejected.
string
Optional
super_user_id
The customer_id of the company administrator. When creating a company, the customer_id must already exist.
integer
Required to create or update a company.

Create a company

The following example creates a company and assigns the default shared catalog (customer_group_id). The company admin (super_user_id) must be a previously-defined customer_id.

Sample Usage:

POST <host>/rest/<store_code>/V1/company/

Copied to your clipboard
{
"company": {
"company_name": "Test company",
"company_email": "newemail@example.com",
"street":[
"100 Big Tree Avenue"
],
"city": "San Francisco",
"country_id": "US",
"region": "CA",
"region_id": "12",
"postcode": "99999",
"telephone": "4155551212",
"super_user_id": 5,
"customer_group_id": 1
}
}

Update the company

The following call changes the company status to Rejected (2) and explains why.

Sample Usage:

PUT <host>/rest/<store_code>/V1/company/2

Copied to your clipboard
{
"company": {
"id": 2,
"company_name": "Test company",
"company_email": "newemail@example.com",
"customer_group_id": 1,
"street":[
"100 Big Tree Avenue"
],
"city": "San Francisco",
"country_id": "US",
"region": "CA",
"region_id": "12",
"postcode": "99999",
"telephone": "4155551212",
"super_user_id": 5,
"status": 2,
"reject_reason": "Failed background check."
}
}

Return all information about a company

This call returns detailed information about the specified company. Sample Usage:

GET <host>/rest/<store_code>/V1/company/2

Copied to your clipboard
// none

Delete a company

When you delete a company, Adobe Commerce assigns the "Inactive" status to all company members. The system also removes company ID from the customer profile of all company members.

Sample Usage:

DELETE <host>/rest/<store_code>/V1/company/2

Copied to your clipboard
// none

Search for companies

The following call returns all companies that are located in California (region_id = 12)

See Search using REST APIs for information about constructing a search query.

Sample Usage:

GET <host>/rest/<store_code>/V1/company?searchCriteria[filter_groups][0][filters][0][field]=region_id&searchCriteria[filter_groups][0][filters][0][value]=12&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Copied to your clipboard
// none
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.