BigCommerce Docs

mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: RegisterCustomerInput) {
  registerCustomer(reCaptchaV2: $reCaptchaV2, input: $input) {
    customer {
      entityId
      company
      customerGroupId
      customerGroupName
      email
      firstName
      lastName
      notes
      phone
      taxExemptCategory
    }
    errors
  }
}

{
  "reCaptchaV2": {
    "token": "example"
  },
  "input": {
    "firstName": "example",
    "lastName": "example",
    "email": "example",
    "password": "example",
    "phone": "example",
    "company": "example",
    "address": {
      "firstName": "example",
      "lastName": "example",
      "address1": "example",
      "address2": "example",
      "city": "example",
      "company": "example",
      "countryCode": "example",
      "stateOrProvince": "example",
      "phone": "example",
      "postalCode": "example"
    },
    "formFields": {
      "checkboxes": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityIds": [
            0
          ]
        }
      ],
      "multipleChoices": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityId": 0
        }
      ],
      "numbers": [
        {
          "fieldEntityId": 0,
          "number": 0
        }
      ],
      "dates": [
        {
          "fieldEntityId": 0,
          "date": "DateTime"
        }
      ],
      "texts": [
        {
          "fieldEntityId": 0,
          "text": "example"
        }
      ],
      "multilineTexts": [
        {
          "fieldEntityId": 0,
          "multilineText": "example"
        }
      ],
      "passwords": [
        {
          "fieldEntityId": 0,
          "password": "example"
        }
      ]
    }
  }
}

{
  "data": {
    "registerCustomer": {
      "customer": {
        "entityId": 0,
        "company": "example",
        "customerGroupId": 0,
        "customerGroupName": "example",
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "notes": "example",
        "phone": "example",
        "taxExemptCategory": "example"
      },
      "errors": [
        {
          "message": "example"
        }
      ]
    }
  }
}

Arguments

reCaptchaV2ReCaptchaV2InputOptional

Recaptcha token.

inputRegisterCustomerInputRequired

Input for the customer registration.

Returns

a RegisterCustomerResult

errorslist of RegisterCustomerErrors

The errors, if any, that occurred during the registration.

customerCustomer

The customer that was registered.

1	{
2	"reCaptchaV2": {
3	"token": "example"
4	},
5	"input": {
6	"firstName": "example",
7	"lastName": "example",
8	"email": "example",
9	"password": "example",
10	"phone": "example",
11	"company": "example",
12	"address": {
13	"firstName": "example",
14	"lastName": "example",
15	"address1": "example",
16	"address2": "example",
17	"city": "example",
18	"company": "example",
19	"countryCode": "example",
20	"stateOrProvince": "example",
21	"phone": "example",
22	"postalCode": "example"
23	},
24	"formFields": {
25	"checkboxes": [
26	{
27	"fieldEntityId": 0,
28	"fieldValueEntityIds": [
29	0
30	]
31	}
32	],
33	"multipleChoices": [
34	{
35	"fieldEntityId": 0,
36	"fieldValueEntityId": 0
37	}
38	],
39	"numbers": [
40	{
41	"fieldEntityId": 0,
42	"number": 0
43	}
44	],
45	"dates": [
46	{
47	"fieldEntityId": 0,
48	"date": "DateTime"
49	}
50	],
51	"texts": [
52	{
53	"fieldEntityId": 0,
54	"text": "example"
55	}
56	],
57	"multilineTexts": [
58	{
59	"fieldEntityId": 0,
60	"multilineText": "example"
61	}
62	],
63	"passwords": [
64	{
65	"fieldEntityId": 0,
66	"password": "example"
67	}
68	]
69	}
70	}
71	}