Customer types
This list contains all query and input types for the customer endpoints.
Customer
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product.
- Name
_id
- Type
- Int!
- Description
Unique number identifier for the product.
- Name
created_at
- Type
- TimeStamp!
- Description
Timestamp of when the product was created.
- Name
email
- Type
- Email!
- Description
The customer email address.
- Name
phone
- Type
- String!
- Description
The customer phone number.
- Name
first_name
- Type
- String!
- Description
The customer first name.
- Name
last_name
- Type
- String!
- Description
The customer last name.
- Name
full_name
- Type
- String!
- Description
The customer full name.
- Name
location
- Type
- String
- Description
The customer location.
- Name
avatar
- Type
- String!
- Description
The customer avatar.
- Name
accepts_marketing
- Type
- Boolean!
- Description
The customer avatar.
- Name
notes
- Type
- String
- Description
The customer notes.
- Name
orders
- Label
[Order!]!
- Description
The customer orders.
- Name
shipping_address
- Label
Address
- Description
The customer shipping address.
- Name
billing_address
- Label
Address
- Description
The customer billing address.
- Name
expenses
- Type
- Float!
- Description
The customer expenses.
- Name
orders_count
- Type
- Int!
- Description
The customer expenses.
- Name
summary
- Label
CustomerSummary!
- Description
The customer summary.
- Name
custom
- Type
- CustomFields!
- Description
The customer custom fields.
scalar CustomFields
- Name
leads
- Type
- [Lead!]!
- Description
The customer leads.
- Name
tags
- Type
- [String!]!
- Description
The customer tags.
Request
query CustomersQuery($first: Int, $after: String, $query: String!){
customers(query: "order_by:id order_dir:desc", after: "WzVE4OTA5LDEe/4OTA5XQ==", first: 10){
edges{
node{
id
email
phone
...
}
}
}
}
InputUpdateCustomer
Fields
- Name
email
- Type
- String
- Description
The customer email address.
- Name
phone
- Type
- String
- Description
The customer phone number.
- Name
first_name
- Type
- String
- Description
The customer first name.
- Name
last_name
- Type
- String
- Description
The customer last name.
- Name
accepts_marketing
- Type
- Boolean
- Description
The customer avatar.
- Name
notes
- Type
- String
- Description
The customer notes.
- Name
shipping_address
- Label
InputAddress
- Description
The customer shipping address.
- Name
billing_address
- Label
InputAddress
- Description
The customer billing address.
- Name
custom
- Type
- CustomFields
- Description
The customer custom fields.
scalar CustomFields
- Name
tags
- Type
- [String!]
- Description
The customer tags.
Request
mutation updateCustomerMutation($node: InputUpdateCustomer!, $id: Int!){
updateCustomer(node: $node, id: $id){
# Customer type fields
}
}
InputCustomer
Fields
- Name
email
- Type
- String!
- Description
The customer email address.
- Name
phone
- Type
- String!
- Description
The customer phone number.
- Name
first_name
- Type
- String!
- Description
The customer first name.
- Name
last_name
- Type
- String!
- Description
The customer last name.
- Name
accepts_marketing
- Type
- Boolean!
- Description
The customer avatar.
- Name
shipping_address
- Label
InputAddress
- Description
The customer shipping address.
- Name
billing_address
- Label
InputAddress
- Description
The customer billing address.
- Name
tags
- Type
- [String!]!
- Description
The customer tags.
Request
mutation mutationName($node: InputCustomer!) {
createCustomer(node: $node){
# Customer type fields
}
}
InputAddress
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the customer.
- Name
_id
- Type
- Int!
- Description
Unique number identifier for the customer.
- Name
line1
- Type
- String!
- Description
The customer first address line.
- Name
line2
- Type
- String!
- Description
The customer secondary address line.
- Name
city
- Type
- String!
- Description
The customer city.
- Name
area
- Type
- String!
- Description
The customer area.
- Name
country
- Type
- String
- Description
The customer country.
- Name
first_name
- Type
- String!
- Description
The customer first name.
- Name
last_name
- Type
- String!
- Description
The customer last name.
- Name
zip
- Type
- String!
- Description
The customer zip.
- Name
state
- Type
- String!
- Description
The customer state.
- Name
email
- Type
- String!
- Description
The customer email address.
- Name
phone
- Type
- String!
- Description
The customer phone number.
Address
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the customer.
- Name
_id
- Type
- Int!
- Description
Unique number identifier for the customer.
- Name
line1
- Type
- String!
- Description
The customer first address line.
- Name
line2
- Type
- String!
- Description
The customer secondary address line.
- Name
city
- Type
- String!
- Description
The customer city.
- Name
area
- Type
- String!
- Description
The customer area.
- Name
country
- Type
- String
- Description
The customer country.
- Name
first_name
- Type
- String!
- Description
The customer first name.
- Name
last_name
- Type
- String!
- Description
The customer last name.
- Name
zip
- Type
- String!
- Description
The customer zip.
- Name
state
- Type
- String!
- Description
The customer state.
- Name
email
- Type
- String!
- Description
The customer email address.
- Name
phone
- Type
- String!
- Description
The customer phone number.
- Name
toString
- Type
- String!
- Description
The toString field.
CustomerSummary
Fields
- Name
lastOrder
- Type
- TimeStamp
- Description
The customer expenses.
Arguments
- Name
format
- Type
- String
- Description
The customer expenses.
- Name
suffix
- Type
- Boolean
- Description
The customer expenses.
Example
lastOrder(format: String = "fromNow", suffix: Boolean = true)
- Name
expenses
- Type
- Float!
- Description
The customer expenses.
- Name
orders
- Type
- Int!
- Description
The customer expenses.
CustomerConnection
Fields
- Name
pageInfo
- Type
- PageInfo!
- Description
Customer connection page info.
type PageInfo { hasNextPage: Boolean! hasPreviousPage: Boolean! startCursor: String endCursor: String }
- Name
edges
- Type
- [CustomerEdge]
- Description
The Customer connection edges.
type CustomerEdge { node: Customer cursor: String! }