Schema Documentation

Types

ProductUnion

Description

Union between the product and product variation types

Fields
Field NameDescription
averageRating - Float Product average count
catalogVisibility - CatalogVisibilityEnum Catalog visibility
databaseId - Int! Product or variation ID
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
id - ID! Product or variation global ID
image - MediaItem Main image
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

name - String Product name
onSale - Boolean Is product on sale?
purchasable - Boolean Can product be purchased?
purchaseNote - String Purchase note
reviewCount - Int Product review count
reviewsAllowed - Boolean If reviews are allowed
shortDescription - String Product short description
Arguments
format - PostObjectFieldFormatEnum

Format of the field output

sku - String Product SKU
slug - String Product slug
totalSales - Int Number total of sales
type - ProductTypesEnum Product type
Possible Types
ProductUnion Types

VariableProduct

BundleProduct

CompositeProduct

ExternalProduct

GroupProduct

SimpleProduct

SubscriptionProduct

SubscriptionVariableProduct

SimpleProductVariation

SubscriptionProductVariation

Example
{"averageRating":123.45,"catalogVisibility":"CATALOG","databaseId":987,"dateOnSaleFrom":"abc123","dateOnSaleTo":"abc123","description":"abc123","featured":false,"id":"4","image":MediaItem,"menuOrder":987,"metaData":[MetaData],"name":"xyz789","onSale":false,"purchasable":true,"purchaseNote":"abc123","reviewCount":987,"reviewsAllowed":true,"shortDescription":"abc123","sku":"abc123","slug":"abc123","totalSales":987,"type":"BUNDLE"}