How to Create, Retrieve, Update, and Delete Shopify Metafields Using Shopify API

Step 1: Set Up Your Environment

1. Install Dependencies: Make sure you have dotenv and shopify-api-node installed:

npm install dotenv shopify-api-node

Create Your .env File:

• Create a .env file in the root of your project with your Shopify store details:

SHOPIFY_STORE=your-store-name.myshopify.com
SHOPIFY_ACCESS_TOKEN=your-access-token

Step 2: Create Metafields

Create a file, e.g., metafields.js, and add the following code to handle metafield operations:

Create Metafield

require('dotenv').config()
const Shopify = require('shopify-api-node')

const shopify = new Shopify({
    shopName: process.env.SHOPIFY_STORE,
    accessToken: process.env.SHOPIFY_ACCESS_TOKEN
})

const createMetafield = async () => {
    try {
        const metafield = await shopify.metafield.create({
            namespace: 'custom_namespace',
            key: 'custom_key',
            value: 'custom_value',
            value_type: 'string',
            owner_resource: 'product',
            owner_id: 'product_id' // Replace with actual product ID
        })
        console.log('Metafield created:', metafield)
    } catch (error) {
        console.error('Error creating metafield:', error)
    }
}

createMetafield()

Step 3: Retrieve Metafields

Retrieve Metafields

const retrieveMetafields = async () => {
    try {
        const metafields = await shopify.metafield.list({
            owner_resource: 'product',
            owner_id: 'product_id' // Replace with actual product ID
        })
        console.log('Metafields retrieved:', metafields)
    } catch (error) {
        console.error('Error retrieving metafields:', error)
    }
}

retrieveMetafields()

Step 4: Update Metafields

Update Metafield

const updateMetafield = async () => {
    try {
        const metafield = await shopify.metafield.update('metafield_id', { // Replace with actual metafield ID
            value: 'new_custom_value',
            value_type: 'string'
        })
        console.log('Metafield updated:', metafield)
    } catch (error) {
        console.error('Error updating metafield:', error)
    }
}

updateMetafield()

Step 5: Delete Metafields

Delete Metafield

const deleteMetafield = async () => {
    try {
        await shopify.metafield.delete('metafield_id') // Replace with actual metafield ID
        console.log('Metafield deleted')
    } catch (error) {
        console.error('Error deleting metafield:', error)
    }
}

deleteMetafield()

Complete Example Code

Here’s a consolidated script to perform all CRUD operations on metafields:

require('dotenv').config()
const Shopify = require('shopify-api-node')

const shopify = new Shopify({
    shopName: process.env.SHOPIFY_STORE,
    accessToken: process.env.SHOPIFY_ACCESS_TOKEN
})

// Create Metafield
const createMetafield = async () => {
    try {
        const metafield = await shopify.metafield.create({
            namespace: 'custom_namespace',
            key: 'custom_key',
            value: 'custom_value',
            value_type: 'string',
            owner_resource: 'product',
            owner_id: 'product_id' // Replace with actual product ID
        })
        console.log('Metafield created:', metafield)
    } catch (error) {
        console.error('Error creating metafield:', error)
    }
}

// Retrieve Metafields
const retrieveMetafields = async () => {
    try {
        const metafields = await shopify.metafield.list({
            owner_resource: 'product',
            owner_id: 'product_id' // Replace with actual product ID
        })
        console.log('Metafields retrieved:', metafields)
    } catch (error) {
        console.error('Error retrieving metafields:', error)
    }
}

// Update Metafield
const updateMetafield = async () => {
    try {
        const metafield = await shopify.metafield.update('metafield_id', { // Replace with actual metafield ID
            value: 'new_custom_value',
            value_type: 'string'
        })
        console.log('Metafield updated:', metafield)
    } catch (error) {
        console.error('Error updating metafield:', error)
    }
}

// Delete Metafield
const deleteMetafield = async () => {
    try {
        await shopify.metafield.delete('metafield_id') // Replace with actual metafield ID
        console.log('Metafield deleted')
    } catch (error) {
        console.error('Error deleting metafield:', error)
    }
}

// Uncomment the function you want to execute
// createMetafield()
// retrieveMetafields()
// updateMetafield()
// deleteMetafield()

Running the Script

To run the script, uncomment the function you want to execute and run the following command in your terminal:

node metafields.js

This setup should allow you to create, retrieve, update, and delete metafields in your Shopify store using the Shopify API and Node.js. If you have any further questions or need assistance, feel free to ask!