For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • MUTcreateCart
          • MUTdeleteCart
          • MUTaddCartLineItems
          • MUTupdateCartLineItem
          • MUTdeleteCartLineItem
          • MUTupdateCartCurrency
          • MUTassignCartToCustomer
          • MUTunassignCartFromCustomer
          • MUTcreateCartMetafield
          • MUTupdateCartMetafield
          • MUTdeleteCartMetafield
          • MUTcreateCartRedirectUrls
          • MUTcreateCheckout
          • MUTupdateCheckout
          • MUTaddCheckoutBillingAddress
          • MUTupdateCheckoutBillingAddress
          • MUTupdateCheckoutCustomerMessage
          • MUTselectCheckoutShippingOption
          • MUTapplyCheckoutCoupon
          • MUTunapplyCheckoutCoupon
          • MUTapplyCheckoutGiftCertificate
          • MUTunapplyCheckoutGiftCertificate
          • MUTapplyCheckoutSpamProtection
          • MUTaddCheckoutShippingConsignments
          • MUTupdateCheckoutShippingConsignment
          • MUTdeleteCheckoutConsignment
          • MUTcompleteCheckout
          • MUTlogin
          • MUTlogout
          • MUTcreateWishlist
          • MUTaddWishlistItems
          • MUTdeleteWishlistItems
          • MUTupdateWishlist
          • MUTdeleteWishlists
          • MUTloginWithCustomerLoginJwt
          • MUTsubmitContactUs
          • MUTgenerateSessionSyncJwt
          • MUTvalidateSessionSyncJwt
          • MUTproductViewedEvent
          • MUTpageViewedEvent
          • MUTvisitStartedEvent
          • MUTsearchProductEvent
          • MUTpreviewGiftCertificate
          • MUTregisterCompany
          • MUTaddProductReview
          • MUTchangePassword
          • MUTrequestResetPassword
          • MUTresetPassword
          • MUTregisterCustomer
          • MUTupdateCustomer
          • MUTaddCustomerAddress
          • MUTupdateCustomerAddress
          • MUTdeleteCustomerAddress
          • MUTpayment
          • MUTsubscribe
          • MUTunsubscribe
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontMutations

registerCustomer

Example Query
1mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: RegisterCustomerInput) {
2 registerCustomer(reCaptchaV2: $reCaptchaV2, input: $input) {
3 customer {
4 entityId
5 company
6 customerGroupId
7 customerGroupName
8 email
9 firstName
10 lastName
11 notes
12 phone
13 taxExemptCategory
14 }
15 errors
16 }
17}
Variables
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}
Example response
1{
2 "data": {
3 "registerCustomer": {
4 "customer": {
5 "entityId": 0,
6 "company": "example",
7 "customerGroupId": 0,
8 "customerGroupName": "example",
9 "email": "example",
10 "firstName": "example",
11 "lastName": "example",
12 "notes": "example",
13 "phone": "example",
14 "taxExemptCategory": "example"
15 },
16 "errors": [
17 {
18 "message": "example"
19 }
20 ]
21 }
22 }
23}
Register a new customer.
Was this page helpful?
Previous

resetPassword

Next

updateCustomer

Built with

Arguments

reCaptchaV2ReCaptchaV2InputOptional
Recaptcha token.
inputRegisterCustomerInputRequired
Input for the customer registration.

Returns

a RegisterCustomerResult
errorslist of RegisterCustomerErrors
The errors, if any, that occured during the registration.
customerCustomer
The customer that was registered.