Choose a version:

ShopifyFunction

object

A Shopify Function.

Anchor to FieldsFields

Anchor to apiTypeapiType •String! non-null: The API type of the Shopify Function.
Anchor to apiVersionapiVersion •String! non-null: The API version of the Shopify Function.
Anchor to appapp •App! non-null: The app that owns the Shopify Function.
Anchor to appBridgeappBridge •FunctionsAppBridge! non-null: The App Bridge information for the Shopify Function.
Anchor to appKeyappKey •String! non-null: The client ID of the app that owns the Shopify Function.
Anchor to descriptiondescription •String: The description of the Shopify Function.
Anchor to handlehandle •String! non-null: The handle of the Shopify Function.
Anchor to idid •String! non-null: The ID of the Shopify Function.
Anchor to inputQueryinputQuery •String: The input query of the Shopify Function.
Anchor to titletitle •String! non-null: The title of the Shopify Function.
Anchor to useCreationUiuseCreationUi •Boolean! non-null: If the Shopify Function uses the creation UI in the Admin.

Was this section helpful?

Anchor to shopifyFunction shopifyFunction •query: Returns a Shopify Function by its ID. Functions enable you to customize Shopify's backend logic at defined parts of the commerce loop.
Anchor to shopifyFunctions shopifyFunctions •query: 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 validation, and fulfillment.

You can filter the results by API type to find specific function implementations, or by whether they provide a merchant configuration interface in the Shopify Admin.

The response includes details about each function's configuration, including its title, description, API version, and the input query used to provide data to the function logic.

Learn more about building functions.

Was this section helpful?