Schema Documentation

Product

Description

Product object

Fields
Field NameDescription
attributes - ProductToProductAttributeConnection Connection between the Product type and the ProductAttribute type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToProductAttributeConnectionWhereArgs

Arguments for filtering the connection

averageRating - Float Product average count
catalogVisibility - CatalogVisibilityEnum Catalog visibility
databaseId - Int! The ID of the product in the database
date - String Date product created
dateOnSaleFrom - String Date on sale from
dateOnSaleTo - String Date on sale to
description - String Product description
Arguments
format - PostObjectFieldFormatEnum

Format of the field output

featured - Boolean If the product is featured
galleryImages - ProductToMediaItemConnection Connection between the Product type and the MediaItem type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToMediaItemConnectionWhereArgs

Arguments for filtering the connection

globalAttributes - ProductToGlobalProductAttributeConnection Connection between the Product type and the GlobalProductAttribute type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToGlobalProductAttributeConnectionWhereArgs

Arguments for filtering the connection

id - ID! The globally unique identifier for the product
image - MediaItem Main image
link - String The permalink of the post
localAttributes - ProductToLocalProductAttributeConnection Connection between the Product type and the LocalProductAttribute type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToLocalProductAttributeConnectionWhereArgs

Arguments for filtering the connection

menuOrder - Int Menu order
metaData - [MetaData] Object meta data
Arguments
key - String

Retrieve meta by key

keysIn - [String]

Retrieve multiple metas by key

multiple - Boolean

Retrieve meta with matching keys

modified - String Date product last updated
name - String Product name
onSale - Boolean Is product on sale?
parent - Product Parent product
productCategories - ProductToProductCategoryConnection Connection between the Product type and the productCategory type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToProductCategoryConnectionWhereArgs

Arguments for filtering the connection

productTags - ProductToProductTagConnection Connection between the Product type and the productTag type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToProductTagConnectionWhereArgs

Arguments for filtering the connection

productTypes - ProductToProductTypeConnection Connection between the Product type and the productType type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToProductTypeConnectionWhereArgs

Arguments for filtering the connection

purchasable - Boolean Can product be purchased?
purchaseNote - String Purchase note
related - ProductToProductConnection Connection between the Product type and the Product type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToProductConnectionWhereArgs

Arguments for filtering the connection

reviewCount - Int Product review count
reviews - ProductToCommentConnection Connection between the Product type and the Comment type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToCommentConnectionWhereArgs

Arguments for filtering the connection

reviewsAllowed - Boolean If reviews are allowed
shippingClasses - ProductToShippingClassConnection Connection between the Product type and the shippingClass type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToShippingClassConnectionWhereArgs

Arguments for filtering the connection

shortDescription - String Product short description
Arguments
format - PostObjectFieldFormatEnum

Format of the field output

sku - String Product SKU
slug - String Product slug
status - String Product status
totalSales - Int Number total of sales
type - ProductTypesEnum Product type
upsell - ProductToUpsellConnection Connection between the Product type and the Product type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToUpsellConnectionWhereArgs

Arguments for filtering the connection

visibleProducts - ProductToVisibleProductConnection Connection between the Product type and the visibleProduct type
Arguments
first - Int

The number of items to return after the referenced "after" cursor

last - Int

The number of items to return before the referenced "before" cursor

after - String

Cursor used along with the "first" argument to reference where in the dataset to get data

before - String

Cursor used along with the "last" argument to reference where in the dataset to get data

where - ProductToVisibleProductConnectionWhereArgs

Arguments for filtering the connection

Example
{"attributes":ProductToProductAttributeConnection,"averageRating":123.45,"catalogVisibility":"CATALOG","databaseId":987,"date":"xyz789","dateOnSaleFrom":"xyz789","dateOnSaleTo":"xyz789","description":"abc123","featured":false,"galleryImages":ProductToMediaItemConnection,"globalAttributes":ProductToGlobalProductAttributeConnection,"id":4,"image":MediaItem,"link":"abc123","localAttributes":ProductToLocalProductAttributeConnection,"menuOrder":987,"metaData":[MetaData],"modified":"abc123","name":"abc123","onSale":false,"parent":Product,"productCategories":ProductToProductCategoryConnection,"productTags":ProductToProductTagConnection,"productTypes":ProductToProductTypeConnection,"purchasable":true,"purchaseNote":"xyz789","related":ProductToProductConnection,"reviewCount":123,"reviews":ProductToCommentConnection,"reviewsAllowed":true,"shippingClasses":ProductToShippingClassConnection,"shortDescription":"abc123","sku":"abc123","slug":"xyz789","status":"abc123","totalSales":987,"type":"EXTERNAL","upsell":ProductToUpsellConnection,"visibleProducts":ProductToVisibleProductConnection}