Customer

object

Information about a customer.

Fields

createdAt ● Date!non-null

The date and time when the customer was created.
Format: ISO 8601.
Example: 2024-08-31T02:20:26+08:00

displayName ● String

The customer's display name.

acceptsMarketing ● Boolean

Whether the customer has subscribed to marketing information via email.

true: Subscribed
false: Not subscribed

defaultAddress ● MailingAddress

The customer's default address.

email ● String

The customer's email address.

firstName ● String

The customer's first name.

id ● ID!non-null

The customer ID.

lastName ● String

The customer's last name.

phone ● String

The customer's phone number.

tags ● String

The tags attached to the customer.

updatedAt ● Date

The date and time when the customer was last updated.
Format: ISO 8601.
Example: 2024-08-31T02:20:26+08:00

eraseTime ● String

The time when the customer's account was canceled, formatted as a 13-digit millisecond timestamp.
Example: 1729822782000

logoutStatus ● Int

The customer's account cancellation status. You can control whether to display the account cancellation button on the storefront based on the account cancellation status. Valid values are:

1: Uncancellable. You can hide the account cancellation button on the storefront.
2: Cancellable. You can display the account cancellation button on the storefront.
3: Cancellation in progress. The state indicates that the account is currently in a cooling-off period.

orders ● OrderConnection

A list of orders associated with the customer.

addresses ● AddressConnection

A list of the customer's addresses.

birthday ● String

The customer's date of birth. Format: yyyyMMdd.
Example: 19931231

gender ● String

The customer's gender. Valid values are: