Metafield

examples

• Create a metafield for a blog

  curl -d '{"metafield":{"namespace":"my_fields","key":"sponsor","type":"single_line_text_field","value":"Shopify"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.blog_id = 382285388;
  metafield.namespace = "my_fields";
  metafield.key = "sponsor";
  metafield.type = "single_line_text_field";
  metafield.value = "Shopify";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.blog_id = 382285388
  metafield.namespace = "my_fields"
  metafield.key = "sponsor"
  metafield.type = "single_line_text_field"
  metafield.value = "Shopify"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.blog_id = 382285388;
  metafield.namespace = "my_fields";
  metafield.key = "sponsor";
  metafield.type = "single_line_text_field";
  metafield.value = "Shopify";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228952,"namespace":"my_fields","key":"sponsor","value":"Shopify","description":null,"owner_id":382285388,"created_at":"2025-07-01T14:29:35-04:00","updated_at":"2025-07-01T14:29:35-04:00","owner_resource":"blog","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228952"}}

• Create a metafield for a collection

  curl -d '{"metafield":{"namespace":"my_fields","key":"discount","type":"single_line_text_field","value":"25%"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.collection_id = 482865238;
  metafield.namespace = "my_fields";
  metafield.key = "discount";
  metafield.type = "single_line_text_field";
  metafield.value = "25%";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.collection_id = 482865238
  metafield.namespace = "my_fields"
  metafield.key = "discount"
  metafield.type = "single_line_text_field"
  metafield.value = "25%"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.collection_id = 482865238;
  metafield.namespace = "my_fields";
  metafield.key = "discount";
  metafield.type = "single_line_text_field";
  metafield.value = "25%";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228936,"namespace":"my_fields","key":"discount","value":"25%","description":null,"owner_id":482865238,"created_at":"2025-07-01T14:28:34-04:00","updated_at":"2025-07-01T14:28:34-04:00","owner_resource":"collection","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228936"}}

• Create a metafield for a customer

  curl -d '{"metafield":{"namespace":"discounts","key":"special","value":"yes","type":"single_line_text_field"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.customer_id = 207119551;
  metafield.namespace = "discounts";
  metafield.key = "special";
  metafield.value = "yes";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.customer_id = 207119551
  metafield.namespace = "discounts"
  metafield.key = "special"
  metafield.value = "yes"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.customer_id = 207119551;
  metafield.namespace = "discounts";
  metafield.key = "special";
  metafield.value = "yes";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228954,"namespace":"discounts","key":"special","value":"yes","description":null,"owner_id":207119551,"created_at":"2025-07-01T14:29:40-04:00","updated_at":"2025-07-01T14:29:40-04:00","owner_resource":"customer","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228954"}}

• Create a metafield for a draft order

  curl -d '{"metafield":{"namespace":"my_fields","key":"purchase_order","type":"single_line_text_field","value":"97453"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.draft_order_id = 622762746;
  metafield.namespace = "my_fields";
  metafield.key = "purchase_order";
  metafield.type = "single_line_text_field";
  metafield.value = "97453";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.draft_order_id = 622762746
  metafield.namespace = "my_fields"
  metafield.key = "purchase_order"
  metafield.type = "single_line_text_field"
  metafield.value = "97453"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.draft_order_id = 622762746;
  metafield.namespace = "my_fields";
  metafield.key = "purchase_order";
  metafield.type = "single_line_text_field";
  metafield.value = "97453";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228944,"namespace":"my_fields","key":"purchase_order","value":"97453","description":null,"owner_id":622762746,"created_at":"2025-07-01T14:29:01-04:00","updated_at":"2025-07-01T14:29:01-04:00","owner_resource":"draft_order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228944"}}

• Create a metafield for a page

  curl -d '{"metafield":{"namespace":"my_fields","key":"subtitle","type":"single_line_text_field","value":"A subtitle for my page"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.page_id = 131092082;
  metafield.namespace = "my_fields";
  metafield.key = "subtitle";
  metafield.type = "single_line_text_field";
  metafield.value = "A subtitle for my page";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.page_id = 131092082
  metafield.namespace = "my_fields"
  metafield.key = "subtitle"
  metafield.type = "single_line_text_field"
  metafield.value = "A subtitle for my page"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.page_id = 131092082;
  metafield.namespace = "my_fields";
  metafield.key = "subtitle";
  metafield.type = "single_line_text_field";
  metafield.value = "A subtitle for my page";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228946,"namespace":"my_fields","key":"subtitle","value":"A subtitle for my page","description":null,"owner_id":131092082,"created_at":"2025-07-01T14:29:09-04:00","updated_at":"2025-07-01T14:29:09-04:00","owner_resource":"page","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228946"}}

