Menu
metafieldDefinition
Retrieves a MetafieldDefinition by its identifier. You can identify a definition using either its owner type, namespace, and key, or its global ID.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the metafieldDefinition action (under Metafield).
- Fill in the fields below, then reference the result from later steps as
{{metafielddefinition.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.
query MetafieldDefinition($id: ID, $identifier: MetafieldDefinitionIdentifierInput) {
metafieldDefinition(id: $id, identifier: $identifier) {
access {
admin
customerAccount
storefront
}
capabilities {
adminFilterable {
eligible
enabled
status
}
analyticsQueryable {
eligible
enabled
}
cartToOrderCopyable {
eligible
enabled
}
smartCollectionCondition {
eligible
enabled
}
uniqueValues {
eligible
enabled
}
}
constraints {
key
}
description
id
key
name
namespace
ownerType
pinnedPosition
standardTemplate {
description
id
key
name
namespace
ownerTypes
type {
category
name
supportedValidations
supportsDefinitionMigrations
valueType
}
validations {
name
type
value
}
visibleToStorefrontApi
}
type {
category
name
supportedValidations {
name
type
}
supportsDefinitionMigrations
valueType
}
useAsCollectionCondition
validationStatus
validations {
name
type
value
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"id": "string",
"identifier": {
"ownerType": "API_PERMISSION",
"key": "string",
"namespace": "string"
}
}
Response
Read the result with {{metafielddefinition.response.data.data.metafieldDefinition}}. If the API returns errors, the step fails and they are at {{metafielddefinition.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?