younifyd
Menu

metafieldDefinitionUnpin

You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the metafieldDefinitionUnpin action (under Metafield).
  3. Fill in the fields below, then reference the result from later steps as {{metafielddefinitionunpin.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 MetafieldDefinitionUnpin($definitionId: ID, $identifier: MetafieldDefinitionIdentifierInput) {
  metafieldDefinitionUnpin(definitionId: $definitionId, identifier: $identifier) {
    unpinnedDefinition {
      access {
        admin
        customerAccount
        storefront
      }
      capabilities {
        adminFilterable
        analyticsQueryable
        cartToOrderCopyable
        smartCollectionCondition
        uniqueValues
      }
      constraints {
        key
      }
      description
      id
      key
      name
      namespace
      ownerType
      pinnedPosition
      standardTemplate {
        description
        id
        key
        name
        namespace
        ownerTypes
        type
        validations
        visibleToStorefrontApi
      }
      type {
        category
        name
        supportedValidations
        supportsDefinitionMigrations
        valueType
      }
      useAsCollectionCondition
      validationStatus
      validations {
        name
        type
        value
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

definitionIdstring

The ID of the metafield definition to unpin. Using `identifier` is preferred.

identifierobject

The identifier of the metafield definition to unpin.

ownerTypestringrequired

One ofAPI_PERMISSIONCOMPANYCOMPANY_LOCATIONPAYMENT_CUSTOMIZATIONVALIDATIONCUSTOMERDELIVERY_CUSTOMIZATIONDRAFTORDERGIFT_CARD_TRANSACTIONTRANSFERMARKETCARTTRANSFORMCOLLECTIONMEDIA_IMAGEPRODUCTPRODUCTVARIANTSELLING_PLANARTICLEBLOGPAGEFULFILLMENT_CONSTRAINT_RULEORDER_ROUTING_LOCATION_RULEDISCOUNTORDERLOCATIONSHOP

namespacestring
keystringrequired
json
{
  "definitionId": "string",
  "identifier": {
    "ownerType": "API_PERMISSION",
    "key": "string",
    "namespace": "string"
  }
}

Response

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

unpinnedDefinitionobject
accessobject3 fields
capabilitiesobject5 fields
constraintsobject1 fields
descriptionstring
idstring
keystring
namestring
namespacestring
ownerTypestring

One ofAPI_PERMISSIONCOMPANYCOMPANY_LOCATIONPAYMENT_CUSTOMIZATIONVALIDATIONCUSTOMERDELIVERY_CUSTOMIZATIONDRAFTORDERGIFT_CARD_TRANSACTIONTRANSFERMARKETCARTTRANSFORMCOLLECTIONMEDIA_IMAGEPRODUCTPRODUCTVARIANTSELLING_PLANARTICLEBLOGPAGEFULFILLMENT_CONSTRAINT_RULEORDER_ROUTING_LOCATION_RULEDISCOUNTORDERLOCATIONSHOP

pinnedPositionnumber
standardTemplateobject9 fields
typeobject5 fields
useAsCollectionConditionboolean
validationStatusstring

One ofALL_VALIDIN_PROGRESSSOME_INVALID

validationsarray<object>
userErrorsarray<object>
codeobject
fieldobject
messageobject

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

metafieldDefinitionUnpin — Shopify — Documentation