• Create a metafield for a product

  curl -d '{"metafield":{"namespace":"inventory","key":"warehouse","value":25,"type":"number_integer"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.product_id = 632910392;
  metafield.namespace = "inventory";
  metafield.key = "warehouse";
  metafield.value = 25;
  metafield.type = "number_integer";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.product_id = 632910392
  metafield.namespace = "inventory"
  metafield.key = "warehouse"
  metafield.value = 25
  metafield.type = "number_integer"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.product_id = 632910392;
  metafield.namespace = "inventory";
  metafield.key = "warehouse";
  metafield.value = 25;
  metafield.type = "number_integer";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228941,"namespace":"inventory","key":"warehouse","value":25,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:46-04:00","updated_at":"2025-07-01T14:28:46-04:00","owner_resource":"product","type":"number_integer","admin_graphql_api_id":"gid://shopify/Metafield/1069228941"}}

• Create a metafield for a product image

  curl -d '{"metafield":{"namespace":"translation","key":"title_spanish","type":"single_line_text_field","value":"botas"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.product_image_id = 850703190;
  metafield.namespace = "translation";
  metafield.key = "title_spanish";
  metafield.type = "single_line_text_field";
  metafield.value = "botas";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.product_image_id = 850703190
  metafield.namespace = "translation"
  metafield.key = "title_spanish"
  metafield.type = "single_line_text_field"
  metafield.value = "botas"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.product_image_id = 850703190;
  metafield.namespace = "translation";
  metafield.key = "title_spanish";
  metafield.type = "single_line_text_field";
  metafield.value = "botas";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228943,"namespace":"translation","key":"title_spanish","value":"botas","description":null,"owner_id":850703190,"created_at":"2025-07-01T14:29:01-04:00","updated_at":"2025-07-01T14:29:01-04:00","owner_resource":"product_image","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228943"}}

• Create a metafield for a product variant

  curl -d '{"metafield":{"namespace":"my_fields","key":"liner_material","type":"single_line_text_field","value":"synthetic leather"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.variant_id = 49148385;
  metafield.namespace = "my_fields";
  metafield.key = "liner_material";
  metafield.type = "single_line_text_field";
  metafield.value = "synthetic leather";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.variant_id = 49148385
  metafield.namespace = "my_fields"
  metafield.key = "liner_material"
  metafield.type = "single_line_text_field"
  metafield.value = "synthetic leather"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.variant_id = 49148385;
  metafield.namespace = "my_fields";
  metafield.key = "liner_material";
  metafield.type = "single_line_text_field";
  metafield.value = "synthetic leather";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228947,"namespace":"my_fields","key":"liner_material","value":"synthetic leather","description":null,"owner_id":49148385,"created_at":"2025-07-01T14:29:14-04:00","updated_at":"2025-07-01T14:29:14-04:00","owner_resource":"variant","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228947"}}

• Create a metafield for an article

  curl -d '{"metafield":{"namespace":"my_fields","key":"category","type":"single_line_text_field","value":"outdoors"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.article_id = 674387490;
  metafield.namespace = "my_fields";
  metafield.key = "category";
  metafield.type = "single_line_text_field";
  metafield.value = "outdoors";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.article_id = 674387490
  metafield.namespace = "my_fields"
  metafield.key = "category"
  metafield.type = "single_line_text_field"
  metafield.value = "outdoors"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.article_id = 674387490;
  metafield.namespace = "my_fields";
  metafield.key = "category";
  metafield.type = "single_line_text_field";
  metafield.value = "outdoors";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228951,"namespace":"my_fields","key":"category","value":"outdoors","description":null,"owner_id":674387490,"created_at":"2025-07-01T14:29:32-04:00","updated_at":"2025-07-01T14:29:32-04:00","owner_resource":"article","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228951"}}

• Create a metafield for an order

  curl -d '{"metafield":{"namespace":"my_fields","key":"purchase_order","type":"single_line_text_field","value":"123"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.order_id = 450789469;
  metafield.namespace = "my_fields";
  metafield.key = "purchase_order";
  metafield.type = "single_line_text_field";
  metafield.value = "123";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.order_id = 450789469
  metafield.namespace = "my_fields"
  metafield.key = "purchase_order"
  metafield.type = "single_line_text_field"
  metafield.value = "123"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.order_id = 450789469;
  metafield.namespace = "my_fields";
  metafield.key = "purchase_order";
  metafield.type = "single_line_text_field";
  metafield.value = "123";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228942,"namespace":"my_fields","key":"purchase_order","value":"123","description":null,"owner_id":450789469,"created_at":"2025-07-01T14:28:53-04:00","updated_at":"2025-07-01T14:28:53-04:00","owner_resource":"order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228942"}}

