Schema Documentation
ProductVariation
Description
A product variation object
Fields
Field Name | Description |
---|---|
attributes - ProductVariationToVariationAttributeConnection | Connection between the ProductVariation type and the VariationAttribute type |
Arguments
| |
backorders - BackordersEnum | Product variation backorders |
backordersAllowed - Boolean | Can product be backordered? |
catalogVisibility - CatalogVisibilityEnum | Product variation 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! | The ID of the refund in the database |
date - String | Date variation created |
dateGmt - String | The publishing date set in GMT. |
dateOnSaleFrom - String | Date on sale from |
dateOnSaleTo - String | Date on sale to |
description - String | Product description |
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
| |
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection | Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
| |
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 variation height |
id - ID! | The globally unique identifier for the product variation |
image - MediaItem | Product variation 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 variation length |
link - String | The permalink of the post |
manageStock - ManageStockEnum | if/how product variation stock is managed |
menuOrder - Int | Menu order |
metaData - [MetaData] | Object meta data |
modified - String | Date variation last updated |
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 variation 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 variation's active price |
Arguments
| |
purchasable - Boolean | If product variation can be bought |
purchaseNote - String | Product variation purchase_note |
regularPrice - String | Product variation's regular price |
Arguments
| |
salePrice - String | Product variation's sale price |
Arguments
| |
seo - PostTypeSEO | The Yoast SEO data of the ContentNode |
shippingClass - String | Product variation shipping class |
shippingClasses - ProductVariationToShippingClassConnection | Connection between the ProductVariation type and the shippingClass type |
Arguments
| |
sku - String | Product variation SKU (Stock-keeping unit) |
slug - String | The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String | Variation status |
stockQuantity - Int | Product variation stock quantity |
stockStatus - StockStatusEnum | Product stock status |
taxClass - TaxClassEnum | Product variation tax class |
taxStatus - TaxStatusEnum | Tax status |
template - ContentTemplate | The template assigned to a node of content |
type - ProductTypesEnum | Product type |
uri - String | The unique resource identifier path |
virtual - Boolean | Is product virtual? |
visibleProducts - ProductVariationToVisibleProductConnection | Connection between the ProductVariation type and the visibleProduct type |
Arguments
| |
weight - String | Product variation weight |
width - String | Product variation width |
Example
{"attributes":ProductVariationToVariationAttributeConnection,"backorders":"NO","backordersAllowed":true,"catalogVisibility":"CATALOG","contentType":ContentNodeToContentTypeConnectionEdge,"contentTypeName":"xyz789","databaseId":123,"date":"xyz789","dateGmt":"abc123","dateOnSaleFrom":"abc123","dateOnSaleTo":"abc123","description":"abc123","desiredSlug":"abc123","downloadExpiry":123,"downloadLimit":987,"downloadable":false,"downloads":[ProductDownload],"editingLockedBy":ContentNodeToEditLockConnectionEdge,"enclosure":"xyz789","enqueuedScripts":ContentNodeToEnqueuedScriptConnection,"enqueuedStylesheets":ContentNodeToEnqueuedStylesheetConnection,"featuredImage":NodeWithFeaturedImageToMediaItemConnectionEdge,"featuredImageDatabaseId":123,"featuredImageId":"4","guid":"abc123","hasAttributes":false,"height":"abc123","id":"4","image":MediaItem,"isContentNode":true,"isPreview":false,"isRestricted":false,"isTermNode":false,"lastEditedBy":ContentNodeToEditLastConnectionEdge,"length":"abc123","link":"abc123","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":"xyz789","regularPrice":"abc123","salePrice":"xyz789","seo":PostTypeSEO,"shippingClass":"xyz789","shippingClasses":ProductVariationToShippingClassConnection,"sku":"abc123","slug":"abc123","status":"abc123","stockQuantity":123,"stockStatus":"IN_STOCK","taxClass":"INHERIT_CART","taxStatus":"NONE","template":ContentTemplate,"type":"BUNDLE","uri":"xyz789","virtual":true,"visibleProducts":ProductVariationToVisibleProductConnection,"weight":"xyz789","width":"abc123"}