Menu
metaobjectDefinition
Retrieves a MetaobjectDefinition by its global ID. Metaobject definitions provide the structure and fields for metaobjects.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the metaobjectDefinition action (under Metaobject).
- Fill in the fields below, then reference the result from later steps as
{{metaobjectdefinition.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 MetaobjectDefinition($id: ID!) {
metaobjectDefinition(id: $id) {
access {
admin
customerAccount
storefront
}
capabilities {
onlineStore {
data
enabled
}
publishable {
enabled
}
renderable {
data
enabled
}
translatable {
enabled
}
}
createdAt
createdByApp {
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
}
createdByStaff {
accountType
active
email
exists
firstName
id
initials
isShopOwner
lastName
locale
name
phone
privateData {
accountSettingsUrl
createdAt
permissions
}
}
description
displayNameKey
fieldDefinitions {
capabilities {
adminFilterable
}
description
key
name
required
type {
category
name
supportedValidations
supportsDefinitionMigrations
valueType
}
validations {
name
type
value
}
}
hasThumbnailField
id
metaobjectsCount
name
standardTemplate {
access {
admin
customerAccount
storefront
}
description
displayNameKey
enabledCapabilities {
capabilityType
}
fieldDefinitions {
description
key
name
required
type
validations
visibleToStorefrontApi
}
name
type
}
type
updatedAt
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"id": "string"
}
Response
Read the result with {{metaobjectdefinition.response.data.data.metaobjectDefinition}}. If the API returns errors, the step fails and they are at {{metaobjectdefinition.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?