• Create a metafield for the Shop resource

  curl -d '{"metafield":{"namespace":"my_fields","key":"my_items","value":"{\"items\":[\"some item\"]}","type":"json"}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.namespace = "my_fields";
  metafield.key = "my_items";
  metafield.value = "{\"items\":[\"some item\"]}";
  metafield.type = "json";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.namespace = "my_fields"
  metafield.key = "my_items"
  metafield.value = "{\"items\":[\"some item\"]}"
  metafield.type = "json"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.namespace = "my_fields";
  metafield.key = "my_items";
  metafield.value = "{\"items\":[\"some item\"]}";
  metafield.type = "json";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 201 Created{"metafield":{"id":1069228945,"namespace":"my_fields","key":"my_items","value":"{\"items\":[\"some item\"]}","description":null,"owner_id":548380009,"created_at":"2025-07-01T14:29:03-04:00","updated_at":"2025-07-01T14:29:03-04:00","owner_resource":"shop","type":"json","admin_graphql_api_id":"gid://shopify/Metafield/1069228945"}}

• Creating a metafield without a key will fail and return an error

  curl -d '{"metafield":{"key":null}}' \
  -X POST "https://your-development-store.myshopify.com/admin/api/2024-10/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.key = null;
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.key = nil
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.key = null;
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 422 Unprocessable Entity{"errors":{"type":["can't be blank"],"namespace":["can't be blank","is too short (minimum is 3 characters)"],"key":["can't be blank","is too short (minimum is 2 characters)"]}}

examples

• Retrieve metafields attached to a Blog

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    blog_id: 382285388,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    blog_id: 382285388,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    blog_id: 382285388,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":1069228940,"namespace":"my_fields","key":"sponsor","value":"Shopify","description":null,"owner_id":382285388,"created_at":"2025-07-01T14:28:43-04:00","updated_at":"2025-07-01T14:28:43-04:00","owner_resource":"blog","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228940"}]}

• Retrieve metafields attached to a Collection

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    collection_id: 482865238,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    collection_id: 482865238,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    collection_id: 482865238,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":519046726,"namespace":"notes","key":"descriptionription","value":"Collection description","description":"Custom Collection notes","owner_id":482865238,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"collection","type":"multi_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/519046726"},{"id":624849518,"namespace":"global","key":"description_tag","value":"Some seo description value","description":null,"owner_id":482865238,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"collection","type":"multi_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/624849518"},{"id":1010236510,"namespace":"global","key":"title_tag","value":"Some seo title value","description":null,"owner_id":482865238,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"collection","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1010236510"},{"id":1069228953,"namespace":"my_fields","key":"discount","value":"25%","description":null,"owner_id":482865238,"created_at":"2025-07-01T14:29:36-04:00","updated_at":"2025-07-01T14:29:36-04:00","owner_resource":"collection","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228953"}]}

• Retrieve metafields attached to a Customer

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    customer_id: 207119551,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    customer_id: 207119551,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    customer_id: 207119551,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":220591908,"namespace":"discounts","key":"returning_customer","value":"no","description":"Customer deserves discount","owner_id":207119551,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"customer","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/220591908"},{"id":1069228937,"namespace":"discounts","key":"special","value":"yes","description":null,"owner_id":207119551,"created_at":"2025-07-01T14:28:35-04:00","updated_at":"2025-07-01T14:28:35-04:00","owner_resource":"customer","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228937"}]}

• Retrieve metafields attached to a Draft Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    draft_order_id: 622762746,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    draft_order_id: 622762746,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    draft_order_id: 622762746,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":106172460,"namespace":"notes","key":"note","value":"B flat","description":"This is for notes","owner_id":622762746,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"draft_order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/106172460"},{"id":1069228955,"namespace":"my_fields","key":"purchase_order","value":"97453","description":null,"owner_id":622762746,"created_at":"2025-07-01T14:29:41-04:00","updated_at":"2025-07-01T14:29:41-04:00","owner_resource":"draft_order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228955"}]}

• Retrieve metafields attached to a Page

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    page_id: 131092082,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    page_id: 131092082,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    page_id: 131092082,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":290519330,"namespace":"translation","key":"title_fr","value":"Le TOS","description":"Page French title translation","owner_id":131092082,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"page","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/290519330"},{"id":1069228949,"namespace":"my_fields","key":"subtitle","value":"A subtitle for my page","description":null,"owner_id":131092082,"created_at":"2025-07-01T14:29:22-04:00","updated_at":"2025-07-01T14:29:22-04:00","owner_resource":"page","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228949"}]}

