younifyd
Menu

productByIdentifier

Fetch a single product by its ID.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the productByIdentifier action (under Product).
  3. Fill in the fields below, then reference the result from later steps as {{productbyidentifier.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query ProductByIdentifier($identifier: ProductIdentifierInput!) {
  productByIdentifier(identifier: $identifier) {
    availablePublicationsCount {
      count
      precision
    }
    bodyHtml
    bundleConsolidatedOptions {
      name
      selections {
        components
        value
      }
    }
    category {
      ancestorIds
      childrenIds
      fullName
      id
      isArchived
      isLeaf
      isRoot
      level
      name
      parentId
    }
    combinedListing {
      parentProduct
    }
    combinedListingRole
    compareAtPriceRange {
      maxVariantCompareAtPrice {
        amount
        currencyCode
      }
      minVariantCompareAtPrice {
        amount
        currencyCode
      }
    }
    createdAt
    customProductType
    defaultCursor
    descriptionHtml
    descriptionPlainSummary
    featuredImage {
      altText
      height
      id
      originalSrc
      src
      thumbhash
      width
    }
    featuredMedia {
      alt
      id
      mediaContentType
      mediaErrors {
        code
        details
        message
      }
      mediaWarnings {
        code
        message
      }
      preview {
        image
        status
      }
      status
    }
    feedback {
      appFeedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      details {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      summary
    }
    giftCardSettings {
      crossCurrencyRedeemable
      issuanceCurrency
    }
    giftCardTemplateSuffix
    handle
    hasOnlyDefaultVariant
    hasOutOfStockVariants
    hasVariantsThatRequiresComponents
    id
    isGiftCard
    legacyResourceId
    mediaCount {
      count
      precision
    }
    onlineStorePreviewUrl
    onlineStoreUrl
    priceRange {
      maxVariantPrice {
        amount
        currencyCode
      }
      minVariantPrice {
        amount
        currencyCode
      }
    }
    priceRangeV2 {
      maxVariantPrice {
        amount
        currencyCode
      }
      minVariantPrice {
        amount
        currencyCode
      }
    }
    productCategory {
      productTaxonomyNode {
        fullName
        id
        isLeaf
        isRoot
        name
      }
    }
    productComponentsCount {
      count
      precision
    }
    productType
    publishedAt
    publishedOnCurrentChannel
    publishedOnCurrentPublication
    requiresSellingPlan
    resourcePublicationOnCurrentPublication {
      isPublished
      publication {
        app
        autoPublish
        catalog
        id
        name
        operation
        supportsFuturePublishing
      }
      publishDate
      publishable {
        availablePublicationsCount
        publishedOnCurrentChannel
        publishedOnCurrentPublication
      }
    }
    sellingPlanGroupCount
    sellingPlanGroupsCount {
      count
      precision
    }
    seo {
      description
      title
    }
    standardizedProductType {
      productTaxonomyNode {
        fullName
        id
        isLeaf
        isRoot
        name
      }
    }
    status
    storefrontId
    tags
    templateSuffix
    title
    totalInventory
    totalVariants
    tracksInventory
    updatedAt
    variantsCount {
      count
      precision
    }
    vendor
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

identifierobjectrequired

The identifier of the product.

idstring
customIdobject3 fields
handlestring
json
{
  "identifier": {
    "id": "string",
    "customId": {
      "key": "string",
      "value": "string",
      "namespace": "string"
    },
    "handle": "string"
  }
}

Response

Read the result with {{productbyidentifier.response.data.data.productByIdentifier}}. If the API returns errors, the step fails and they are at {{productbyidentifier.response.data.errors}}.

availablePublicationsCountobject
countnumber
precisionstring

One ofEXACTAT_LEAST

bodyHtmlstring
bundleConsolidatedOptionsarray<object>
nameobject
selectionsobject
categoryobject
ancestorIdsarray<object>
childrenIdsarray<object>
fullNamestring
idstring
isArchivedboolean
isLeafboolean
isRootboolean
levelnumber
namestring
parentIdstring
combinedListingobject
parentProductobject

Recursive reference to Product, not further expanded.

combinedListingRolestring

One ofPARENTCHILD

compareAtPriceRangeobject
maxVariantCompareAtPriceobject2 fields
minVariantCompareAtPriceobject2 fields
createdAtstring
customProductTypestring
defaultCursorstring
descriptionHtmlstring
descriptionPlainSummarystring
featuredImageobject
altTextstring
heightnumber
idstring
originalSrcstring
srcstring
thumbhashstring
widthnumber
featuredMediaobject
altstring
idstring
mediaContentTypestring

One ofVIDEOEXTERNAL_VIDEOMODEL_3DIMAGE

mediaErrorsarray<object>
mediaWarningsarray<object>
previewobject2 fields
statusstring

One ofUPLOADEDPROCESSINGREADYFAILED

feedbackobject
appFeedbackarray<object>
detailsarray<object>
summarystring
giftCardSettingsobject
crossCurrencyRedeemableboolean
issuanceCurrencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

giftCardTemplateSuffixstring
handlestring
hasOnlyDefaultVariantboolean
hasOutOfStockVariantsboolean
hasVariantsThatRequiresComponentsboolean
idstring
isGiftCardboolean
legacyResourceIdstring
mediaCountobject
countnumber
precisionstring

One ofEXACTAT_LEAST

onlineStorePreviewUrlstring
onlineStoreUrlstring
priceRangeobject
maxVariantPriceobject2 fields
minVariantPriceobject2 fields
priceRangeV2object
maxVariantPriceobject2 fields
minVariantPriceobject2 fields
productCategoryobject
productTaxonomyNodeobject5 fields
productComponentsCountobject
countnumber
precisionstring

One ofEXACTAT_LEAST

productTypestring
publishedAtstring
publishedOnCurrentChannelboolean
publishedOnCurrentPublicationboolean
requiresSellingPlanboolean
resourcePublicationOnCurrentPublicationobject
isPublishedboolean
publicationobject7 fields
publishDatestring
publishableobject3 fields
sellingPlanGroupCountnumber
sellingPlanGroupsCountobject
countnumber
precisionstring

One ofEXACTAT_LEAST

seoobject
descriptionstring
titlestring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.