Schema Documentation

externalProduct

Description

A simple product object

Response

Returns an ExternalProduct

Arguments
NameDescription
id - ID The ID for identifying the ExternalProduct product
idType - ProductIdTypeEnum Type of ID being used identify product

Example

Query
query externalProduct(
  $id: ID,
  $idType: ProductIdTypeEnum
){
  externalProduct(
    id: $id,
    idType: $idType
  ){
    attributes {
      ...ProductToProductAttributeConnectionFragment
    }averageRatingbuttonTextcatalogVisibilitycommentCountcommentStatuscontentcontentType {
      ...ContentNodeToContentTypeConnectionEdgeFragment
    }contentTypeNamedatabaseIddatedateGmtdateOnSaleFromdateOnSaleTodefaultAttributes {
      ...ExternalProductToVariationAttributeConnectionFragment
    }descriptiondesiredSlugeditingLockedBy {
      ...ContentNodeToEditLockConnectionEdgeFragment
    }enclosureenqueuedScripts {
      ...ContentNodeToEnqueuedScriptConnectionFragment
    }enqueuedStylesheets {
      ...ContentNodeToEnqueuedStylesheetConnectionFragment
    }externalUrlfeaturedfeaturedImage {
      ...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
    }featuredImageDatabaseIdfeaturedImageIdgalleryImages {
      ...ProductToMediaItemConnectionFragment
    }globalAttributes {
      ...ProductToGlobalProductAttributeConnectionFragment
    }guididimage {
      ...MediaItemFragment
    }isContentNodeisPreviewisRestrictedisTermNodelastEditedBy {
      ...ContentNodeToEditLastConnectionEdgeFragment
    }linklocalAttributes {
      ...ProductToLocalProductAttributeConnectionFragment
    }menuOrdermetaData {
      ...MetaDataFragment
    }modifiedmodifiedGmtnameonSaleparent {
      ...ProductFragment
    }previewRevisionDatabaseIdpreviewRevisionIdpriceproductCategories {
      ...ProductToProductCategoryConnectionFragment
    }productTags {
      ...ProductToProductTagConnectionFragment
    }productTypes {
      ...ProductToProductTypeConnectionFragment
    }purchasablepurchaseNoteregularPricerelated {
      ...ProductToProductConnectionFragment
    }reviewCountreviews {
      ...ProductToCommentConnectionFragment
    }reviewsAllowedsalePriceseo {
      ...PostTypeSEOFragment
    }shippingClasses {
      ...ProductToShippingClassConnectionFragment
    }shortDescriptionskuslugstatustaxClasstaxStatustemplate {
      ...ContentTemplateFragment
    }totalSalestypeupsell {
      ...ProductToUpsellConnectionFragment
    }urivisibleProducts {
      ...ProductToVisibleProductConnectionFragment
    }
  }
}
Variables
{"id":"4","idType":"DATABASE_ID"}
Response
{"data":{"externalProduct":{"attributes":ProductToProductAttributeConnection,"averageRating":123.45,"buttonText":"xyz789","catalogVisibility":"CATALOG","commentCount":123,"commentStatus":"xyz789","content":"abc123","contentType":ContentNodeToContentTypeConnectionEdge,"contentTypeName":"xyz789","databaseId":987,"date":"xyz789","dateGmt":"abc123","dateOnSaleFrom":"abc123","dateOnSaleTo":"xyz789","defaultAttributes":ExternalProductToVariationAttributeConnection,"description":"abc123","desiredSlug":"xyz789","editingLockedBy":ContentNodeToEditLockConnectionEdge,"enclosure":"xyz789","enqueuedScripts":ContentNodeToEnqueuedScriptConnection,"enqueuedStylesheets":ContentNodeToEnqueuedStylesheetConnection,"externalUrl":"xyz789","featured":false,"featuredImage":NodeWithFeaturedImageToMediaItemConnectionEdge,"featuredImageDatabaseId":123,"featuredImageId":4,"galleryImages":ProductToMediaItemConnection,"globalAttributes":ProductToGlobalProductAttributeConnection,"guid":"abc123","id":4,"image":MediaItem,"isContentNode":true,"isPreview":false,"isRestricted":true,"isTermNode":true,"lastEditedBy":ContentNodeToEditLastConnectionEdge,"link":"xyz789","localAttributes":ProductToLocalProductAttributeConnection,"menuOrder":987,"metaData":[MetaData],"modified":"abc123","modifiedGmt":"xyz789","name":"xyz789","onSale":false,"parent":Product,"previewRevisionDatabaseId":123,"previewRevisionId":"4","price":"abc123","productCategories":ProductToProductCategoryConnection,"productTags":ProductToProductTagConnection,"productTypes":ProductToProductTypeConnection,"purchasable":false,"purchaseNote":"xyz789","regularPrice":"abc123","related":ProductToProductConnection,"reviewCount":123,"reviews":ProductToCommentConnection,"reviewsAllowed":true,"salePrice":"xyz789","seo":PostTypeSEO,"shippingClasses":ProductToShippingClassConnection,"shortDescription":"xyz789","sku":"abc123","slug":"xyz789","status":"xyz789","taxClass":"INHERIT_CART","taxStatus":"NONE","template":ContentTemplate,"totalSales":987,"type":"EXTERNAL","upsell":ProductToUpsellConnection,"uri":"abc123","visibleProducts":ProductToVisibleProductConnection}}}