Menu
metaobjectByHandle
Retrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the metaobjectByHandle action (under Metaobject).
- Fill in the fields below, then reference the result from later steps as
{{metaobjectbyhandle.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 MetaobjectByHandle($handle: MetaobjectHandleInput!) {
metaobjectByHandle(handle: $handle) {
capabilities {
onlineStore {
templateSuffix
}
publishable {
status
}
}
createdAt
createdBy {
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
}
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
}
}
definition {
access {
admin
customerAccount
storefront
}
capabilities {
onlineStore
publishable
renderable
translatable
}
createdAt
createdByApp {
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
}
createdByStaff {
accountType
active
email
exists
firstName
id
initials
isShopOwner
lastName
locale
name
phone
privateData
}
description
displayNameKey
fieldDefinitions {
capabilities
description
key
name
required
type
validations
}
hasThumbnailField
id
metaobjectsCount
name
standardTemplate {
access
description
displayNameKey
enabledCapabilities
fieldDefinitions
name
type
}
type
updatedAt
}
displayName
fields {
definition {
capabilities
description
key
name
required
type
validations
}
jsonValue
key
reference
thumbnail {
file
hex
}
type
value
}
handle
id
staffMember {
accountType
active
email
exists
firstName
id
initials
isShopOwner
lastName
locale
name
phone
privateData {
accountSettingsUrl
createdAt
permissions
}
}
thumbnailField {
definition {
capabilities
description
key
name
required
type
validations
}
jsonValue
key
reference
thumbnail {
file
hex
}
type
value
}
type
updatedAt
values
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"handle": {
"type": "string",
"handle": "string"
}
}
Response
Read the result with {{metaobjectbyhandle.response.data.data.metaobjectByHandle}}. If the API returns errors, the step fails and they are at {{metaobjectbyhandle.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?