Customer
Required access
unauthenticated_read_customers
access scope
A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.
Show definition# A customer represents a customer account with the shop. Customer accounts store # contact information for the customer, saving logged-in customers the trouble of # having to provide it at every checkout. type Customer { # Indicates whether the customer has consented to be sent marketing material via email. acceptsMarketing: Boolean! # A list of addresses for the customer. addresses( # Returns the elements that come after the specified cursor. after: String # Returns the elements that come before the specified cursor. before: String # Returns up to the first `n` elements from the list. first: Int # Returns up to the last `n` elements from the list. last: Int # Reverse the order of the underlying list. reverse: Boolean = false ): MailingAddressConnection! # The date and time when the customer was created. createdAt: DateTime! # The customer’s default address. defaultAddress: MailingAddress # The customer’s name, email or phone number. displayName: String! # The customer’s email address. email: String # The customer’s first name. firstName: String # A unique identifier for the customer. id: ID! # The customer's most recently updated, incomplete checkout. lastIncompleteCheckout: Checkout # The customer’s last name. lastName: String # The orders associated with the customer. orders( # Returns the elements that come after the specified cursor. after: String # Returns the elements that come before the specified cursor. before: String # Returns up to the first `n` elements from the list. first: Int # Returns up to the last `n` elements from the list. last: Int # Supported filter parameters: # - `processed_at` # # See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax). query: String # Reverse the order of the underlying list. reverse: Boolean = false # Sort the underlying list by the given key. sortKey: OrderSortKeys = ID ): OrderConnection! # The customer’s phone number. phone: String # A list of tags assigned to the customer. # Additional access scope required: unauthenticated_read_customer_tags. tags: [String!]! # The date and time when the customer information was updated. updatedAt: DateTime! }
Connections
addresses
(MailingAddressConnection!
)
A list of addresses for the customer.
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
orders
(OrderConnection!
)
The orders associated with the customer.
Argument | Type | Default | Description |
---|---|---|---|
after
|
String
|
|
Returns the elements that come after the specified cursor. |
before
|
String
|
|
Returns the elements that come before the specified cursor. |
first
|
Int
|
|
Returns up to the first |
last
|
Int
|
|
Returns up to the last |
query
|
String
|
|
Supported filter parameters:
See the detailed search syntax. |
reverse
|
Boolean
|
|
Reverse the order of the underlying list. |
sortKey
|
OrderSortKeys
|
|
Sort the underlying list by the given key. |
Fields
acceptsMarketing
(Boolean!
)
Indicates whether the customer has consented to be sent marketing material via email.
tags
([String!]!
)
A list of tags assigned to the customer. Additional access scope required: unauthenticated_read_customer_tags.
Required access
unauthenticated_read_customer_tags
access scope