Skip to content

Customer GraphQL

Served by CustomerModule on commercetools, CustomerModule on medusa and CustomerModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the customer types page.

Operations

OperationDescriptionServed by
customerQueryThe signed-in customer, or null for an anonymous sessioncommercetoolsmedusasfcc
customerExistsQueryCheck if a customer account exists for the given email address, among the customers who can sign in to the store.commercetoolsmedusasfcc
customerAddressCreateMutationAdd a new address to the customer's address bookcommercetoolsmedusasfcc
customerAddressDeleteMutationRemove an address from the customer's address bookcommercetoolsmedusasfcc
customerAddressUpdateMutationUpdate an existing address in the customer's address bookcommercetoolsmedusasfcc
customerCreateMutationCreate a new customer account with email and passwordcommercetoolsmedusasfcc
customerDefaultAddressUpdateMutationSet the customer's default shipping and/or billing address by referencing an existing address in their address book.commercetoolsmedusasfcc
customerDeleteMutationDelete the current customer account (requires password confirmation)commercetoolsmedusasfcc
customerEmailUpdateMutationUpdate customer email address (requires password for verification)commercetoolsmedusasfcc
customerInformationUpdateMutationUpdate customer billing address informationcommercetoolsmedusasfcc
customerNotificationPreferencesUpdateMutationUpdate the customer's notification and marketing preferences.commercetoolsmedusasfcc
customerPersonalDetailsUpdateMutationUpdate the customer's personal details (name, salutation and phone number) independently of any address.commercetoolsmedusasfcc

Types

TypeDescription
BusinessUnitSwitchErrorUnion
BusinessUnitSwitchResponseObject
CustomerObjectCustomer account information with personal details and business context
CustomerAddressCreateErrorUnion
CustomerAddressCreateResponseObject
CustomerAddressDeleteErrorUnion
CustomerAddressDeleteResponseObject
CustomerAddressUpdateErrorUnion
CustomerAddressUpdateResponseObject
CustomerCreateErrorUnion
CustomerCreateInputInput objectInput data required to create a new customer account
CustomerCreateResponseObject
CustomerDefaultAddressUpdateErrorUnion
CustomerDefaultAddressUpdateResponseObject
CustomerDeleteErrorUnion
CustomerDeleteResponseObject
CustomerEmailUpdateErrorUnion
CustomerEmailUpdateResponseObject
CustomerExistsResultObjectResult type for checking if a customer exists
CustomerInformationUpdateErrorUnion
CustomerInformationUpdateResponseObject
CustomerNotificationPreferencesUpdateErrorUnion
CustomerNotificationPreferencesUpdateResponseObject
CustomerPersonalDetailsInputInput objectPersonal details that can be updated independently of any address
CustomerPersonalDetailsUpdateErrorUnion
CustomerPersonalDetailsUpdateResponseObject
NotificationPreferencesObjectMarketing and notification opt-in preferences for a customer
NotificationPreferencesInputInput objectNotification preference values to update; omitted fields are left unchanged