customer

Example Query

mutation ExampleMutation($changePasswordInput: ChangePasswordInput!, $requestResetPasswordInput: RequestResetPasswordInput!, $resetPasswordInput: ResetPasswordInput!, $registerCustomerInput: RegisterCustomerInput!, $updateCustomerInput: UpdateCustomerInput!) {
  customer {
    changePassword(input: $changePasswordInput) {
      errors {
        __typename
        ... on ValidationError {
          message
          path
        }
      }
    }
    requestResetPassword(input: $requestResetPasswordInput) {
      errors {
        __typename
        ... on ValidationError {
          message
          path
        }
      }
    }
    resetPassword(input: $resetPasswordInput) {
      errors {
        __typename
        ... on ValidationError {
          message
          path
        }
      }
    }
    registerCustomer(input: $registerCustomerInput) {
      customer {
        entityId
        company
        customerGroupId
        customerGroupName
        email
        firstName
        lastName
        notes
        phone
        taxExemptCategory
      }
      errors {
        __typename
        ... on EmailAlreadyInUseError {
          message
        }
      }
    }
    updateCustomer(input: $updateCustomerInput) {
      customer {
        entityId
        company
        customerGroupId
        customerGroupName
        email
        firstName
        lastName
        notes
        phone
        taxExemptCategory
      }
      errors {
        __typename
        ... on UnexpectedUpdateCustomerError {
          message
        }
      }
    }
  }
}

Variables

{
  "changePasswordInput": {
    "currentPassword": "example",
    "newPassword": "example"
  },
  "requestResetPasswordInput": {
    "email": "example",
    "path": "example"
  },
  "resetPasswordInput": {
    "customerEntityId": 0,
    "token": "example",
    "newPassword": "example"
  },
  "registerCustomerInput": {
    "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": "2026-11-12T01:25:34.561Z"
        }
      ],
      "texts": [
        {
          "fieldEntityId": 0,
          "text": "example"
        }
      ],
      "multilineTexts": [
        {
          "fieldEntityId": 0,
          "multilineText": "example"
        }
      ],
      "passwords": [
        {
          "fieldEntityId": 0,
          "password": "example"
        }
      ]
    }
  },
  "updateCustomerInput": {
    "firstName": "example",
    "lastName": "example",
    "email": "example",
    "phone": "example",
    "company": "example",
    "formFields": {
      "checkboxes": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityIds": [
            0
          ]
        }
      ],
      "multipleChoices": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityId": 0
        }
      ],
      "numbers": [
        {
          "fieldEntityId": 0,
          "number": 0
        }
      ],
      "dates": [
        {
          "fieldEntityId": 0,
          "date": "2026-11-12T01:25:34.561Z"
        }
      ],
      "texts": [
        {
          "fieldEntityId": 0,
          "text": "example"
        }
      ],
      "multilineTexts": [
        {
          "fieldEntityId": 0,
          "multilineText": "example"
        }
      ],
      "passwords": [
        {
          "fieldEntityId": 0,
          "password": "example"
        }
      ]
    }
  }
}

Example response

{
  "data": {
    "customer": {
      "changePassword": {
        "errors": [
          {
            "__typename": "ValidationError",
            "message": "example",
            "path": [
              "example"
            ]
          }
        ]
      },
      "requestResetPassword": {
        "errors": [
          {
            "__typename": "ValidationError",
            "message": "example",
            "path": [
              "example"
            ]
          }
        ]
      },
      "resetPassword": {
        "errors": [
          {
            "__typename": "ValidationError",
            "message": "example",
            "path": [
              "example"
            ]
          }
        ]
      },
      "registerCustomer": {
        "customer": {
          "entityId": 0,
          "company": "example",
          "customerGroupId": 0,
          "customerGroupName": "example",
          "email": "example",
          "firstName": "example",
          "lastName": "example",
          "notes": "example",
          "phone": "example",
          "taxExemptCategory": "example"
        },
        "errors": [
          {
            "__typename": "EmailAlreadyInUseError",
            "message": "example"
          }
        ]
      },
      "updateCustomer": {
        "customer": {
          "entityId": 0,
          "company": "example",
          "customerGroupId": 0,
          "customerGroupName": "example",
          "email": "example",
          "firstName": "example",
          "lastName": "example",
          "notes": "example",
          "phone": "example",
          "taxExemptCategory": "example"
        },
        "errors": [
          {
            "__typename": "UnexpectedUpdateCustomerError",
            "message": "example"
          }
        ]
      }
    }
  }
}

The customer mutations.

Returns

a CustomerMutations

changePasswordChangePasswordResult

Change the password for a customer.

requestResetPasswordRequestResetPasswordResult

Request reset password email. The link is valid for 12 hours, and requesting a new email invalidates any earlier link.

resetPasswordResetPasswordResult

Reset customer password. A successful reset invalidates the token.

registerCustomerRegisterCustomerResult

updateCustomerUpdateCustomerResult

Update a customer.

addCustomerAddressAddCustomerAddressResult

Submit a customer address.

updateCustomerAddressUpdateCustomerAddressResult

Update a customer address.

deleteCustomerAddressDeleteCustomerAddressResult

Delete a customer address.

storedPaymentInstrumentsStoredPaymentInstrumentMutationsDeprecated

Stored payment instruments mutations.