• Retrieve metafields attached to a Product

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    product_id: 632910392,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    product_id: 632910392,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    product_id: 632910392,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":51714266,"namespace":"my_namespace","key":"my_key","value":"Hello","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/51714266"},{"id":116539875,"namespace":"descriptors","key":"subtitle","value":"The best ipod","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/116539875"},{"id":263497237,"namespace":"installments","key":"disable","value":true,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"boolean","admin_graphql_api_id":"gid://shopify/Metafield/263497237"},{"id":273160493,"namespace":"facts","key":"isbn","value":"978-0-14-004259-7","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/273160493"},{"id":524118066,"namespace":"facts","key":"ean","value":"0123456789012","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/524118066"},{"id":543636738,"namespace":"reviews","key":"rating_count","value":1,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"number_integer","admin_graphql_api_id":"gid://shopify/Metafield/543636738"},{"id":572384404,"namespace":"reviews","key":"rating","value":"{\"value\": \"3.5\", \"scale_min\": \"1.0\", \"scale_max\": \"5.0\"}","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"rating","admin_graphql_api_id":"gid://shopify/Metafield/572384404"},{"id":613330208,"namespace":"shopify_filter","key":"display","value":"retina","description":"This field keeps track of the type of display","owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/613330208"},{"id":779326701,"namespace":"facts","key":"upc","value":"012345678901","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/779326701"},{"id":845366454,"namespace":"translations","key":"title_fr","value":"produit","description":"French product title","owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/845366454"},{"id":861799889,"namespace":"my_other_fields","key":"organic","value":true,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"boolean","admin_graphql_api_id":"gid://shopify/Metafield/861799889"},{"id":870326793,"namespace":"descriptors","key":"care_guide","value":"Wash in cold water","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":null,"admin_graphql_api_id":"gid://shopify/Metafield/870326793"},{"id":908250163,"namespace":"my_other_fields","key":"shipping_policy","value":"Ships for free in Canada","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"multi_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/908250163"},{"id":925288667,"namespace":"my_other_fields","key":"year_released","value":2019,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"number_integer","admin_graphql_api_id":"gid://shopify/Metafield/925288667"},{"id":1001077698,"namespace":"my_fields","key":"best_for","value":"travel","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1001077698"},{"id":1029402048,"namespace":"my_other_fields","key":"ingredients","value":"[\"apple\", \"music\", \"u2\"]","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"list.single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1029402048"},{"id":1069228935,"namespace":"inventory","key":"warehouse","value":25,"description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:31-04:00","updated_at":"2025-07-01T14:28:31-04:00","owner_resource":"product","type":"number_integer","admin_graphql_api_id":"gid://shopify/Metafield/1069228935"}]}

• Retrieve metafields attached to a Product Image

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    product_image_id: 850703190,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    product_image_id: 850703190,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    product_image_id: 850703190,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":625663657,"namespace":"translation","key":"title_fr","value":"tbn","description":"French product image title","owner_id":498048120,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"media_image","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/625663657"},{"id":1069228956,"namespace":"translation","key":"title_spanish","value":"botas","description":null,"owner_id":498048120,"created_at":"2025-07-01T14:29:43-04:00","updated_at":"2025-07-01T14:29:43-04:00","owner_resource":"media_image","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228956"}]}

• Retrieve metafields attached to a Product Variant

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    variant_id: 49148385,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    variant_id: 49148385,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    variant_id: 49148385,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":1069228939,"namespace":"my_fields","key":"liner_material","value":"synthetic leather","description":null,"owner_id":49148385,"created_at":"2025-07-01T14:28:39-04:00","updated_at":"2025-07-01T14:28:39-04:00","owner_resource":"variant","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228939"}]}

• Retrieve metafields attached to an Article

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    article_id: 674387490,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    article_id: 674387490,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    article_id: 674387490,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":1069228957,"namespace":"my_fields","key":"category","value":"outdoors","description":null,"owner_id":674387490,"created_at":"2025-07-01T14:29:46-04:00","updated_at":"2025-07-01T14:29:46-04:00","owner_resource":"article","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228957"}]}

