CustomerInput - admin-graphql - INPUT_OBJECT

Version: 2024-10

Description:

The input fields and values to use when creating or updating a customer.

Access Scopes

Fields

  • addresses: MailingAddressInput - The addresses for a customer.
  • email: String - The unique email address of the customer.
  • emailMarketingConsent: CustomerEmailMarketingConsentInput - 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: String - The customer's first name.
  • id: ID - The ID of the customer to update.
  • lastName: String - The customer's last name.
  • locale: String - The customer's locale.
  • metafields: MetafieldInput - Additional metafields to associate to the customer.
  • note: String - A note about the customer.
  • phone: String - The unique phone number for the customer.
  • privateMetafields: PrivateMetafieldInput - The private metafields to associate with the customer.
  • smsMarketingConsent: CustomerSmsMarketingConsentInput - 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: String - 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"` 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.
  • taxExempt: Boolean - Whether the customer is exempt from paying taxes on their order.
  • taxExemptions: TaxExemption - The list of tax exemptions to apply to the customer.

Input objects with this input object

  • customerCreate
  • customerUpdate

Examples