createCompany mutation

The createCompany mutation creates a company at the request of either a customer or a guest. The company definition includes the first name, last name, and email address of the company administrator. The email address assigned to the account cannot already exist in the system. Therefore, a customer attempting to create a company cannot use the same email address they used to log in to the storefront.

The company administrator cannot log in or perform additional company-related tasks until a Magento administrator approves the request to create a company.

Syntax

1
2
3
4
5
6
7
mutation {
  createCompany(
    input: CompanyCreateInput!
  ) {
    CreateCompanyOutput
  }
}

Example usage

The following call creates a company on behalf of a guest.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
mutation {
  createCompany(input: {
    company_name: "TestCo"
    company_email: "tgarofalo@example.com"
    company_admin: {
      email: "tgarofalo@example.com"
      firstname: "Taina"
      lastname:"Garofalo"
    }
    legal_name: "TestCo Inc."
    legal_address: {
      street: [
        "100 Big Oak Tree Dr"
      ]
      city: "San Francisco"
      region: {
        region_code: "CA"
      }
      postcode: "99999"
      country_id: US
      telephone: "555 867-5309"
    }
  }){
    company {
      id
      name
      company_admin {
        email
        firstname
        lastname
      }
      legal_address {
        street
        city
        region {
          region_code
          region_id
        }
        postcode
        telephone
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "data": {
    "createCompany": {
      "company": {
        "id": "MQ==",
        "name": "TestCo",
        "company_admin": {
          "email": "tgarofalo@example.com",
          "firstname": "Taina",
          "lastname": "Garofalo"
        },
        "legal_address": {
          "street": [
            "100 Big Oak Tree Dr"
          ],
          "city": "San Francisco",
          "region": {
            "region_code": "CA",
            "region_id": 12
          },
          "postcode": "99999",
          "telephone": "555 867-5309"
        }
      }
    }
  }
}

Input attributes

The CompanyCreateInput object defines the schema for creating an entity.

CompanyAdminInput attributes

The CompanyAdminInput object can contain the following attributes.

CompanyLegalAddressCreateInput attributes

The CompanyLegalAddressCreateInput object can contain the following attributes.

Output attributes

The CreateCompanyOutput object contains the Company object.

The Company object can contain the following attributes:

CompanyAclResource attributes

The CompanyAclResource object can contain the following attributes.

CompanyAdmin attributes

The CompanyAdmin object can contain the following attributes.

CompanyCredit

The CompanyCredit object can contain the following attributes.

CompanyCreditHistory attributes

The CompanyCreditHistory object can contain the following attributes.

CompanyCreditHistoryFilterInput attributes

The CompanyCreditHistoryFilterInput object can contain the following attributes.

CompanyCreditOperation attributes

The CompanyCreditOperation object can contain the following attributes.

CompanyCreditOperationUser attributes

The CompanyCreditOperationUser object can contain the following attributes.

CompanyLegalAddress attributes

The CompanyLegalAddress object can contain the following attributes.

CompanyRole attributes

The CompanyRole object can contain the following attributes.

CompanyRoles attributes

The CompanyRoles object can contain the following attributes.

CompanySalesRepresentative attributes

The CompanySalesRepresentative object can contain the following attributes.

CompanyStructure attributes

The CompanyStructure object can contain the following attribute.

CompanyStructureItem attributes

The CompanyStructureItem object can contain the following attributes.

CompanyTeam attributes

The CompanyTeam object contains details about a company team. It contains the following attributes.

CompanyUsers attributes

The CompanyUsers object can contain the following attributes.

Related topics

• updateCompany mutation