Skip to main content

Product

A product available for purchase at a convention

type Product {
available: Boolean!
clickwrap_agreement: String
clickwrap_agreement_html: String
convention: Convention!
description: String
description_html: String
id: ID!
image: ActiveStorageAttachment
image_url: String @deprecated
name: String!
order_quantities_by_status: [OrderQuantityByStatus!]!
payment_options: [String!]!
pricing_structure: PricingStructure!
product_variants: [ProductVariant!]!
provides_ticket_type: TicketType
}

Fields

Product.available ● Boolean! non-null scalar

Whether this product is currently available for purchase

Product.clickwrap_agreement ● String scalar

The raw Liquid template for the clickwrap agreement

Product.clickwrap_agreement_html ● String scalar

The rendered HTML of the clickwrap agreement

Product.convention ● Convention! non-null object

The convention this product belongs to

Product.description ● String scalar

A description of the product in Liquid template format

Product.description_html ● String scalar

The rendered HTML description of the product

Product.id ● ID! non-null scalar

The unique identifier for this product

Product.image ● ActiveStorageAttachment object

The product image attachment

Product.image_url ● String deprecated scalar

⚠️ DEPRECATED

Please use the image field instead.

The URL of the product image

Product.name ● String! non-null scalar

The name of the product

Product.order_quantities_by_status ● [OrderQuantityByStatus!]! non-null object

The quantities of this product ordered, grouped by order status

Product.payment_options ● [String!]! non-null scalar

The accepted payment options for this product

Product.pricing_structure ● PricingStructure! non-null object

The pricing structure for this product

Product.product_variants ● [ProductVariant!]! non-null object

The variants available for this product

Product.provides_ticket_type ● TicketType object

The ticket type this product provides, if any

Member Of

Convention object ● Coupon object ● CreateProductPayload object ● DeleteProductPayload object ● OrderEntry object ● ProductVariant object ● SalesCountByProductAndPaymentAmount object ● TicketType object ● UpdateProductPayload object