Home > @infiniteobjects/shopify-data-manager > AdminTypes > CustomerInput
The input fields and values to use when creating or updating a customer.
Signature:
export interface CustomerInput
| Property | Modifiers | Type | Description |
|---|---|---|---|
| addresses? | InputMaybe<Array<MailingAddressInput>> | (Optional) The addresses for a customer. | |
| email? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The unique email address of the customer. | |
| emailMarketingConsent? | InputMaybe<CustomerEmailMarketingConsentInput> | (Optional) Information that describes when the customer consented to receiving marketing material by email. The email field is required when creating a customer with email marketing consent information. |
|
| firstName? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The customer’s first name. | |
| id? | InputMaybe<Scalars[‘ID’][‘input’]> | (Optional) The ID of the customer to update. | |
| lastName? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The customer’s last name. | |
| locale? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The customer’s locale. | |
| metafields? | InputMaybe<Array<MetafieldInput>> | (Optional) Additional metafields to associate to the customer. | |
| note? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) A note about the customer. | |
| phone? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The unique phone number for the customer. | |
| smsMarketingConsent? | InputMaybe<CustomerSmsMarketingConsentInput> | (Optional) The marketing consent information when the customer consented to receiving marketing material by SMS. The phone field is required when creating a customer with SMS marketing consent information. |
|
| tags? | InputMaybe<Array<Scalars[‘String’][‘input’]>> | <p>(Optional) A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: ["tag1", "tag2", "tag3"], "tag1, tag2, tag3"</p><p>Updating tags overwrites any existing tags that were previously added to the customer. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation.</p> |
|
| taxExempt? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the customer is exempt from paying taxes on their order. | |
| taxExemptions? | InputMaybe<Array<TaxExemption | `${TaxExemption}`>> | (Optional) The list of tax exemptions to apply to the customer. |