ProductType

Represents a type of product. It defines what attributes are available to products of this type.

type ProductType implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  name: String!
  slug: String!
  isPriceOverrideAllowed: Boolean!
  isDigital: Boolean!
  isLocked: Boolean!
  isShippingRequired: Boolean!
  description: String
  descriptionHtml: String
  externalId: String
  externalSource: String
  externallyManaged: Boolean!
  hasVariants: Boolean!
  hasProducts: Boolean!
  hasVariantOptions: Boolean!
  productAttributes: [Attribute!]!
  variantAttributes: [Attribute!]!
  taxType: TaxType
  weight: Weight
  createdBy: Seller
  model: String
  products(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductCountableConnection!
  availableAttributes(
    filter: AttributeFilterInput
    before: String
    after: String
    first: Int
    last: Int
  ): AttributeCountableConnection!
}

Show more ↓

Fields

ProductType.id ● ID! non-null scalar

The Globally Unique ID of this object

ProductType.metadata ● [MetadataItem!]! non-null object

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

ProductType.privateMetadata ● [MetadataItem!]! non-null object

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

ProductType.name ● String! non-null scalar

Name of the product type

ProductType.slug ● String! non-null scalar

Slug identifier

ProductType.isPriceOverrideAllowed ● Boolean! non-null scalar

Whether price override is allowed for this product type

ProductType.isDigital ● Boolean! non-null scalar

Whether this product type is for digital products

ProductType.isLocked ● Boolean! non-null scalar

Whether this product type is locked from editing

ProductType.isShippingRequired ● Boolean! non-null scalar

Whether products of this type require shipping

ProductType.description ● String scalar

Description of the product type

ProductType.descriptionHtml ● String scalar

Description as HTML

ProductType.externalId ● String scalar

External system identifier

ProductType.externalSource ● String scalar

External source from which the product type is imported

ProductType.externallyManaged ● Boolean! non-null scalar

If True, this ProductType is managed by an external system (e.g., Shopify) and cannot be edited or deleted via the Nautical UI/API

ProductType.hasVariants ● Boolean! non-null scalar

Legacy indicator, always true

ProductType.hasProducts ● Boolean! non-null scalar

True if any products are associated to this type

ProductType.hasVariantOptions ● Boolean! non-null scalar

Whether this product type allows creating variants

ProductType.productAttributes ● [Attribute!]! non-null object

Product attributes of this product type

ProductType.variantAttributes ● [Attribute!]! non-null object

Variant attributes of that product type.

ProductType.taxType ● TaxType object

Tax type for this product type

ProductType.weight ● Weight object

Default weight for products of this type

ProductType.createdBy ● Seller object

Seller that created this product type

ProductType.model ● String scalar

Brand of the product

ProductType.products ● ProductCountableConnection! non-null object

List of products of this type.

ProductType.products.before ● String scalar

Returns the items in the list that come before the specified cursor.

ProductType.products.after ● String scalar

Returns the items in the list that come after the specified cursor.

ProductType.products.first ● Int scalar

Returns the first n items from the list.

ProductType.products.last ● Int scalar

Returns the items in the list that come after the specified cursor.

ProductType.availableAttributes ● AttributeCountableConnection! non-null object

Available attributes that can be assigned to this product type.

ProductType.availableAttributes.filter ● AttributeFilterInput input

ProductType.availableAttributes.before ● String scalar

Returns the items in the list that come before the specified cursor.

ProductType.availableAttributes.after ● String scalar

Returns the items in the list that come after the specified cursor.

ProductType.availableAttributes.first ● Int scalar

Returns the first n items from the list.

ProductType.availableAttributes.last ● Int scalar

Returns the items in the list that come after the specified cursor.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

productType query

Member Of

Attribute object ● AttributeAssign object ● AttributeUnassign object ● AttributeUnassignFromProductType object ● Product object ● ProductTypeCountableEdge object ● ProductTypeCreate object ● ProductTypeDelete object ● ProductTypeReorderAttributes object ● ProductTypeUpdate object