Product types
This list contains all query and inputs types for the product endpoints.
Product
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product.
- Name
_id
- Type
- Int!
- Description
Unique number identifier for the product.
- Name
uid
- Type
- ID!
- Description
Unique identifier for the product.
- Name
updated_at
- Label
TimeStamp!
- Description
Timestamp of when the product was updated.
- Name
created_at
- Label
TimeStamp!
- Description
Timestamp of when the product was created.
- Name
title
- Type
- String!
- Description
The product title.
- Name
slug
- Type
- String!
- Description
The product slug.
- Name
description
- Type
- String
- Description
The product description.
- Name
price
- Type
- Float!
- Description
The product price.
- Name
compare_at_price
- Type
- Float!
- Description
The product compare price.
- Name
images
- Label
[Image!]!
- Description
The product images.
- Name
images_ids
- Type
- [ID!]!
- Description
The product image ids.
- Name
options
- Label
[ProductOption!]!
- Description
The product options.
- Name
variants
- Label
[ProductVariant!]!
- Description
The product variants.
- Name
custom_options
- Label
[CustomOption!]!
- Description
The product custom options.
- Name
enable_custom_options
- Type
- Boolean!
- Description
The product enable custom options boolean option.
- Name
default_variant
- Label
ProductVariant!
- Description
The product default variants.
- Name
reviews
- Label
ReviewConnection!
- Description
The product reviews.
Arguments
- Name
query
- Type
- String!
- Description
the reviews query string.
- Name
tags
- Label
[Tag!]!
- Description
The product tags.
- Name
review_score
- Type
- Float!
- Description
The product review score.
- Name
review_count
- Type
- Int!
- Description
The product review count.
- Name
thumbnail
- Label
Image
- Description
The product thumbnail.
- Name
order_bump
- Label
ProductBump!
- Description
The product order bump.
- Name
features
- Label
[ProductFeatures!]!
- Description
The product features.
- Name
testimonials
- Label
[ProductTestimonials!]!
- Type
- /products/types#product-testimonials
- Description
The product testimonials.
- Name
faq
- Type
- [ProductFaq!]!
- Description
The product faq.
type ProductFaq { id: String! question: String! answer: String! }
- Name
notice_text
- Type
- String!
- Description
The product notice text.
- Name
product_type
- Type
- ProductType!
- Description
The product type.
enum ProductType { physical_product digital_product }
- Name
default_variant_id
- Type
- ID!
- Description
The product default variant id.
- Name
shipping_group_id
- Type
- ID
- Description
The product shipping group id.
- Name
price_bundle_id
- Type
- ID
- Description
The product price bundle id.
- Name
price_bundle
- Label
PriceBundle
- Description
The product price bundle.
- Name
file
- Label
File
- Description
The product file.
- Name
file_id
- Type
- ID
- Description
The product file id.
- Name
sku
- Type
- String!
- Description
The product sku.
- Name
crossSellProducts
- Label
[CrossSellProduct!]!
- Description
The product cross sell products.
- Name
funnels
- Type
- [Funnel!]!
- Description
The product funnels.
- Name
stores
- Type
- [Store!]!
- Description
The product stores.
- Name
collections_ids
- Type
- [ID!]!
- Description
The product collections ids.
- Name
customFunnel
- Label
Funnel
- Description
The product custom funnel.
- Name
enable_inventory_limit
- Type
- Boolean!
- Description
The product enable inventory limit.
- Name
inventory_quantity
- Type
- Int!
- Description
The product inventory quantity.
Request
query productsQuery($first: Int, $after: String, $query: String!){
products(query: "order_by:id order_dir:desc", after: "WzVE4OTA5LDEe/4OTA5XQ==", first: 10){
edges{
node{
id
_id
title
price
thumbnail{
path(version: version1)
}
created_at
...
}
}
}
}
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
type
- Type
- ProductOptionTypeEnum!
- Description
The product type.
enum ProductOptionTypeEnum { image text color }
- Name
options_types
- Type
- [ProductOptionType!]!
- Description
The product options types.
type ProductOptionType { option_id: String! value: ProductOptionTypeValue! } scalar ProductOptionTypeValue
InputProduct
Fields
- Name
title
- Type
- String!
- Description
The product title.
- Name
description
- Type
- String
- Description
The product description.
- Name
price
- Type
- Float
- Description
The product price.
- Name
sku
- Type
- String
- Description
The product sku.
- Name
slug
- Type
- String
- Description
The product slug.
- Name
compare_at_price
- Type
- Float
- Description
The product compare price.
- Name
options
- Label
[InputProductOption!]!
- Description
The product options.
- Name
images
- Type
- [ID!]
- Description
The product images.
- Name
variants
- Label
[InputProductVariant!]!
- Description
The product variants.
- Name
tags
- Type
- [ID!]
- Description
The product tags.
- Name
order_bump
- Label
InputProductBump
- Description
The product order bump.
- Name
features
- Type
- [InputProductFeatures!]
- Description
The product features.
input InputProductFeatures { id: String! title: String! description: String! image_id: ID }
- Name
testimonials
- Type
- [InputProductTestimonials!]
- Description
The product testimonials.
input InputProductTestimonials { id: String! name: String! position: String! comment: String! image_id: ID }
- Name
countdown
- Type
- InputProductCountdown
- Description
The product countdown.
input InputProductCountdown { enabled: Boolean! evergreen: Boolean! minutes: Int due: String }
- Name
sticky
- Type
- InputProductSticky
- Description
The product sticky.
input InputProductSticky { enabled: Boolean! }
- Name
faq
- Type
- [InputProductFaq!]
- Description
The product faq.
input InputProductFaq { id: String! question: String! answer: String! }
- Name
notice_text
- Type
- String
- Description
The product notice text.
- Name
product_type
- Type
- ProductType
- Description
The product type.
enum ProductType { physical_product digital_product }
- Name
shipping_group_id
- Type
- String
- Description
The product shipping group id.
- Name
price_bundle_id
- Type
- String
- Description
The product price bundle id.
- Name
file_id
- Type
- ID
- Description
The product file id.
- Name
crossSellProducts
- Type
- [CrossInputSellProduct!]
- Description
The product enable price bundle option.
input CrossInputSellProduct { upsell_product_uid: ID! downsell_product_uid: ID }
- Name
enable_inventory_limit
- Type
- Boolean
- Description
The product file id.
- Name
inventory_quantity
- Type
- Int
- Description
The product file id.
- Name
custom_options
- Label
[CustomOptionInput!]
- Description
The product custom options.
- Name
enable_custom_options
- Type
- Boolean
- Description
The product enable custom options boolean.
Request
mutation mutationName($node: InputProduct!) {
createProduct(node: $node){
# Product fields
}
}
InputUpdateProduct
Fields
- Name
title
- Type
- String
- Description
The product title.
- Name
sku
- Type
- String
- Description
The product sku.
- Name
slug
- Type
- String
- Description
The product slug.
- Name
description
- Type
- String
- Description
The product description.
- Name
price
- Type
- Float
- Description
The product price.
- Name
compare_at_price
- Type
- Float
- Description
The product compare price.
- Name
options
- Type
- [InputProductOption!]!
- Description
The product options.
input InputProductOption { id: String label: String options: [String!] type: ProductOptionTypeEnum! = text options_types: [InputProductOptionType!]! = [] } input InputProductOptionType { option_id: String! value: ProductOptionTypeValue! } scalar ProductOptionTypeValue
- Name
images
- Type
- [ID!]
- Description
The product images.
- Name
variants
- Type
- [InputProductVariant!]!
- Description
The product variants.
- Name
tags
- Type
- [ID!]
- Description
The product tags.
- Name
order_bump
- Type
- InputProductBump
- Description
The product order bump.
input InputProductBump { id: String! title: String! price: Float! compare_at_price: Float! description: String! sku: String! enabled: Boolean! image_uid: ID file_uid: ID }
- Name
countdown
- Type
- InputProductCountdown
- Description
The product countdown.
input InputProductCountdown { enabled: Boolean! evergreen: Boolean! minutes: Int due: String }
- Name
sticky
- Type
- InputProductSticky
- Description
The product sticky.
input InputProductSticky { enabled: Boolean! }
- Name
features
- Type
- [InputProductFeatures!]
- Description
The product features.
input InputProductFeatures { id: String! title: String! description: String! image_uid: ID }
- Name
testimonials
- Type
- [InputProductTestimonials!]
- Description
The product testimonials.
input InputProductTestimonials { id: String! name: String! position: String! comment: String! image_uid: ID }
- Name
faq
- Type
- [InputProductFaq!]
- Description
The product faq.
input InputProductFaq { id: String! question: String! answer: String! }
- Name
notice_text
- Type
- String
- Description
The product notice text.
- Name
product_type
- Type
- ProductType
- Description
The product type.
enum ProductType { physical_product digital_product }
- Name
file_uid
- Type
- ID
- Description
The product file uid.
- Name
shipping_group_id
- Type
- String
- Description
The product shipping group id.
- Name
price_bundle_id
- Type
- String
- Description
The product price bundle id.
- Name
crossSellProducts
- Type
- [CrossInputSellProduct!]
- Description
The product cross-sell products option.
input CrossInputSellProduct { upsell_product_uid: ID! downsell_product_uid: ID }
- Name
custom_funnel_uid
- Type
- String
- Description
The product custom funnel id.
Request
mutation updateProductMutation($node: InputUpdateProduct!, $id: Int!){
updateProduct(node: $node, id: $id){
# Product fields
}
}
ProductVariant
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product.
- Name
_id
- Type
- Float!
- Description
Unique number identifier for the product.
- Name
price
- Type
- Float!
- Description
The product price.
- Name
compare_at_price
- Type
- Float!
- Description
The product compare price.
- Name
sku
- Type
- String!
- Description
The product sku.
- Name
title
- Type
- String!
- Description
The product title.
- Name
image
- Label
Image
- Description
The product image.
- Name
image_id
- Type
- ID
- Description
The product image id.
- Name
file
- Label
File
- Description
The product file.
- Name
file_id
- Type
- ID
- Description
The product file id.
- Name
product_id
- Type
- ID!
- Description
The product id.
- Name
options
- Type
- [ProductOptionValue!]!
- Description
The product options.
type ProductOptionValue { id: String! value: String! }
- Name
labeldOptions
- Type
- [OrderVariantOption!]!
- Description
The product options.
type OrderVariantOption { id: String! label: String! value: String! }
- Name
enable_inventory_limit
- Type
- Boolean!
- Description
The product enable inventory limit boolean.
- Name
inventory_quantity
- Type
- Int!
- Description
The product inventory quantity.
- Name
updated_at
- Label
TimeStamp!
- Description
Timestamp of when the product was updated.
- Name
created_at
- Label
TimeStamp!
- Description
Timestamp of when the product was created.
File
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product file.
- Name
uid
- Type
- ID!
- Description
Unique identifier for the product file.
- Name
_id
- Type
- Int!
- Description
Unique number identifier for the product file.
- Name
updated_at
- Label
TimeStamp!
- Description
Timestamp of when the product file was updated.
- Name
created_at
- Label
TimeStamp!
- Description
Timestamp of when the product file was created.
- Name
title
- Type
- String!
- Description
The product file title.
- Name
path
- Type
- String!
- Description
The product file path.
- Name
key
- Type
- String!
- Description
The product file key.
- Name
size
- Type
- String!
- Description
The product file size.
Arguments
- Name
format
- Type
- String
- Description
The size format string.
Tag
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product tag.
- Name
uid
- Type
- ID!
- Description
Unique identifier for the product tag.
- Name
title
- Type
- String!
- Description
The product tag title.
- Name
updated_at
- Label
TimeStamp!
- Description
Timestamp of when the product tag was updated.
- Name
created_at
- Label
TimeStamp!
- Description
Timestamp of when the product tag was created.
ProductConnection
Fields
- Name
pageInfo
- Type
- PageInfo!
- Description
Product connection page info.
type PageInfo { hasNextPage: Boolean! hasPreviousPage: Boolean! startCursor: String endCursor: String }
- Name
edges
- Type
- [ProductEdge]
- Description
The Product connection edges.
type ProductEdge { node: Product cursor: String! }
- Name
count
- Type
- Int!
- Description
Product connection count.
CustomOption
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product custom option.
- Name
type
- Type
- CustomOptionType!
- Description
Product custom option type.
enum CustomOptionType { image text }
- Name
name
- Type
- String!
- Description
Product custom option name.
- Name
placeholder
- Type
- String!
- Description
Product custom option placeholder.
CustomOptionInput
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product custom option.
- Name
type
- Type
- CustomOptionType!
- Description
Product custom option type.
enum CustomOptionType { image text }
- Name
name
- Type
- String!
- Description
Product custom option name.
- Name
placeholder
- Type
- String!
- Description
Product custom option placeholder.
ProductBump
Fields
- Name
id
- Type
- String!
- Description
Unique identifier for the product bump.
- Name
title
- Type
- String!
- Description
Product bump title.
- Name
price
- Type
- Float!
- Description
Product bump price.
- 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
image
- Type
- Image
- Description
Product bump image.
- Name
image_id
- Type
- ID
- Description
Product bump image id.
- Name
file_id
- Type
- ID
- Description
Product bump file id.
- Name
sku
- Type
- String!
- Description
Product bump sku.
- Name
file
- Label
File
- Description
Product bump file.
ProductFeatures
Fields
- Name
id
- Type
- String!
- Description
Unique identifier for the product features.
- Name
title
- Type
- String!
- Description
Product features title.
- Name
description
- Type
- String!
- Description
Product features description.
- Name
image
- Label
Image
- Description
Product features image.
- Name
image_id
- Type
- ID
- Description
Product features image id.
ProductTestimonials
Fields
- Name
image
- Label
Image
- Description
Product testimonials image.
- Name
image_id
- Type
- ID
- Description
Product testimonials description.
- Name
id
- Type
- String!
- Description
Unique identifier for the product testimonials.
- Name
name
- Type
- String!
- Description
Product testimonials name.
- Name
position
- Type
- String!
- Description
Product testimonials position.
- Name
comment
- Type
- String!
- Description
Product testimonials comment.
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
type
- Type
- ProductOptionTypeEnum!
- Description
The product title.
enum ProductOptionTypeEnum { image text color }
- Name
options_types
- Type
- [ProductOptionType!]!
- Description
The product options types.
type InputProductOptionType { option_id: String! value: ProductOptionTypeValue! } scalar ProductOptionTypeValue
InputProductVariant
Fields
- Name
id
- Type
- ID!
- Description
Unique identifier for the product.
- Name
price
- Type
- Float
- Description
The product price.
- Name
compare_at_price
- Type
- Float
- Description
The product compare price.
- Name
image_id
- Type
- ID
- Description
The product image id.
- Name
file_id
- Type
- ID
- Description
The product file id.
- Name
sku
- Type
- String
- Description
The product sku.
- Name
options
- Type
- [InputProductOptionValue!]!
- Description
The product options.
input InputProductOptionValue { value: String! id: String! }
- Name
enable_inventory_limit
- Type
- Boolean
- Description
The product enable inventory limit boolean.
- Name
inventory_quantity
- Type
- Int
- Description
The product inventory quantity.
InputProductBump
Fields
- Name
id
- Type
- String!
- Description
Unique identifier for the product bump.
- Name
title
- Type
- String!
- Description
Product bump title.
- Name
price
- Type
- Float!
- Description
Product bump price.
- Name
compare_at_price
- Type
- Float!
- Description
Product bump compare at price.
- Name
description
- Type
- String!
- Description
Product bump description.
- Name
sku
- Type
- String!
- Description
Product bump sku.
- Name
enabled
- Type
- Boolean!
- Description
Product bump enabled.
- Name
image_id
- Type
- ID
- Description
Product bump image id.
- Name
file_id
- Type
- ID
- Description
Product bump file id.