Shop API - Customers

Manage customer accounts, authentication, and profiles.

Customer Registration

Create a new customer account.

mutation Register($input: CreateCustomerInput!) {
  createCustomer(input: $input) {
    customer {
      id
      firstName
      lastName
      email
      createdAt
    }
  }
}

Variables:

{
  "input": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "password": "SecurePassword123!",
    "passwordConfirmation": "SecurePassword123!"
  }
}

Customer Login

Authenticate a customer and receive an access token.

mutation Login($email: String!, $password: String!) {
  createLogin(input: {
    email: $email
    password: $password
  }) {
    accessToken
    customer {
      id
      firstName
      lastName
      email
    }
  }
}

Variables:

{
  "email": "[email protected]",
  "password": "SecurePassword123!"
}

Get Customer Profile

Retrieve the current customer's profile information.

query GetProfile {
  customer {
    id
    firstName
    lastName
    email
    gender
    dateOfBirth
    addresses {
      edges {
        node {
          id
          firstName
          lastName
          address
          city
          state
          country
        }
      }
    }
  }
}

Update Customer Profile

Update customer profile information.

mutation UpdateProfile($input: UpdateCustomerInput!) {
  updateCustomer(input: $input) {
    customer {
      id
      firstName
      lastName
      email
    }
  }
}

Change Password

Update customer password.

mutation ChangePassword($input: ChangePasswordInput!) {
  changeCustomerPassword(input: $input) {
    status
    message
  }
}

Add Address

Add a new address to customer account.

mutation AddAddress($input: AddAddressInput!) {
  addCustomerAddress(input: $input) {
    address {
      id
      firstName
      lastName
      address
      city
      state
      country
      zipCode
    }
  }
}

Update Address

Update an existing customer address.

mutation UpdateAddress($input: UpdateAddressInput!) {
  updateCustomerAddress(input: $input) {
    address {
      id
      firstName
      address
      city
    }
  }
}

Delete Address

Remove an address from customer account.

mutation DeleteAddress($addressId: String!) {
  deleteCustomerAddress(input: {
    addressId: $addressId
  }) {
    status
  }
}

Forgot Password

Request password reset email.

mutation ForgotPassword($email: String!) {
  forgotPassword(input: {
    email: $email
  }) {
    status
    message
  }
}

Reset Password

Reset password using token from email.

mutation ResetPassword($input: ResetPasswordInput!) {
  resetPassword(input: $input) {
    status
    message
  }
}

Customer Logout

Logout the current customer.

mutation Logout {
  createLogout(input: {}) {
    status
  }
}

Related Resources

• Orders
• Cart
• Addresses