shopifyFunction

Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the shopifyFunction action (under Shopify).
Fill in the fields below, then reference the result from later steps as {{shopifyfunction.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 ShopifyFunction($id: String!) {
  shopifyFunction(id: $id) {
    apiType
    apiVersion
    app {
      apiKey
      appStoreAppUrl
      appStoreDeveloperUrl
      availableAccessScopes {
        description
        handle
      }
      banner {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      description
      developerName
      developerType
      developerUrl
      embedded
      failedRequirements {
        action
        message
      }
      features
      feedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      handle
      icon {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      id
      installUrl
      installation {
        accessScopes
        activeSubscriptions
        app
        channel
        id
        launchUrl
        publication
        subscriptions
        uninstallUrl
      }
      isPostPurchaseAppInUse
      launchUrl
      navigationItems {
        id
        title
        url
      }
      optionalAccessScopes {
        description
        handle
      }
      previouslyInstalled
      pricingDetails
      pricingDetailsSummary
      privacyPolicyUrl
      publicCategory
      published
      requestedAccessScopes {
        description
        handle
      }
      screenshots {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      shopifyDeveloped
      title
      uninstallMessage
      uninstallUrl
      webhookApiVersion
    }
    appBridge {
      createPath
      detailsPath
    }
    appKey
    description
    handle
    id
    inputQuery
    title
    useCreationUi
  }
}

Variables

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

idstringrequired

The ID of the Shopify Function.

json

{
  "id": "string"
}

Response

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

apiTypestring

apiVersionstring

appobject

apiKeystring

appStoreAppUrlstring

appStoreDeveloperUrlstring

availableAccessScopesarray<object>

bannerobject7 fields

descriptionstring

developerNamestring

developerTypestring

One ofSHOPIFYPARTNERMERCHANTUNKNOWN

developerUrlstring

embeddedboolean

failedRequirementsarray<object>

featuresarray<object>

feedbackobject6 fields

handlestring

iconobject7 fields

idstring

installUrlstring

installationobject9 fields

isPostPurchaseAppInUseboolean

launchUrlstring

navigationItemsarray<object>

optionalAccessScopesarray<object>

previouslyInstalledboolean

pricingDetailsstring

pricingDetailsSummarystring

privacyPolicyUrlstring

publicCategorystring

One ofPRIVATEPUBLICCUSTOMOTHER

publishedboolean

requestedAccessScopesarray<object>

screenshotsarray<object>

shopifyDevelopedboolean

titlestring

uninstallMessagestring

uninstallUrlstring

webhookApiVersionstring

appBridgeobject

createPathstring

detailsPathstring

appKeystring

descriptionstring

handlestring

idstring

inputQuerystring

titlestring

useCreationUiboolean

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

Was this page helpful?