• Retrieve metafields attached to an Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    order_id: 450789469,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    order_id: 450789469,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    order_id: 450789469,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":915396079,"namespace":"notes","key":"buyer","value":"Notes about this buyer","description":"This field is for buyer notes","owner_id":450789469,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/915396079"},{"id":1069228948,"namespace":"my_fields","key":"purchase_order","value":"123","description":null,"owner_id":450789469,"created_at":"2025-07-01T14:29:21-04:00","updated_at":"2025-07-01T14:29:21-04:00","owner_resource":"order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1069228948"}]}

• Retrieve metafields attached to the Shop

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/metafields.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":721389482,"namespace":"affiliates","key":"app_key","value":"app_key","description":null,"owner_id":548380009,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"shop","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/721389482"}]}

• Retrieve metafields attached to the Shop after the specified ID

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/metafields.json?since_id=721389482" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.all({
    session: session,
    since_id: "721389482",
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.all(
    session: test_session,
    since_id: "721389482",
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.all({
    session: session,
    since_id: "721389482",
  });

  response

  HTTP/1.1 200 OK{"metafields":[{"id":1069228950,"namespace":"my_fields","key":"my_items","value":"{\"items\":[\"some item\"]}","description":null,"owner_id":548380009,"created_at":"2025-07-01T14:29:23-04:00","updated_at":"2025-07-01T14:29:23-04:00","owner_resource":"shop","type":"json","admin_graphql_api_id":"gid://shopify/Metafield/1069228950"}]}

examples

• Retrieve a single metafield by its ID attached to a Blog

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields/534526895.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    blog_id: 382285388,
    id: 534526895,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    blog_id: 382285388,
    id: 534526895,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    blog_id: 382285388,
    id: 534526895,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":534526895,"namespace":"translation","key":"title_fr","value":"Le iPod","description":"Blog French title translation","owner_id":241253187,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"blog","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/534526895"}}

• Retrieve a single metafield by its ID attached to a Collection

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields/1010236510.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    collection_id: 482865238,
    id: 1010236510,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    collection_id: 482865238,
    id: 1010236510,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    collection_id: 482865238,
    id: 1010236510,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":1010236510,"namespace":"global","key":"title_tag","value":"Some seo title value","description":null,"owner_id":482865238,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"collection","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1010236510"}}

• Retrieve a single metafield by its ID attached to a Customer

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields/220591908.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    customer_id: 207119551,
    id: 220591908,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    customer_id: 207119551,
    id: 220591908,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    customer_id: 207119551,
    id: 220591908,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":220591908,"namespace":"discounts","key":"returning_customer","value":"no","description":"Customer deserves discount","owner_id":207119551,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"customer","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/220591908"}}

• Retrieve a single metafield by its ID attached to a Draft Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields/106172460.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    draft_order_id: 622762746,
    id: 106172460,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    draft_order_id: 622762746,
    id: 106172460,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    draft_order_id: 622762746,
    id: 106172460,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":106172460,"namespace":"notes","key":"note","value":"B flat","description":"This is for notes","owner_id":622762746,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"draft_order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/106172460"}}

• Retrieve a single metafield by its ID attached to a Page

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields/290519330.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    page_id: 131092082,
    id: 290519330,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    page_id: 131092082,
    id: 290519330,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    page_id: 131092082,
    id: 290519330,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":290519330,"namespace":"translation","key":"title_fr","value":"Le TOS","description":"Page French title translation","owner_id":131092082,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"page","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/290519330"}}

• Retrieve a single metafield by its ID attached to a Product

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields/1001077698.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    product_id: 632910392,
    id: 1001077698,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    product_id: 632910392,
    id: 1001077698,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    product_id: 632910392,
    id: 1001077698,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":1001077698,"namespace":"my_fields","key":"best_for","value":"travel","description":null,"owner_id":632910392,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1001077698"}}

• Retrieve a single metafield by its ID attached to a Product Image

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields/625663657.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    product_image_id: 850703190,
    id: 625663657,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    product_image_id: 850703190,
    id: 625663657,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    product_image_id: 850703190,
    id: 625663657,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":625663657,"namespace":"translation","key":"title_fr","value":"tbn","description":"French product image title","owner_id":498048120,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"media_image","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/625663657"}}

• Retrieve a single metafield by its ID attached to a Product Variant

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields/323119633.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    variant_id: 49148385,
    id: 323119633,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    variant_id: 49148385,
    id: 323119633,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    variant_id: 49148385,
    id: 323119633,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":323119633,"namespace":"my_fields","key":"color","value":"Pink","description":null,"owner_id":808950810,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"variant","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/323119633"}}

