Customer types
This list contains all query and input types for the customer endpoints.
Customer
Fields
- Name
_id- Type
- Int!
- Description
Unique number identifier for the product.
- Name
accepts_marketing- Type
- Boolean!
- Description
The customer avatar.
- Name
avatar- Type
- String!
- Description
The customer avatar.
- Name
billing_address- Label
Address- Description
The customer billing address.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the product was created. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
custom- Label
CustomFields- Description
The customer custom fields.
- Name
email- Label
Email!- Description
The customer email address.
- Name
expenses- Type
- Float!
- Description
The customer expenses.
- Name
first_name- Type
- String!
- Description
The customer first name.
- Name
full_name- Type
- String!
- Description
The customer full name.
- Name
id- Type
- ID!
- Description
Unique identifier for the product.
- Name
last_name- Type
- String!
- Description
The customer last name.
- Name
leads- Label
[Lead!]!- Description
The customer leads.
- Name
location- Type
- String
- Description
The customer location.
- Name
notes- Type
- String
- Description
The customer notes.
- Name
orders_count- Type
- Int!
- Description
The customer orders_count.
- Name
phone- Type
- String!
- Description
The customer phone number.
- Name
shipping_address- Label
Address- Description
The customer shipping address.
- Name
summary- Label
CustomerSummary!- Description
The customer summary.
- Name
tags- Type
- [String!]!
- Description
The customer tags.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the product was updated. Arguments:
format: String = "fromNow",suffix: Boolean = true
InputUpdateCustomer
Fields
- Name
accepts_marketing- Type
- Boolean
- Description
Boolean to check if the customer accepts marketing.
- Name
billing_address- Label
InputAddress- Description
The customer billing address.
- Name
custom- Label
CustomFields- Description
The customer custom fields.
- Name
email- Type
- String
- Description
The customer email address.
- Name
first_name- Type
- String
- Description
The customer first name.
- Name
last_name- Type
- String
- Description
The customer last name.
- Name
notes- Type
- String
- Description
The customer notes.
- Name
phone- Type
- String
- Description
The customer phone number.
- Name
shipping_address- Label
InputAddress- Description
The customer shipping address.
- Name
tags- Type
- [String!]
- Description
The customer tags.
InputCustomer
Fields
- Name
accepts_marketing- Type
- Boolean!
- Description
Boolean to check if the customer accepts marketing.
- Name
billing_address- Label
InputAddress- Description
The customer billing address.
- Name
email- Type
- String!
- Description
The customer email address.
- Name
first_name- Type
- String!
- Description
The customer first name.
- Name
last_name- Type
- String!
- Description
The customer last name.
- Name
phone- Type
- String!
- Description
The customer phone number.
- Name
shipping_address- Label
InputAddress- Description
The customer shipping address.
- Name
tags- Type
- [String!]!
- Description
The customer tags.
InputAddress
Fields
- Name
area- Type
- String
- Description
The customer area.
- Name
city- Type
- String
- Description
The customer city.
- Name
country- Type
- String
- Description
The customer country.
- Name
email- Type
- String
- Description
The customer email address.
- Name
first_name- Type
- String
- Description
The customer first name.
- Name
last_name- Type
- String
- Description
The customer last name.
- Name
line1- Type
- String
- Description
The customer first address line.
- Name
line2- Type
- String
- Description
The customer secondary address line.
- Name
phone- Type
- String
- Description
The customer phone number.
- Name
state- Type
- String
- Description
The customer state.
- Name
zip- Type
- String
- Description
The customer zip.
Address
Fields
- Name
_id- Type
- Int!
- Description
Unique number identifier for the customer.
- Name
area- Type
- String!
- Description
The customer area.
- Name
city- Type
- String!
- Description
The customer city.
- Name
country- Type
- String
- Description
The customer country.
- Name
email- Type
- String!
- Description
The customer email address.
- Name
first_name- Type
- String!
- Description
The customer first name.
- Name
formatted- Type
- String!
- Description
- Name
id- Type
- ID!
- Description
Unique identifier for the customer.
- Name
last_name- Type
- String!
- Description
The customer last name.
- Name
line1- Type
- String!
- Description
The customer first address line.
- Name
line2- Type
- String!
- Description
The customer secondary address line.
- Name
phone- Type
- String!
- Description
The customer phone number.
- Name
state- Type
- String!
- Description
The customer state.
- Name
zip- Type
- String!
- Description
The customer zip.
CustomerSummary
Fields
- Name
orders- Label
CustomerOrders!- Description
The customer orders.
- Name
visits- Type
- Int!
- Description
The customer visits.
CustomerOrders
Fields
- Name
count- Type
- Int!
- Description
The customer order count.
- Name
expenses- Type
- Float!
- Description
The customer expenses.
- Name
list- Label
[OrderSummary!]!- Description
The customer orders. Deprecated: Use orders(query: "customer_id:<customer id>")
OrderSummary
Fields
- Name
order- Label
Order!- Description
The order type.
- Name
referrer- Type
- String
- Description
The order referrer.
CustomerConnection
A connection to a list of items.
Fields
- Name
edges- Label
[CustomerEdge]- Description
A list of edges.
- Name
pageInfo- Label
PageInfo!- Description
Information to aid in pagination.
ChannelPaymentGateway
Fields
- Name
index- Type
- Int!
- Description
- Name
payment_gateway- Label
PaymentGateway!- Description
- Name
payment_gateway_id- Type
- ID!
- Description
- Name
pm_amount_adjustment_direction- Label
PmAmountAdjustmentDirection!- Description
- Name
pm_amount_adjustment_type- Label
PmAmountAdjustmentType!- Description
- Name
pm_amount_adjustment_value- Type
- Float!
- Description
- Name
settings- Label
ChannelPaymentGatewaySettings!- Description
ChannelPaymentGatewaySettings
CustomFields
CustomerEdge
An edge in a connection.
Fields
- Name
cursor- Type
- String!
- Description
A cursor for use in pagination
- Name
expenses- Type
- Float!
- Description
- Name
node- Label
Customer- Description
The item at the end of the edge
- Name
orders_count- Type
- Int!
- Description
Lead
Fields
- Name
_id- Type
- Int!
- Description
- Name
created_at- Label
TimeStamp!- Description
Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
funnel- Label
Funnel- Description
- Name
id- Type
- ID!
- Description
- Name
lf3_project- Label
Lf3Project- Description
- Name
tags- Type
- [String!]!
- Description
- Name
updated_at- Label
TimeStamp!- Description
Arguments:
format: String = "fromNow",suffix: Boolean = true
Lf3Configs
Lf3Project
Fields
- Name
activate_google_analytics- Type
- Boolean!
- Description
- Name
activate_google_tag_manager_id- Type
- Boolean!
- Description
- Name
active_facebook_pixels- Type
- [String!]!
- Description
- Name
active_google_ads_pixels- Type
- [String!]!
- Description
- Name
active_openai_pixels- Type
- [String!]!
- Description
- Name
active_pinterest_pixels- Type
- [String!]!
- Description
- Name
active_snapchat_pixels- Type
- [String!]!
- Description
- Name
active_tiktok_pixels- Type
- [String!]!
- Description
- Name
address- Type
- String
- Description
- Name
branches- Label
[Lf3ProjectBranch!]!- Description
- Name
collections_ids- Type
- [ID!]!
- Description
- Name
configs- Label
Lf3Configs!- Description
- Name
created_at- Label
TimeStamp!- Description
Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
currency- Type
- String
- Description
- Name
currency_format- Type
- String
- Description
- Name
default_collection_id- Type
- ID
- Description
- Name
email- Type
- String
- Description
- Name
enable_captcha- Type
- Boolean!
- Description
- Name
enable_pm_extra_fees- Type
- Boolean!
- Description
- Name
id- Type
- ID!
- Description
- Name
legal_name- Type
- String
- Description
- Name
lf3_project_id- Type
- String!
- Description
- Name
name- Type
- String!
- Description
- Name
otp_mode- Label
OtpMode!- Description
- Name
payment_gateways- Label
[ChannelPaymentGateway!]!- Description
- Name
privacy_policy- Type
- String
- Description
- Name
refund_policy- Type
- String
- Description
- Name
shipping_group_id- Type
- ID
- Description
- Name
store_name- Type
- String
- Description
- Name
terms_of_services- Type
- String
- Description
Lf3ProjectBranch
Fields
- Name
id- Type
- ID!
- Description
- Name
kind- Type
- String
- Description
- Name
name- Type
- String!
- Description
- Name
pages- Label
[Lf3ProjectPage!]!- Description
Lf3ProjectPage
Fields
- Name
role- Type
- String!
- Description
- Name
split_test- Label
Lf3SplitTestConfig- Description
Lf3SplitTestConfig
Fields
- Name
enabled- Type
- Boolean!
- Description
- Name
variants- Label
[Lf3SplitTestVariant!]!- Description
Lf3SplitTestVariant
Fields
- Name
name- Type
- String!
- Description
- Name
weight- Type
- Int!
- Description
PmAmountAdjustmentDirection
Values
- Name
discount- Description
- Name
extra- Description
PmAmountAdjustmentType
Values
- Name
fixed- Description
- Name
percentage- Description