shopifyFunctions

Returns Shopify Functions owned by the querying API client installed on the shop. Functions enable you to customize Shopify's backend logic at specific points in the commerce loop, such as discounts, checkout…

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the shopifyFunctions action (under Shopify).
Fill in the fields below, then reference the result from later steps as {{shopifyfunctions.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 ShopifyFunctions($apiType: String, $useCreationUi: Boolean, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  shopifyFunctions(
    apiType: $apiType
    useCreationUi: $useCreationUi
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        apiType
        apiVersion
        app
        appBridge
        appKey
        description
        handle
        id
        inputQuery
        title
        useCreationUi
      }
    }
    nodes {
      apiType
      apiVersion
      app {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      appBridge {
        createPath
        detailsPath
      }
      appKey
      description
      handle
      id
      inputQuery
      title
      useCreationUi
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

apiTypestring

Filter the functions by the API type.

useCreationUiboolean

Filter the functions by whether or not the function uses the creation UI in the Admin.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "apiType": "string",
  "useCreationUi": false,
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

apiTypeobject

apiVersionobject

appobject

appBridgeobject

appKeyobject

descriptionobject

handleobject

idobject

inputQueryobject

titleobject

useCreationUiobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?