Product types
This list contains all query and input types for the product endpoints.
Product
Fields
- Name
_id- Type
- Int!
- Description
Unique number identifier for the product.
- Name
billing_settings- Label
[ProductBillingSetting!]- Description
- Name
billing_type- Label
ProductBillingType- Description
- Name
collections_ids- Type
- [ID!]!
- Description
The product collections ids.
- Name
compare_at_price- Type
- Float!
- Description
The product compare price.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the product was created. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
crossSellProducts- Label
[CrossSellProduct!]!- Description
The product cross sell products.
- Name
customFunnel- Label
Funnel- Description
The product custom funnel.
- Name
custom_options- Label
[CustomOption!]!- Description
The product custom options.
- Name
default_variant- Label
ProductVariant!- Description
The product default variants.
- Name
default_variant_id- Type
- ID!
- Description
- Name
description- Type
- String
- Description
The product description.
- Name
digital_assets- Label
[DigitalAssetAssociation!]!- Description
- Name
enable_custom_options- Type
- Boolean!
- Description
The product enable custom options boolean option.
- Name
enable_inventory_limit- Type
- Boolean!
- Description
The product enable inventory limit.
- Name
faq- Label
[ProductFaq!]!- Description
The product faq.
- Name
features- Label
[ProductFeatures!]!- Description
The product features.
- Name
file- Label
File- Description
The product file.
- Name
file_id- Type
- ID
- Description
The product file id.
- Name
funnels- Label
[Funnel!]!- Description
The product funnels.
- Name
id- Type
- ID!
- Description
Unique identifier for the product.
- Name
images- Label
[Image!]!- Description
The product images.
- Name
images_ids- Type
- [ID!]!
- Description
The product image ids.
- Name
inventory_quantity- Type
- Int!
- Description
The product inventory quantity.
- Name
notice_text- Type
- String!
- Description
The product notice text.
- Name
options- Label
[ProductOption!]!- Description
The product options.
- Name
order_bump- Label
ProductBump!- Description
The product order bump.
- Name
order_bumps- Label
[ProductAsAnOrderBump!]!- Description
- Name
price- Type
- Float!
- Description
The product price.
- Name
price_bundle- Label
PriceBundle- Description
The product price bundle.
- Name
price_bundle_id- Type
- ID
- Description
The product price bundle id.
- Name
product_type- Label
ProductType!- Description
The product type.
- Name
review_count- Type
- Int!
- Description
The product review count.
- Name
review_score- Type
- Float!
- Description
The product review score.
- Name
reviews- Label
ReviewConnection!- Description
The product reviews. ##### Arguments the reviews query string. Arguments:
query: String!
- Name
shipping_group_id- Type
- ID
- Description
The product shipping group id.
- Name
sku- Type
- String!
- Description
The product sku.
- Name
slug- Type
- String!
- Description
The product slug.
- Name
stores- Label
[Store!]!- Description
The product stores.
- Name
tags- Label
[Tag!]!- Description
A list of tags associated with the product. Tags are useful for categorizing and filtering products.
- Name
testimonials- Label
[ProductTestimonials!]!- Description
The product testimonials.
- Name
thumbnail- Label
Image- Description
The product thumbnail.
- Name
title- Type
- String!
- Description
The product title.
- Name
uid- Type
- ID!
- Description
Unique identifier for the product.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the product was updated. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
variants- Label
[ProductVariant!]!- Description
The product variants.
ProductOption
Fields
- Name
id- Type
- String!
- Description
Unique identifier for the product option.
- Name
label- Type
- String!
- Description
The product label.
- Name
options- Type
- [String!]!
- Description
The product options.
- Name
options_types- Label
[ProductOptionType!]!- Description
The product options types.
- Name
type- Label
ProductOptionTypeEnum!- Description
The product type.
InputProduct
Fields
- Name
billing_settings- Label
[ProductBillingSettingsInput!]- Description
- Name
compare_at_price- Type
- Float
- Description
The product compare price.
- Name
crossSellProducts- Label
[CrossInputSellProduct!]- Description
The product enable price bundle option.
- Name
custom_options- Label
[CustomOptionInput!]- Description
The product custom options.
- Name
description- Type
- String
- Description
The product description.
- Name
digital_assets- Label
[DigitalAssetAssociationInput!]- Description
- Name
enable_custom_options- Type
- Boolean
- Description
The product enable custom options boolean.
- Name
enable_inventory_limit- Type
- Boolean
- Description
The product file id.
- Name
faq- Label
[InputProductFaq!]- Description
The product faq.
- Name
features- Label
[InputProductFeatures!]- Description
The product features.
- Name
file_id- Type
- ID
- Description
The product file id.
- Name
images- Type
- [ID!]
- Description
The product images.
- Name
inventory_quantity- Type
- Int
- Description
The product file id.
- Name
notice_text- Type
- String
- Description
The product notice text.
- Name
options- Label
[InputProductOption!]!- Description
The product options.
- Name
order_bump- Label
InputProductBump- Description
The product order bump.
- Name
order_bumps- Label
[InputProductAsAnOrderBump!]- Description
- Name
price- Type
- Float
- Description
The product price.
- Name
price_bundle_id- Type
- String
- Description
The product price bundle id.
- Name
price_bundle_images- Label
[InputPriceBundleItemImages!]- Description
- Name
product_type- Label
ProductType- Description
The product type.
- Name
shipping_group_id- Type
- String
- Description
The product shipping group id.
- Name
sku- Type
- String
- Description
The product sku.
- Name
slug- Type
- String
- Description
The product slug.
- Name
tags- Type
- [ID!]
- Description
The product tags.
- Name
testimonials- Label
[InputProductTestimonials!]- Description
The product testimonials.
- Name
title- Type
- String!
- Description
The product title.
- Name
variants- Label
[InputProductVariant!]!- Description
The product variants.
InputUpdateProduct
Fields
- Name
billing_settings- Label
[ProductBillingSettingsInput!]- Description
- Name
compare_at_price- Type
- Float
- Description
The product compare price.
- Name
crossSellProducts- Label
[CrossInputSellProduct!]- Description
The product cross-sell products option.
- Name
custom_funnel_id- Type
- ID
- Description
- Name
custom_options- Label
[CustomOptionInput!]- Description
- Name
description- Type
- String
- Description
The product description.
- Name
digital_assets- Label
[DigitalAssetAssociationInput!]- Description
- Name
enable_custom_options- Type
- Boolean
- Description
- Name
enable_inventory_limit- Type
- Boolean
- Description
- Name
faq- Label
[InputProductFaq!]- Description
The product faq.
- Name
features- Label
[InputProductFeatures!]- Description
The product features.
- Name
file_id- Type
- ID
- Description
- Name
images- Type
- [ID!]
- Description
The product images.
- Name
inventory_quantity- Type
- Int
- Description
- Name
notice_text- Type
- String
- Description
The product notice text.
- Name
options- Label
[InputProductOption!]- Description
The product options.
- Name
order_bump- Label
InputProductBump- Description
The product order bump.
- Name
order_bumps- Label
[InputProductAsAnOrderBump!]- Description
- Name
price- Type
- Float
- Description
The product price.
- Name
price_bundle_id- Type
- String
- Description
The product price bundle id.
- Name
price_bundle_images- Label
[InputPriceBundleItemImages!]- Description
- Name
product_type- Label
ProductType- Description
The product type.
- Name
shipping_group_id- Type
- String
- Description
The product shipping group id.
- Name
sku- Type
- String
- Description
The product sku.
- Name
slug- Type
- String
- Description
The product slug.
- Name
tags- Type
- [ID!]
- Description
The product tags.
- Name
testimonials- Label
[InputProductTestimonials!]- Description
The product testimonials.
- Name
title- Type
- String
- Description
The product title.
- Name
variants- Label
[InputProductVariant!]- Description
The product variants.
ProductVariant
Fields
- Name
_id- Type
- Float!
- Description
Unique number identifier for the product.
- Name
compare_at_price- Type
- Float!
- Description
The product compare price.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the product was created. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
digital_assets- Label
[DigitalAssetAssociation!]!- Description
- Name
enable_inventory_limit- Type
- Boolean!
- Description
The product enable inventory limit boolean.
- Name
file- Label
File- Description
The product file.
- Name
file_id- Type
- ID
- Description
The product file id.
- Name
id- Type
- ID!
- Description
Unique identifier for the product.
- Name
image- Label
Image- Description
The product image.
- Name
image_id- Type
- ID
- Description
The product image id.
- Name
inventory_quantity- Type
- Int!
- Description
The product inventory quantity.
- Name
labeldOptions- Label
[OrderVariantOption!]!- Description
The product options.
- Name
options- Label
[ProductOptionValue!]!- Description
The product options.
- Name
price- Type
- Float!
- Description
The product price.
- Name
product- Label
Product- Description
Resolves the parent product associated with this variant. Use this property to access details of the main product, such as its name, category, tags or shared attributes. This is particularly useful when working with product variants and needing context about their parent product.
- Name
product_id- Type
- ID!
- Description
The product id.
- Name
sku- Type
- String!
- Description
The product sku.
- Name
title- Type
- String!
- Description
The product title.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the product was updated. Arguments:
format: String = "fromNow",suffix: Boolean = true
File
Fields
- Name
_id- Type
- Int!
- Description
Unique number identifier for the product file.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the product file was created. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
id- Type
- ID!
- Description
Unique identifier for the product file.
- Name
key- Type
- String!
- Description
The product file key.
- Name
path- Type
- String!
- Description
The product file path.
- Name
size- Type
- String!
- Description
The product file size. ##### Arguments The size format string. Arguments:
format: String
- Name
title- Type
- String!
- Description
The product file title.
- Name
uid- Type
- ID!
- Description
Unique identifier for the product file.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the product file was updated. Arguments:
format: String = "fromNow",suffix: Boolean = true
Tag
Fields
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the product tag was created. Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
id- Type
- ID!
- Description
Unique identifier for the product tag.
- Name
title- Type
- String!
- Description
The product tag title.
- Name
uid- Type
- ID!
- Description
Unique identifier for the product tag.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the product tag was updated. Arguments:
format: String = "fromNow",suffix: Boolean = true
ProductConnection
A connection to a list of items.
Fields
- Name
count- Type
- Int!
- Description
- Name
edges- Label
[ProductEdge]- Description
A list of edges.
- Name
pageInfo- Label
PageInfo!- Description
Information to aid in pagination.
CustomOption
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the product custom option.
- Name
name- Type
- String!
- Description
Product custom option name.
- Name
placeholder- Type
- String!
- Description
Product custom option placeholder.
- Name
type- Label
CustomOptionType!- Description
Product custom option type.
CustomOptionInput
Fields
- Name
id- Type
- ID!
- Description
copt_[nanoid()]
- Name
name- Type
- String!
- Description
Product custom option name.
- Name
placeholder- Type
- String!
- Description
Product custom option placeholder.
- Name
type- Label
CustomOptionType!- Description
Product custom option type.
ProductBump
Fields
- Name
compare_at_price- Type
- Float!
- Description
Product bump compare at price.
- Name
description- Type
- String!
- Description
Product bump description.
- Name
enabled- Type
- Boolean!
- Description
Product bump enabled.
- Name
file- Label
File- Description
Product bump file.
- Name
file_id- Type
- ID
- Description
Product bump file id.
- Name
id- Type
- String!
- Description
Unique identifier for the product bump.
- Name
image- Label
Image- Description
Product bump image.
- Name
image_id- Type
- ID
- Description
Product bump image id.
- Name
price- Type
- Float!
- Description
Product bump price.
- Name
sku- Type
- String!
- Description
Product bump sku.
- Name
title- Type
- String!
- Description
Product bump title.
ProductFeatures
Fields
- Name
description- Type
- String!
- Description
Product features description.
- Name
id- Type
- String!
- Description
Unique identifier for the product features.
- Name
image- Label
Image- Description
Product features image.
- Name
image_id- Type
- ID
- Description
Product features image id.
- Name
title- Type
- String!
- Description
Product features title.
ProductTestimonials
Fields
- Name
comment- Type
- String!
- Description
Product testimonials comment.
- Name
id- Type
- String!
- Description
Unique identifier for the product testimonials.
- Name
image- Label
Image- Description
Product testimonials image.
- Name
image_id- Type
- ID
- Description
Product testimonials description.
- Name
name- Type
- String!
- Description
Product testimonials name.
- Name
position- Type
- String!
- Description
Product testimonials position.
CrossSellProduct
InputProductOption
Fields
- Name
id- Type
- String
- Description
Unique identifier for the product option.
- Name
label- Type
- String
- Description
The product label.
- Name
options- Type
- [String!]
- Description
The product options.
- Name
options_types- Label
[InputProductOptionType!]!- Description
The product options types. Default:
[]
- Name
type- Label
ProductOptionTypeEnum!- Description
The product title. Default:
"text"
InputProductVariant
Fields
- Name
compare_at_price- Type
- Float
- Description
The product compare price. Default:
0
- Name
digital_assets- Label
[DigitalAssetAssociationInput!]- Description
- Name
enable_inventory_limit- Type
- Boolean
- Description
The product enable inventory limit boolean.
- Name
file_id- Type
- ID
- Description
The product file id.
- Name
id- Type
- ID
- Description
Unique identifier for the product.
- Name
image_id- Type
- ID
- Description
The product image id.
- Name
inventory_quantity- Type
- Int
- Description
The product inventory quantity.
- Name
options- Label
[InputProductOptionValue!]!- Description
The product options. Default:
[]
- Name
price- Type
- Float
- Description
The product price. Default:
0
- Name
sku- Type
- String
- Description
The product sku.
InputProductBump
Fields
- Name
compare_at_price- Type
- Float!
- Description
Product bump compare at price.
- Name
description- Type
- String!
- Description
Product bump description.
- Name
enabled- Type
- Boolean!
- Description
Product bump enabled.
- Name
file_id- Type
- ID
- Description
Product bump file id.
- Name
id- Type
- String!
- Description
Unique identifier for the product bump.
- Name
image_id- Type
- ID
- Description
Product bump image id.
- Name
price- Type
- Float!
- Description
Product bump price.
- Name
sku- Type
- String!
- Description
Product bump sku.
- Name
title- Type
- String!
- Description
Product bump title.
CrossInputSellProduct
Fields
- Name
downsell_product_id- Type
- ID
- Description
- Name
upsell_product_id- Type
- ID!
- Description
DigitalAssetAssociation
Fields
- Name
created_at- Label
TimeStamp!- Description
Arguments:
format: String = "fromNow",suffix: Boolean = true
- Name
data- Label
DigitalAssetAssociationData!- Description
- Name
digital_asset_id- Type
- ID!
- Description
- Name
file- Label
File- Description
- Name
file_id- Type
- ID
- Description
- Name
id- Type
- ID!
- Description
- Name
type- Label
DigitalAssetTypeEnum!- Description
DigitalAssetAssociationData
Fields
- Name
available_keys_count- Type
- Int!
- Description
- Name
consumed_keys_count- Type
- Int!
- Description
- Name
expiry_minutes- Type
- Int
- Description
- Name
keys- Label
[DigitalAssetAssociationKey!]- Description
- Name
name- Type
- String
- Description
DigitalAssetAssociationInput
Fields
- Name
digital_asset_id- Type
- ID
- Description
- Name
expiry_minutes- Type
- Int
- Description
- Name
id- Type
- ID
- Description
DigitalAssetAssociationKey
Fields
- Name
expiry_minutes- Type
- Int
- Description
- Name
is_consumed- Type
- Boolean!
- Description
- Name
key- Type
- String!
- Description
DigitalAssetTypeEnum
Values
- Name
file- Description
- Name
software_key_pool- Description
InputPriceBundleItemImages
Fields
- Name
images- Type
- [ID!]!
- Description
- Name
item_id- Type
- ID!
- Description
InputProductAsAnOrderBump
Fields
- Name
enable_quantity- Type
- Boolean
- Description
- Name
id- Type
- String
- Description
- Name
is_checked- Type
- Boolean
- Description
- Name
product_id- Type
- String!
- Description
- Name
variant_id- Type
- String
- Description
InputProductFaq
Fields
- Name
answer- Type
- String!
- Description
- Name
id- Type
- String!
- Description
- Name
question- Type
- String!
- Description
InputProductFeatures
Fields
- Name
description- Type
- String!
- Description
- Name
id- Type
- String!
- Description
- Name
image_id- Type
- ID
- Description
- Name
title- Type
- String!
- Description
InputProductOptionType
Fields
- Name
option_id- Type
- String!
- Description
- Name
value- Label
ProductOptionTypeValue!- Description
InputProductOptionValue
Fields
- Name
id- Type
- String!
- Description
- Name
value- Type
- String!
- Description
InputProductTestimonials
Fields
- Name
comment- Type
- String!
- Description
- Name
id- Type
- String!
- Description
- Name
image_id- Type
- ID
- Description
- Name
name- Type
- String!
- Description
- Name
position- Type
- String!
- Description
ProductAsAnOrderBump
Fields
- Name
enable_quantity- Type
- Boolean!
- Description
- Name
id- Type
- ID!
- Description
- Name
is_checked- Type
- Boolean!
- Description
- Name
order_bump_product_id- Type
- String!
- Description
- Name
product- Label
Product- Description
- Name
variant- Label
ProductVariant- Description
- Name
variant_id- Type
- String
- Description
ProductBillingDiscountType
Values
- Name
fixed- Description
- Name
percentage- Description
ProductBillingFreeTrialUnitsType
Values
- Name
day- Description
- Name
month- Description
ProductBillingSetting
Fields
- Name
discounts- Label
[ProductBillingSettingsDiscount!]!- Description
- Name
expiry- Label
ProductBillingSettingsExpiry- Description
- Name
free_trial- Label
ProductBillingSettingsFreeTrial- Description
- Name
id- Type
- String!
- Description
- Name
label- Type
- String
- Description
- Name
offer_text- Type
- String
- Description
- Name
quantifier- Type
- Float!
- Description
- Name
unit- Label
ProductBillingCycleUnitsType!- Description
ProductBillingSettingsDiscount
Fields
- Name
expiry- Label
ProductBillingSettingsDiscountExpiry- Description
- Name
id- Type
- String!
- Description
- Name
type- Label
ProductBillingDiscountType!- Description
- Name
value- Type
- Float!
- Description
ProductBillingSettingsDiscountExpiry
Fields
- Name
payments- Label
ProductBillingSettingsDiscountExpiryPayments!- Description
ProductBillingSettingsDiscountExpiryInput
Fields
- Name
payments- Label
ProductBillingSettingsExpiryPaymentsInput!- Description
ProductBillingSettingsDiscountExpiryPayments
Fields
- Name
quantifier- Type
- Float!
- Description
ProductBillingSettingsDiscountInput
Fields
- Name
expiry- Label
ProductBillingSettingsDiscountExpiryInput- Description
- Name
id- Type
- String!
- Description
- Name
type- Label
ProductBillingDiscountType!- Description
- Name
value- Type
- Float!
- Description
ProductBillingSettingsExpiry
Fields
- Name
payments- Label
ProductBillingSettingsExpiryPayments!- Description
ProductBillingSettingsExpiryInput
Fields
- Name
payments- Label
ProductBillingSettingsExpiryPaymentsInput!- Description
ProductBillingSettingsExpiryPayments
Fields
- Name
quantifier- Type
- Float!
- Description
ProductBillingSettingsExpiryPaymentsInput
Fields
- Name
quantifier- Type
- Float!
- Description
ProductBillingSettingsFreeTrial
Fields
- Name
quantifier- Type
- Float!
- Description
- Name
unit- Label
ProductBillingFreeTrialUnitsType!- Description
ProductBillingSettingsFreeTrialInput
Fields
- Name
quantifier- Type
- Float!
- Description
- Name
unit- Label
ProductBillingFreeTrialUnitsType!- Description
ProductBillingSettingsInput
Fields
- Name
discounts- Label
[ProductBillingSettingsDiscountInput!]- Description
- Name
expiry- Label
ProductBillingSettingsExpiryInput- Description
- Name
free_trial- Label
ProductBillingSettingsFreeTrialInput- Description
- Name
id- Type
- String
- Description
- Name
label- Type
- String
- Description
- Name
offer_text- Type
- String
- Description
- Name
quantifier- Type
- Float
- Description
- Name
type- Label
ProductBillingType- Description
- Name
unit- Label
ProductBillingCycleUnitsType- Description
ProductBillingType
Values
- Name
one_time_or_recurring- Description
- Name
recurring- Description
ProductEdge
An edge in a connection.
Fields
- Name
cursor- Type
- String!
- Description
A cursor for use in pagination
- Name
node- Label
Product- Description
The item at the end of the edge
ProductFaq
Fields
- Name
answer- Type
- String!
- Description
- Name
id- Type
- String!
- Description
- Name
question- Type
- String!
- Description
ProductOptionType
Fields
- Name
option_id- Type
- String!
- Description
- Name
value- Label
ProductOptionTypeValue!- Description
ProductOptionTypeEnum
Values
- Name
color- Description
- Name
image- Description
- Name
text- Description
ProductOptionTypeValue
ProductOptionValue
Fields
- Name
id- Type
- String!
- Description
- Name
value- Type
- String!
- Description
ProductType
Values
- Name
digital_product- Description
- Name
physical_product- Description