• Retrieve a single metafield by its ID attached to an Article

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields/838981074.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    article_id: 674387490,
    id: 838981074,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    article_id: 674387490,
    id: 838981074,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    article_id: 674387490,
    id: 838981074,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":838981074,"namespace":"translation","key":"title_fr","value":"Le Article","description":"Article French title translation","owner_id":134645308,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"article","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/838981074"}}

• Retrieve a single metafield by its ID attached to an Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields/915396079.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    order_id: 450789469,
    id: 915396079,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    order_id: 450789469,
    id: 915396079,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    order_id: 450789469,
    id: 915396079,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":915396079,"namespace":"notes","key":"buyer","value":"Notes about this buyer","description":"This field is for buyer notes","owner_id":450789469,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/915396079"}}

• Retrieve a single metafield by its ID attached to the Shop resource

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/metafields/721389482.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.find({
    session: session,
    id: 721389482,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.find(
    session: test_session,
    id: 721389482,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.find({
    session: session,
    id: 721389482,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"id":721389482,"namespace":"affiliates","key":"app_key","value":"app_key","description":null,"owner_id":548380009,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:21-04:00","owner_resource":"shop","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/721389482"}}

examples

• Retrieve a count of metafields attached to a Blog

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    blog_id: 382285388,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    blog_id: 382285388,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    blog_id: 382285388,
  });

  response

  HTTP/1.1 200 OK{"count":0}

• Retrieve a count of metafields attached to a Collection

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    collection_id: 482865238,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    collection_id: 482865238,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    collection_id: 482865238,
  });

  response

  HTTP/1.1 200 OK{"count":3}

• Retrieve a count of metafields attached to a Customer

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    customer_id: 207119551,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    customer_id: 207119551,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    customer_id: 207119551,
  });

  response

  HTTP/1.1 200 OK{"count":1}

• Retrieve a count of metafields attached to a Draft Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    draft_order_id: 622762746,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    draft_order_id: 622762746,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    draft_order_id: 622762746,
  });

  response

  HTTP/1.1 200 OK{"count":1}

• Retrieve a count of metafields attached to a Page

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    page_id: 131092082,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    page_id: 131092082,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    page_id: 131092082,
  });

  response

  HTTP/1.1 200 OK{"count":1}

• Retrieve a count of metafields attached to a Product

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    product_id: 632910392,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    product_id: 632910392,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    product_id: 632910392,
  });

  response

  HTTP/1.1 200 OK{"count":16}

• Retrieve a count of metafields attached to a Product Image

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    product_image_id: 850703190,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    product_image_id: 850703190,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    product_image_id: 850703190,
  });

  response

  HTTP/1.1 200 OK{"count":1}

• Retrieve a count of metafields attached to a Product Variant

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    variant_id: 49148385,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    variant_id: 49148385,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    variant_id: 49148385,
  });

  response

  HTTP/1.1 200 OK{"count":0}

• Retrieve a count of metafields attached to an Article

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    article_id: 674387490,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    article_id: 674387490,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    article_id: 674387490,
  });

  response

  HTTP/1.1 200 OK{"count":0}

• Retrieve a count of metafields attached to an Order

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
    order_id: 450789469,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
    order_id: 450789469,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
    order_id: 450789469,
  });

  response

  HTTP/1.1 200 OK{"count":1}

• Retrieve a count of metafields attached to the Shop resource

  curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/metafields/count.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.count({
    session: session,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.count(
    session: test_session,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.count({
    session: session,
  });

  response

  HTTP/1.1 200 OK{"count":1}

examples

• Update a metafield for a Blog

  curl -d '{"metafield":{"id":534526895,"value":"a translated blog title","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields/534526895.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.blog_id = 382285388;
  metafield.id = 534526895;
  metafield.value = "a translated blog title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.blog_id = 382285388
  metafield.id = 534526895
  metafield.value = "a translated blog title"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.blog_id = 382285388;
  metafield.id = 534526895;
  metafield.value = "a translated blog title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"a translated blog title","owner_id":241253187,"namespace":"translation","key":"title_fr","id":534526895,"description":"Blog French title translation","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:39-04:00","owner_resource":"blog","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/534526895"}}

• Update a metafield for a Collection

  curl -d '{"metafield":{"id":1010236510,"value":"seo title","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields/1010236510.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.collection_id = 482865238;
  metafield.id = 1010236510;
  metafield.value = "seo title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.collection_id = 482865238
  metafield.id = 1010236510
  metafield.value = "seo title"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.collection_id = 482865238;
  metafield.id = 1010236510;
  metafield.value = "seo title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"seo title","owner_id":482865238,"namespace":"global","key":"title_tag","id":1010236510,"description":null,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:29:36-04:00","owner_resource":"collection","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1010236510"}}

• Update a metafield for a Customer

  curl -d '{"metafield":{"id":220591908,"value":"yes","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields/220591908.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.customer_id = 207119551;
  metafield.id = 220591908;
  metafield.value = "yes";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.customer_id = 207119551
  metafield.id = 220591908
  metafield.value = "yes"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.customer_id = 207119551;
  metafield.id = 220591908;
  metafield.value = "yes";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"yes","owner_id":207119551,"namespace":"discounts","key":"returning_customer","id":220591908,"description":"Customer deserves discount","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:29:28-04:00","owner_resource":"customer","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/220591908"}}

