BigCommerce Docs

mutation ExampleMutation($input: RegisterCompanyInput) {
  registerCompany(input: $input) {
    entityId
    status
    errors
  }
}

{
  "input": {
    "name": "example",
    "email": "example",
    "phone": "example",
    "fileList": [
      {
        "fileId": "example"
      }
    ],
    "companyUser": {
      "extraFields": {
        "multipleChoices": [
          {
            "name": "example",
            "fieldValue": "example"
          }
        ],
        "numbers": [
          {
            "name": "example",
            "number": "BigDecimal"
          }
        ],
        "texts": [
          {
            "name": "example",
            "text": "example"
          }
        ],
        "multilineTexts": [
          {
            "name": "example",
            "multilineText": "example"
          }
        ]
      }
    },
    "extraFields": {
      "multipleChoices": [
        {
          "name": "example",
          "fieldValue": "example"
        }
      ],
      "numbers": [
        {
          "name": "example",
          "number": "BigDecimal"
        }
      ],
      "texts": [
        {
          "name": "example",
          "text": "example"
        }
      ],
      "multilineTexts": [
        {
          "name": "example",
          "multilineText": "example"
        }
      ]
    },
    "address": {
      "firstName": "example",
      "lastName": "example",
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "stateOrProvince": "example",
      "phone": "example",
      "postalCode": "example",
      "extraFields": {
        "multipleChoices": [
          {
            "name": "example",
            "fieldValue": "example"
          }
        ],
        "numbers": [
          {
            "name": "example",
            "number": "BigDecimal"
          }
        ],
        "texts": [
          {
            "name": "example",
            "text": "example"
          }
        ],
        "multilineTexts": [
          {
            "name": "example",
            "multilineText": "example"
          }
        ]
      }
    }
  }
}

{
  "data": {
    "registerCompany": {
      "entityId": 0,
      "status": "APPROVED",
      "errors": [
        {
          "path": [
            "example"
          ],
          "message": "example"
        }
      ]
    }
  }
}

Arguments

inputRegisterCompanyInputRequired

The values to use for company registration.

Returns

a RegisterCompanyResult

errorslist of RegisterCompanyErrors

List of errors that occurred during registration.

entityIdInteger

The unique identifier of the registered company.

statusEnum

The current status of the registration process (e.g., PENDING, APPROVED).

Allowed values:

1	{
2	"input": {
3	"name": "example",
4	"email": "example",
5	"phone": "example",
6	"fileList": [
7	{
8	"fileId": "example"
9	}
10	],
11	"companyUser": {
12	"extraFields": {
13	"multipleChoices": [
14	{
15	"name": "example",
16	"fieldValue": "example"
17	}
18	],
19	"numbers": [
20	{
21	"name": "example",
22	"number": "BigDecimal"
23	}
24	],
25	"texts": [
26	{
27	"name": "example",
28	"text": "example"
29	}
30	],
31	"multilineTexts": [
32	{
33	"name": "example",
34	"multilineText": "example"
35	}
36	]
37	}
38	},
39	"extraFields": {
40	"multipleChoices": [
41	{
42	"name": "example",
43	"fieldValue": "example"
44	}
45	],
46	"numbers": [
47	{
48	"name": "example",
49	"number": "BigDecimal"
50	}
51	],
52	"texts": [
53	{
54	"name": "example",
55	"text": "example"
56	}
57	],
58	"multilineTexts": [
59	{
60	"name": "example",
61	"multilineText": "example"
62	}
63	]
64	},
65	"address": {
66	"firstName": "example",
67	"lastName": "example",
68	"address1": "example",
69	"address2": "example",
70	"city": "example",
71	"countryCode": "example",
72	"stateOrProvince": "example",
73	"phone": "example",
74	"postalCode": "example",
75	"extraFields": {
76	"multipleChoices": [
77	{
78	"name": "example",
79	"fieldValue": "example"
80	}
81	],
82	"numbers": [
83	{
84	"name": "example",
85	"number": "BigDecimal"
86	}
87	],
88	"texts": [
89	{
90	"name": "example",
91	"text": "example"
92	}
93	],
94	"multilineTexts": [
95	{
96	"name": "example",
97	"multilineText": "example"
98	}
99	]
100	}
101	}
102	}
103	}