Schema Documentation

Types

SimpleProductVariation

Description

A product variation

Fields
Field NameDescription
attributes - ProductVariationToVariationAttributeConnection Connection between the ProductVariation type and the VariationAttribute 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

averageRating - Float Product average count
backorders - BackordersEnum Product backorders status
backordersAllowed - Boolean Can product be backordered?
catalogVisibility - CatalogVisibilityEnum Catalog visibility
contentType - ContentNodeToContentTypeConnectionEdge Connection between the ContentNode type and the ContentType type
contentTypeName - String! The name of the Content Type the node belongs to
databaseId - Int! Product or variation ID
date - String Post publishing date.
dateGmt - String The publishing date set in GMT.
dateOnSaleFrom - String Date on sale from
dateOnSaleTo - String Date on sale to
description - String Product description
Arguments
format - PostObjectFieldFormatEnum

Format of the field output

desiredSlug - String The desired slug of the post
downloadExpiry - Int Download expiry
downloadLimit - Int Download limit
downloadable - Boolean Is downloadable?
downloads - [ProductDownload] Product downloads
editingLockedBy - ContentNodeToEditLockConnectionEdge If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds
enclosure - String The RSS enclosure for the object
enqueuedScripts - ContentNodeToEnqueuedScriptConnection Connection between the ContentNode type and the EnqueuedScript 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

enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection Connection between the ContentNode type and the EnqueuedStylesheet 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

featured - Boolean If the product is featured
featuredImage - NodeWithFeaturedImageToMediaItemConnectionEdge Connection between the NodeWithFeaturedImage type and the MediaItem type
featuredImageDatabaseId - Int The database identifier for the featured image node assigned to the content node
featuredImageId - ID Globally unique ID of the featured image assigned to the node
guid - String The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table.
hasAttributes - Boolean Does product variation have any visible attributes
height - String Product's height
id - ID! Product or variation global ID
image - MediaItem Main image
isContentNode - Boolean! Whether the node is a Content Node
isPreview - Boolean Whether the object is a node in the preview state
isRestricted - Boolean Whether the object is restricted from the current viewer
isTermNode - Boolean! Whether the node is a Term
lastEditedBy - ContentNodeToEditLastConnectionEdge The user that most recently edited the node
length - String Product's length
link - String The permalink of the post
lowStockAmount - Int Low stock amount
manageStock - ManageStockEnum If product manage stock
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 The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time.
modifiedGmt - String The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT.
name - String Product name
onSale - Boolean Is product on sale?
parent - ProductVariationToVariableProductConnectionEdge The parent of the node. The parent object can be of various types
previewRevisionDatabaseId - Int The database id of the preview node
previewRevisionId - ID Whether the object is a node in the preview state
price - String Product's active price
Arguments
format - PricingFieldFormatEnum

Format of the price

purchasable - Boolean Can product be purchased?
purchaseNote - String Purchase note
regularPrice - String Product's regular price
Arguments
format - PricingFieldFormatEnum

Format of the price

reviewCount - Int Product review count
reviewsAllowed - Boolean If reviews are allowed
salePrice - String Product's sale price
Arguments
format - PricingFieldFormatEnum

Format of the price

seo - PostTypeSEO The Yoast SEO data of the ContentNode
shippingClass - String Product variation shipping class
shippingClassId - Int shipping class ID
shippingRequired - Boolean Does product need to be shipped?
shippingTaxable - Boolean Is product shipping taxable?
shortDescription - String Product short description
Arguments
format - PostObjectFieldFormatEnum

Format of the field output

sku - String Product SKU
slug - String Product slug
soldIndividually - Boolean If should be sold individually
status - String The current status of the object
stockQuantity - Int Number of items available for sale
stockStatus - StockStatusEnum Product stock status
taxClass - TaxClassEnum Tax class
taxStatus - TaxStatusEnum Tax status
template - ContentTemplate The template assigned to a node of content
totalSales - Int Number total of sales
type - ProductTypesEnum Product type
uri - String The unique resource identifier path
virtual - Boolean Is product virtual?
weight - String Product's weight
width - String Product's width
Example
{"attributes":ProductVariationToVariationAttributeConnection,"averageRating":987.65,"backorders":"NO","backordersAllowed":true,"catalogVisibility":"CATALOG","contentType":ContentNodeToContentTypeConnectionEdge,"contentTypeName":"abc123","databaseId":987,"date":"abc123","dateGmt":"abc123","dateOnSaleFrom":"xyz789","dateOnSaleTo":"xyz789","description":"abc123","desiredSlug":"xyz789","downloadExpiry":987,"downloadLimit":123,"downloadable":true,"downloads":[ProductDownload],"editingLockedBy":ContentNodeToEditLockConnectionEdge,"enclosure":"abc123","enqueuedScripts":ContentNodeToEnqueuedScriptConnection,"enqueuedStylesheets":ContentNodeToEnqueuedStylesheetConnection,"featured":true,"featuredImage":NodeWithFeaturedImageToMediaItemConnectionEdge,"featuredImageDatabaseId":123,"featuredImageId":4,"guid":"xyz789","hasAttributes":true,"height":"xyz789","id":"4","image":MediaItem,"isContentNode":true,"isPreview":false,"isRestricted":false,"isTermNode":true,"lastEditedBy":ContentNodeToEditLastConnectionEdge,"length":"xyz789","link":"xyz789","lowStockAmount":987,"manageStock":"FALSE","menuOrder":987,"metaData":[MetaData],"modified":"xyz789","modifiedGmt":"abc123","name":"xyz789","onSale":false,"parent":ProductVariationToVariableProductConnectionEdge,"previewRevisionDatabaseId":123,"previewRevisionId":"4","price":"abc123","purchasable":false,"purchaseNote":"abc123","regularPrice":"abc123","reviewCount":123,"reviewsAllowed":false,"salePrice":"xyz789","seo":PostTypeSEO,"shippingClass":"abc123","shippingClassId":123,"shippingRequired":true,"shippingTaxable":true,"shortDescription":"xyz789","sku":"xyz789","slug":"xyz789","soldIndividually":false,"status":"abc123","stockQuantity":123,"stockStatus":"IN_STOCK","taxClass":"INHERIT_CART","taxStatus":"NONE","template":ContentTemplate,"totalSales":123,"type":"BUNDLE","uri":"abc123","virtual":false,"weight":"xyz789","width":"xyz789"}