• Update a metafield for a Draft Order

  curl -d '{"metafield":{"id":106172460,"value":"110000","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields/106172460.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.draft_order_id = 622762746;
  metafield.id = 106172460;
  metafield.value = "110000";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.draft_order_id = 622762746
  metafield.id = 106172460
  metafield.value = "110000"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.draft_order_id = 622762746;
  metafield.id = 106172460;
  metafield.value = "110000";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"110000","owner_id":622762746,"namespace":"notes","key":"note","id":106172460,"description":"This is for notes","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:29:30-04:00","owner_resource":"draft_order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/106172460"}}

• Update a metafield for a Page

  curl -d '{"metafield":{"id":290519330,"value":"An updated translation","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields/290519330.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.page_id = 131092082;
  metafield.id = 290519330;
  metafield.value = "An updated translation";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.page_id = 131092082
  metafield.id = 290519330
  metafield.value = "An updated translation"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.page_id = 131092082;
  metafield.id = 290519330;
  metafield.value = "An updated translation";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"An updated translation","owner_id":131092082,"namespace":"translation","key":"title_fr","id":290519330,"description":"Page French title translation","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:29:20-04:00","owner_resource":"page","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/290519330"}}

• Update a metafield for a Product

  curl -d '{"metafield":{"id":1001077698,"value":"having fun","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields/1001077698.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.product_id = 632910392;
  metafield.id = 1001077698;
  metafield.value = "having fun";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.product_id = 632910392
  metafield.id = 1001077698
  metafield.value = "having fun"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.product_id = 632910392;
  metafield.id = 1001077698;
  metafield.value = "having fun";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"having fun","owner_id":632910392,"namespace":"my_fields","key":"best_for","id":1001077698,"description":null,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:29:19-04:00","owner_resource":"product","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/1001077698"}}

• Update a metafield for a Product Image

  curl -d '{"metafield":{"id":625663657,"value":"translated description","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields/625663657.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.product_image_id = 850703190;
  metafield.id = 625663657;
  metafield.value = "translated description";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.product_image_id = 850703190
  metafield.id = 625663657
  metafield.value = "translated description"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.product_image_id = 850703190;
  metafield.id = 625663657;
  metafield.value = "translated description";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"translated description","owner_id":498048120,"namespace":"translation","key":"title_fr","id":625663657,"description":"French product image title","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:41-04:00","owner_resource":"media_image","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/625663657"}}

• Update a metafield for a Product Variant

  curl -d '{"metafield":{"id":323119633,"value":"Red","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields/323119633.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.variant_id = 49148385;
  metafield.id = 323119633;
  metafield.value = "Red";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.variant_id = 49148385
  metafield.id = 323119633
  metafield.value = "Red"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.variant_id = 49148385;
  metafield.id = 323119633;
  metafield.value = "Red";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"Red","owner_id":808950810,"namespace":"my_fields","key":"color","id":323119633,"description":null,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:55-04:00","owner_resource":"variant","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/323119633"}}

• Update a metafield for a Shop resource

  curl -d '{"metafield":{"id":721389482,"value":"[\"something new\"]","type":"list.single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/metafields/721389482.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.id = 721389482;
  metafield.value = "[\"something new\"]";
  metafield.type = "list.single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.id = 721389482
  metafield.value = "[\"something new\"]"
  metafield.type = "list.single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.id = 721389482;
  metafield.value = "[\"something new\"]";
  metafield.type = "list.single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"[\"something new\"]","owner_id":548380009,"namespace":"affiliates","key":"app_key","id":721389482,"description":null,"created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:59-04:00","owner_resource":"shop","type":"list.single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/721389482"}}

• Update a metafield for an Article

  curl -d '{"metafield":{"id":838981074,"value":"a translated title","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields/838981074.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.article_id = 674387490;
  metafield.id = 838981074;
  metafield.value = "a translated title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.article_id = 674387490
  metafield.id = 838981074
  metafield.value = "a translated title"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.article_id = 674387490;
  metafield.id = 838981074;
  metafield.value = "a translated title";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"a translated title","owner_id":134645308,"namespace":"translation","key":"title_fr","id":838981074,"description":"Article French title translation","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:42-04:00","owner_resource":"article","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/838981074"}}

