Customer
Requires 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.
Anchor to FieldsFields
- Anchor to acceptsMarketingaccepts•Boolean!
Marketing non-null Token access required Indicates whether the customer has consented to be sent marketing material via email.
- Anchor to addressesaddresses•Mailing
Address Connection! non-null Token access required A list of addresses for the customer.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to avatarUrlavatar•String
Url Token access required The URL of the customer's avatar image.
- Anchor to createdAtcreated•Date
At Time! non-null Token access required The date and time when the customer was created.
- Anchor to defaultAddressdefault•Mailing
Address Address Token access required The customer’s default address.
- Anchor to displayNamedisplay•String!
Name non-null Token access required The customer’s name, email or phone number.
- Anchor to emailemail•StringToken access required
The customer’s email address.
- Anchor to firstNamefirst•String
Name Token access required The customer’s first name.
- •ID!non-null Token access required
A unique ID for the customer.
- Anchor to lastNamelast•String
Name Token access required The customer’s last name.
- Anchor to metafieldmetafield•MetafieldToken access required
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The identifier for the metafield.
Arguments
- Anchor to metafieldsmetafields•[Metafield]!non-null Token access required
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
The input must not contain more than
250values.
Arguments
- Anchor to numberOfOrdersnumber•Unsigned
Of Orders Int64! non-null Token access required The number of orders that the customer has made at the store in their lifetime.
- Anchor to ordersorders•Order
Connection! non-null Token access required The orders associated with the customer.
- Anchor to firstfirst•Int
Returns up to the first
nelements from the list.- Anchor to afterafter•String
Returns the elements that come after the specified cursor.
- Anchor to lastlast•Int
Returns up to the last
nelements from the list.- Anchor to beforebefore•String
Returns the elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Order
Key Sort Keys Default:ID Sort the underlying list by the given key.
- Anchor to queryquery•String
Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.
- Anchor to processed_at•
Arguments
- Anchor to phonephone•StringToken access required
The customer’s phone number.
- •Social
Login Provider Token access required The social login provider associated with the customer.
- •[String!]!non-null Token access required
A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.
- Anchor to updatedAtupdated•Date
At Time! non-null Token access required The date and time when the customer information was updated.
Anchor to QueriesQueries
- •query
The customer associated with the given access token. Tokens are obtained by using the
mutation.- Anchor to customerAccessTokencustomer•String!
Access Token required The customer access token.
Arguments
Anchor to MutationsMutations
- •mutation
Activates a customer.
- •ID!required
Specifies the customer to activate.
- Anchor to inputinput•Customer
Activate Input! required The fields used to activate a customer.
Arguments
- •ID!
- •mutation
Activates a customer with the activation url received from
.- Anchor to activationUrlactivation•URL!
Url required The customer activation URL.
- Anchor to passwordpassword•String!required
A new password set during activation.
Arguments
- •mutation
Creates a new customer.
- Anchor to inputinput•Customer
Create Input! required The fields used to create a new customer.
Arguments
- •mutation
Updates the default address of an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to addressIdaddress•ID!
Id required ID of the address to set as the new default for the customer.
Arguments
- •mutation
"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the
mutation."- •ID!required
Specifies the customer to reset.
- Anchor to inputinput•Customer
Reset Input! required The fields used to reset a customer’s password.
Arguments
- •ID!
- •mutation
"Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the
mutation."- Anchor to resetUrlreset•URL!
Url required The customer's reset password url.
- Anchor to passwordpassword•String!required
New password that will be set as part of the reset password process.
Arguments
- •mutation
Updates an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to customercustomer•Customer
Update Input! required The customer object input.
Arguments