Customer
Specifies a customer
type Customer {
id: Int!
externalId: String
firstName: String
lastName: String
email: String
gender: Gender
userName: String @deprecated
username: String
type: CustomerType!
standardAddress: Address!
addresses: [Address!]!
internalComment: String
data: JSON
priceList: PriceList
status: CustomerStatus
category: CustomerCategory
discountGroups: [DiscountGroup!]
interests: [CustomerInterest!]
language: Language
acceptedContracts: [AcceptedContract]
watchList: [WatchListItem]
wishlists(
ids: [Int!]
sort: WishlistSort
): [Wishlist!]
loyalty: LoyaltyAccount
storeCredit: StoreCreditAccount
}
Fields
id ● Int!
Specifies the customer id
externalId ● String
The customer external id
firstName ● String
The first name of the customer
lastName ● String
The last name of the customer
email ● String
The email of the customer
gender ● Gender
The gender of the customer
username ● String
The username of the customer
type ● CustomerType!
Type of customer
standardAddress ● Address!
Customers standard address
addresses ● [Address!]!
Array of shipping addresses previously used by the customer, type can be either shipping or billing
internalComment ● String
Internal comment about the customer
data ● JSON
Custom data about the customer, in JSON format
priceList ● PriceList
The price list the customer is assigned to
status ● CustomerStatus
The customers status
category ● CustomerCategory
The catergory the customer is assigned to
discountGroups ● [DiscountGroup!]
The discount groups the customer is assigned to
interests ● [CustomerInterest!]
The interests the customer has selected
language ● Language
The customers default language
acceptedContracts ● [AcceptedContract]
Contracts the customer has accepted
watchList ● [WatchListItem]
A list of things which is currently being watched by the customer
wishlists ● [Wishlist!]
Customer's wishlists for managing saved products
ids ● [Int!]
Optional: Fetch specific wishlists by ids
sort ● WishlistSort
Sort wishlists
loyalty ● LoyaltyAccount
The customer's loyalty account
storeCredit ● StoreCreditAccount
The customers storecredit
Show deprecated
Example
{
"id": 3003,
"externalId": 200,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"gender": "MALE",
"userName": "johndoe21",
"username": "johndoe21",
"type": "PERSON",
"standardAddress": {
"organizationRegistrationId": "SE5566395256",
"organizationName": "Askås Internet- & Reklambyrå AB",
"organizationNumber": "556639-5256",
"ssn": 191212,
"streetAddress": "Järnvägsgatan 11",
"houseNumber": 11,
"streetAddress2": 11,
"postalCode": 66133,
"city": "Säffle",
"country": "Sverige",
"state": {
"country": {
"phonePrefix": "+46"
}
},
"phone": "+1123456789",
"reference": "Project 221",
"doorCode": 1234,
"attention": "Jane"
},
"addresses": [],
"internalComment": "Our favorite customer. Give loyalty discount",
"priceList": {
"id": 1,
"name": [
{
"language": "EN",
"value": "Pricelist 1"
}
]
},
"status": {
"id": 1,
"name": [
{
"language": "EN",
"value": "OK"
}
]
},
"category": {
"id": 110,
"name": [
{
"language": "EN",
"value": "Resellers"
}
]
},
"discountGroups": [
{
"id": 3,
"name": [
{
"language": "EN",
"value": "VIP / Returning customer"
}
]
}
],
"interests": [
{
"id": 21,
"name": [
{
"language": "EN",
"value": "Winter Collection Enthusiast"
}
]
}
],
"language": {
"code": "EN"
},
"acceptedContracts": [
{
"acceptedAt": "2024-05-03T11:52:33Z",
"contract": {
"consentText": "<h2>Terms of Purchase</h2><ul><li><strong>Pricing & Payment:</strong> All prices include applicable taxes. Payment is required at checkout.</li><li><strong>Shipping:</strong> Estimated delivery times are....",
"revision": 4,
"name": "Terms of Purchase",
"content": 4,
"rules": {}
}
}
],
"watchList": [
{
"product": {
"ean": 7310511257507,
"link": [
{
"language": "EN",
"value": "/en/audio/receivers/avr-135"
}
],
"productMeasurements": {},
"categories": [
{
"category": {
"name": [
{
"language": "EN",
"value": "String"
}
],
"content": {},
"meta": {},
"link": [
{
"alternateUrls": [
{}
],
"redirect": {}
}
],
"products": {
"edges": [
{}
],
"pageInfo": {},
"filters": [
{
"setting": {},
"filter": {
"range": {
"intervals": [
{}
]
},
"valuesWithMetadata": [
{}
],
"categoryTreeWithMetadata": [
{}
]
}
}
],
"sortOptions": [
{
"name": []
}
]
},
"topoffers": {},
"childrenConnection": {
"edges": [
{}
]
},
"associations": [
{
"ids": []
}
],
"pages": [
{
"contents": [
{
"menu": {}
}
]
}
],
"categoryImages": {
"icon": {}
},
"customAttributes": [
{}
]
}
}
],
"brand": {
"categoriesInBrand": [
{}
],
"media": {}
},
"inventories": [
{
"availability": {
"deliveryTime": {
"min": 10,
"max": 100
}
},
"supplier": {}
}
],
"description": {
"extra": [
{}
]
},
"rating": {
"reviews": [
{}
]
},
"productType": "PRODUCT",
"variantGroup": {
"variants": [
{
"variantAttributes": [
{
"attribute": {
"sort": {}
},
"values": [
{}
]
}
]
}
],
"variantFields": [
{
"variantsInformation": [
{
"values": [
{}
]
}
]
}
],
"lowestPrice": {
"price": {
"regularPrice": {
"currency": {
"rate": 11.355,
"prefix": "$"
},
"tax": {}
},
"appliedCampaign": {
"info": {
"timeLimit": {}
}
}
},
"productIds": []
}
},
"bundle": {
"categories": [
{
"products": [
{}
]
}
],
"price": {}
},
"media": {},
"accessories": [
{
"products": []
}
],
"properties": [
{
"content": [
{
"image": {}
}
],
"group": {}
}
],
"priceHistory": {
"lowest": {},
"history": []
},
"recommendations": [
{}
],
"shippingInfo": {},
"inboundDeliveries": [
{}
],
"vat": {},
"manufacturer": {},
"importer": {}
}
}
],
"wishlists": [
{
"items": [
{}
],
"properties": [
{}
]
}
],
"loyalty": {
"transactions": [
{}
]
},
"storeCredit": {}
}