• Update a metafield for an Order

  curl -d '{"metafield":{"id":915396079,"value":"Provided a discount code","type":"single_line_text_field"}}' \
  -X PUT "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields/915396079.json" \
  -H "X-Shopify-Access-Token: {access_token}" \
  -H "Content-Type: application/json"
  

  const { admin, session } = await authenticate.admin(request);
  
  const metafield = new admin.rest.resources.Metafield({session: session});
  
  metafield.order_id = 450789469;
  metafield.id = 915396079;
  metafield.value = "Provided a discount code";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  metafield = ShopifyAPI::Metafield.new(session: test_session)
  metafield.order_id = 450789469
  metafield.id = 915396079
  metafield.value = "Provided a discount code"
  metafield.type = "single_line_text_field"
  metafield.save!

  // Session is built by the OAuth process
  
  const metafield = new shopify.rest.Metafield({session: session});
  metafield.order_id = 450789469;
  metafield.id = 915396079;
  metafield.value = "Provided a discount code";
  metafield.type = "single_line_text_field";
  await metafield.save({
    update: true,
  });

  response

  HTTP/1.1 200 OK{"metafield":{"value":"Provided a discount code","owner_id":450789469,"namespace":"notes","key":"buyer","id":915396079,"description":"This field is for buyer notes","created_at":"2025-07-01T14:28:21-04:00","updated_at":"2025-07-01T14:28:56-04:00","owner_resource":"order","type":"single_line_text_field","admin_graphql_api_id":"gid://shopify/Metafield/915396079"}}

examples

• Delete a metafield by its ID for a Blog

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/blogs/382285388/metafields/534526895.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    blog_id: 382285388,
    id: 534526895,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    blog_id: 382285388,
    id: 534526895,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    blog_id: 382285388,
    id: 534526895,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Collection

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/collections/482865238/metafields/1010236510.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    collection_id: 482865238,
    id: 1010236510,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    collection_id: 482865238,
    id: 1010236510,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    collection_id: 482865238,
    id: 1010236510,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Customer

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/customers/207119551/metafields/220591908.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    customer_id: 207119551,
    id: 220591908,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    customer_id: 207119551,
    id: 220591908,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    customer_id: 207119551,
    id: 220591908,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Draft Order

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/draft_orders/622762746/metafields/106172460.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    draft_order_id: 622762746,
    id: 106172460,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    draft_order_id: 622762746,
    id: 106172460,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    draft_order_id: 622762746,
    id: 106172460,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Page

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/pages/131092082/metafields/290519330.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    page_id: 131092082,
    id: 290519330,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    page_id: 131092082,
    id: 290519330,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    page_id: 131092082,
    id: 290519330,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Product

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/products/632910392/metafields/1001077698.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    product_id: 632910392,
    id: 1001077698,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    product_id: 632910392,
    id: 1001077698,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    product_id: 632910392,
    id: 1001077698,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Product Image

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/product_images/850703190/metafields/625663657.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    product_image_id: 850703190,
    id: 625663657,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    product_image_id: 850703190,
    id: 625663657,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    product_image_id: 850703190,
    id: 625663657,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for a Product Variant

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/variants/49148385/metafields/323119633.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    variant_id: 49148385,
    id: 323119633,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    variant_id: 49148385,
    id: 323119633,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    variant_id: 49148385,
    id: 323119633,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for an Article

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/articles/674387490/metafields/838981074.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    article_id: 674387490,
    id: 838981074,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    article_id: 674387490,
    id: 838981074,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    article_id: 674387490,
    id: 838981074,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for an Order

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/orders/450789469/metafields/915396079.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    order_id: 450789469,
    id: 915396079,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    order_id: 450789469,
    id: 915396079,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    order_id: 450789469,
    id: 915396079,
  });

  response

  HTTP/1.1 200 OK{}

• Delete a metafield by its ID for the Shop resource

  curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2024-10/metafields/721389482.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  

  await admin.rest.resources.Metafield.delete({
    session: session,
    id: 721389482,
  });

  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session
  
  ShopifyAPI::Metafield.delete(
    session: test_session,
    id: 721389482,
  )

  // Session is built by the OAuth process
  
  await shopify.rest.Metafield.delete({
    session: session,
    id: 721389482,
  });

  response

  HTTP/1.1 200 OK{}