CustomerType Object

Represents a type of customer. It allows to segment users and defines what attributes are available to users of this type.

type CustomerType implements Node & ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  name: String!
  slug: String!
  isDefault: Boolean!
  attributes: [Attribute!]
  availableAttributes(where: AttributeWhereInput, search: String, before: String, after: String, first: Int, last: Int): AttributeCountableConnection
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the customer type.

privateMetadata

privateMetadata · [MetadataItem!]!

List of private metadata items. Requires staff permissions to access.

privateMetafield

privateMetafield · String

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

List of public metadata items. Can be accessed without permissions.

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

name

name · String!

Name of the customer type.

slug

slug · String!

Slug of the customer type.

isDefault

isDefault · Boolean!

Whether this is the default customer type. The default customer type is assigned to every newly created user and cannot be deleted.

attributes

attributes · [Attribute!]

Customer attributes assigned to this customer type. Attributes that are not visible in the storefront require one of the following permissions to be included: MANAGE_USERS, MANAGE_CUSTOMER_TYPES_AND_ATTRIBUTES.

availableAttributes

availableAttributes · AttributeCountableConnection

Customer attributes that can be assigned to the customer type.

where

where · AttributeWhereInput

Where filtering options for attributes.

search

search · String

Search attributes.

before

before · String

Return the elements in the list that come before the specified cursor.

after

after · String

Return the elements in the list that come after the specified cursor.

first

first · Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last

last · Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

Used by

• CustomerTypeAssignAttributes (objects)
• CustomerTypeCountableEdge (objects)
• CustomerTypeCreate (objects)
• CustomerTypeCreated (objects)
• CustomerTypeDelete (objects)
• CustomerTypeDeleted (objects)
• CustomerTypeReorderAttributes (objects)
• CustomerTypeUnassignAttributes (objects)
• CustomerTypeUpdate (objects)
• CustomerTypeUpdated (objects)
• User (objects)
• customerType (queries)

Schema: Saleor 3.23.43. Download SDL.