Skip to main content

CustomerUpdateInput

Input for updating a Customer

input CustomerUpdateInput {
customerId: ID!
defaultBillingAddressId: ID
defaultShippingAddressId: ID
emailAddress: String
emailMarketingConsent: CustomerMarketingConsentInput
externalCustomerId: ID
firstName: String
lastName: String
phoneNumber: String
smsMarketingConsent: CustomerMarketingConsentInput
status: CustomerStatus
tags: [String]
}

Fields

CustomerUpdateInput.customerId ● ID! non-null scalar

CustomerUpdateInput.defaultBillingAddressId ● ID scalar

The CustomerAddressId for the default billing address for this Customer

CustomerUpdateInput.defaultShippingAddressId ● ID scalar

The CustomerAddressId for the default shipping address for this Customer

CustomerUpdateInput.emailAddress ● String scalar

The email address associated with the Customer, must be unique to the storefront, limit 256 characters

CustomerUpdateInput.emailMarketingConsent ● CustomerMarketingConsentInput input

CustomerUpdateInput.externalCustomerId ● ID scalar

Reference to the storefront's customer authentication system. Limit 256 characters. This field is required if this customer is going to access any authenticated data (like their orders).

CustomerUpdateInput.firstName ● String scalar

The first name of the Customer, limit 256 characters

CustomerUpdateInput.lastName ● String scalar

The last name of the Customer, limit 256 characters

CustomerUpdateInput.phoneNumber ● String scalar

Must be unique to the Storefront. Limit 64 characters. Format +11231231234

CustomerUpdateInput.smsMarketingConsent ● CustomerMarketingConsentInput input

CustomerUpdateInput.status ● CustomerStatus enum

CustomerUpdateInput.tags ● [String] list scalar

Member of

updateCustomer mutation