metafieldsSet

Create or update up to 25 metafields across any resources in one call.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the metafieldsSet action (under Metafields).
Fill in the fields below, then reference the result from later steps as {{metafieldsset.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {
  metafieldsSet(metafields: $metafields) {
    metafields {
      compareDigest
      createdAt
      definition {
        access
        capabilities
        constraints
        description
        id
        key
        name
        namespace
        ownerType
        pinnedPosition
        standardTemplate
        type
        useAsCollectionCondition
        validationStatus
        validations
      }
      description
      id
      jsonValue
      key
      legacyResourceId
      namespace
      owner
      ownerType
      reference
      sizeInBytes
      type
      updatedAt
      value
    }
    userErrors {
      code
      elementIndex
      field
      message
    }
  }
}

Variables

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

metafieldsarray<object>required

The list of metafield values to set. Maximum of 25.

ownerIdstringrequired

namespacestring

keystringrequired

valuestringrequired

compareDigeststring

typestring

json

{
  "metafields": [
    {
      "ownerId": "string",
      "key": "string",
      "value": "string",
      "namespace": "string",
      "compareDigest": "string",
      "type": "string"
    }
  ]
}

Response

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

metafieldsarray<object>

compareDigestobject

createdAtobject

definitionobject

descriptionobject

idobject

jsonValueobject

keyobject

legacyResourceIdobject

namespaceobject

ownerobject

ownerTypeobject

referenceobject

sizeInBytesobject

typeobject

updatedAtobject

valueobject

userErrorsarray<object>

codeobject

elementIndexobject

fieldobject

messageobject

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

Was this page helpful?