Customer
Represents a customer in the system.
type Customer {
archivedAt: ISO8601DateTime
billToCompany: String
billToEmail: Email
billToName: String
billToPhone: String
billToSameAsShipTo: Boolean!
billingAddress: Address
brand: Brand @deprecated
brandId: ID @deprecated
children: [Customer!]!
contactName: String
contactTitle: String
contacts: [CustomerContact!]!
createdAt: ISO8601DateTime!
customerAttributes: [CustomerAttribute!]!
customerType: CustomerTypeEnum!
defaultTemplate: OrderTemplate
defaultTemplateId: ID
defaultView: CustomerViewEnum
email: Email
freightPayer: FreightPayerEnum
handle: String
id: ID!
integrationMappings: [CustomerIntegrationMapping!]!
legalName: String
locations(
after: String
before: String
first: Int
includeArchived: Boolean = false
keyword: String
last: Int
): CustomerLocationConnection!
name: String
notes: String
parent: Customer
parentId: ID
paymentTerms: String
phone: String
preferredContactMethod: PreferredContactMethodEnum
preferredLanguage: String
primaryContact: CustomerContact
productPrices(
after: String
before: String
first: Int
last: Int
): ProductPriceConnection!
retailer: Boolean! @deprecated
salesChannel: SalesChannel
salesChannelId: ID
shipToCompany: String
shipToEmail: Email
shipToName: String
shipToPhone: String
shippingAccounts: [CustomerShippingAccount!]!
shippingAddress: Address
startDate: ISO8601Date
taxExempt: Boolean!
taxId: String
updatedAt: ISO8601DateTime!
website: String
}
Fields
Customer.archivedAt ● ISO8601DateTime scalar common
When the customer was archived, if archived.
Customer.billToCompany ● String scalar common
Customer.billToEmail ● Email scalar common
Customer.billToName ● String scalar common
Customer.billToPhone ● String scalar common
Customer.billToSameAsShipTo ● Boolean! non-null scalar common
Customer.billingAddress ● Address object common
Customer.brand ● Brand deprecated object common
This field will be removed in the future. Brand is becoming a product-only attribute.
Customer.brandId ● ID deprecated scalar common
This field will be removed in the future. Brand is becoming a product-only attribute.
Customer.children ● [Customer!]! non-null object common
Child customers in this customer's family, archived ones included.
Customer.contactName ● String scalar common
Named primary contact for a business customer.
Customer.contactTitle ● String scalar common
Role or title of the named primary contact.
Customer.contacts ● [CustomerContact!]! non-null object common
Active contacts for this customer, sorted by name.
Customer.createdAt ● ISO8601DateTime! non-null scalar common
Customer.customerAttributes ● [CustomerAttribute!]! non-null object common
Custom attribute values set on this customer.
Customer.customerType ● CustomerTypeEnum! non-null enum people
The kind of buying entity this customer represents.
Customer.defaultTemplate ● OrderTemplate object orders
The customer's default B2B order template, including archived templates.
Customer.defaultTemplateId ● ID scalar common
ID of the customer's default B2B order template.
Customer.defaultView ● CustomerViewEnum enum common
Saved default layout for this customer. Null follows customerType.
Customer.email ● Email scalar common
Customer.freightPayer ● FreightPayerEnum enum people
Who pays freight on this customer's shipments.
Customer.handle ● String scalar common
Optional stable identifier unique within the company; useful as an upsert key for uploads.
Customer.id ● ID! non-null scalar common
Customer.integrationMappings ● [CustomerIntegrationMapping!]! non-null object common
How external systems (accounting, ERP, EDI networks) identify this customer.
Customer.legalName ● String scalar common
The registered legal entity name, when it differs from the display name - what belongs on invoices, tax documents and contracts.
Customer.locations ● CustomerLocationConnection! non-null object common
Searchable saved customer shipping locations.
Customer.locations.after ● String scalar common
Returns the elements in the list that come after the specified cursor.
Customer.locations.before ● String scalar common
Returns the elements in the list that come before the specified cursor.
Customer.locations.first ● Int scalar common
Returns the first _n_ elements from the list.
Customer.locations.includeArchived ● Boolean scalar common
Include archived locations.
Customer.locations.keyword ● String scalar common
Search location name, store number, or address.
Customer.locations.last ● Int scalar common
Returns the last _n_ elements from the list.
Customer.name ● String scalar common
Display name of the buying entity.
Customer.notes ● String scalar common
Internal notes about the customer relationship.
Customer.parent ● Customer object common
Parent customer for family rollup (buying groups, banner brands). Reporting aggregation only.
Customer.parentId ● ID scalar common
ID of this customer's parent customer, when part of a customer family.
Customer.paymentTerms ● String scalar common
Payment terms label for the customer (e.g. "Net 30").
Customer.phone ● String scalar common
General contact phone for the relationship, distinct from the ship-to and bill-to snapshots on an order.
Customer.preferredContactMethod ● PreferredContactMethodEnum enum people
The customer's stated preferred communication channel.
Customer.preferredLanguage ● String scalar common
The customer's stated preferred language.
Customer.primaryContact ● CustomerContact object common
The contact marked as primary, when there is one.
Customer.productPrices ● ProductPriceConnection! non-null object common
Customer-specific price breaks, paginated: a customer's list can span the catalog. These take precedence over the sales channel's prices when resolving a unit price.
Customer.productPrices.after ● String scalar common
Returns the elements in the list that come after the specified cursor.
Customer.productPrices.before ● String scalar common
Returns the elements in the list that come before the specified cursor.
Customer.productPrices.first ● Int scalar common
Returns the first _n_ elements from the list.
Customer.productPrices.last ● Int scalar common
Returns the last _n_ elements from the list.
Customer.retailer ● Boolean! deprecated non-null scalar common
Use customerType instead. Derived from customerType == BUSINESS.
Customer.salesChannel ● SalesChannel object sales-channels
The customer's home sales channel, used for grouping and as the default channel on manual orders.
Customer.salesChannelId ● ID scalar common
ID of the customer's home sales channel.
Customer.shipToCompany ● String scalar common
Customer.shipToEmail ● Email scalar common
Customer.shipToName ● String scalar common
Customer.shipToPhone ● String scalar common
Customer.shippingAccounts ● [CustomerShippingAccount!]! non-null object common
Carrier accounts billed for this customer's shipments (customer-paid or third-party freight).
Customer.shippingAddress ● Address object common
Customer.startDate ● ISO8601Date scalar common
The calendar date when the customer relationship began.
Customer.taxExempt ● Boolean! non-null scalar common
Whether the customer is exempt from sales tax.
Customer.taxId ● String scalar common
The buying entity's tax identification number.
Customer.updatedAt ● ISO8601DateTime! non-null scalar common
Customer.website ● String scalar common
The buying entity's website URL.
Returned By
customer query
Member Of
ArchiveCustomerPayload object ● CreateCustomerPayload object ● Customer object ● CustomerConnection object ● CustomerEdge object ● CustomerIntegrationMapping object ● Order object ● ProductExternalIdentifier object ● SalesChannel object ● UnarchiveCustomerPayload object ● UpdateCustomerPayload object ● V2Order object
Implemented By
Notable union ● ProductPriceable union