metaobjectUpsert - admin-graphql - MUTATION

Version: 2024-04

Description:

Retrieves a metaobject by handle, then updates it with the provided input values. If no matching metaobject is found, a new metaobject is created with the provided input values.

Access Scopes

`write_metaobjects` access scope.

Arguments

• handle: MetaobjectHandleInput! - The identifier of the metaobject to upsert.
• metaobject: MetaobjectUpsertInput! - The parameters to upsert the metaobject.

Returns

• metaobject: Metaobject The created or updated metaobject.
• userErrors: MetaobjectUserError! The list of errors that occurred from executing the mutation.

Examples

• Upsert a metaobject

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) { metaobjectUpsert(handle: $handle, metaobject: $metaobject) { metaobject { handle hex: field(key: \\\"hex\\\") { value } } userErrors { field message code } } }\",\n \"variables\": {\n    \"handle\": {\n      \"type\": \"color\",\n      \"handle\": \"indigo-swatch\"\n    },\n    \"metaobject\": {\n      \"fields\": [\n        {\n          \"key\": \"hex\",\n          \"value\": \"#4B0082\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) {\n      metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n        metaobject {\n          handle\n          hex: field(key: \"hex\") {\n            value\n          }\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"handle\": {\n        \"type\": \"color\",\n        \"handle\": \"indigo-swatch\"\n      },\n      \"metaobject\": {\n        \"fields\": [\n          {\n            \"key\": \"hex\",\n            \"value\": \"#4B0082\"\n          }\n        ]\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) {\n    metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n      metaobject {\n        handle\n        hex: field(key: \"hex\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"handle\": {\n    \"type\": \"color\",\n    \"handle\": \"indigo-swatch\"\n  },\n  \"metaobject\": {\n    \"fields\": [{\"key\"=>\"hex\", \"value\"=>\"#4B0082\"}]\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) {\n    metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n      metaobject {\n        handle\n        hex: field(key: \"hex\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"handle\" => [\n    \"type\" => \"color\",\n    \"handle\" => \"indigo-swatch\",\n  ],\n  \"metaobject\" => [\n    \"fields\" => [{\"key\"=>\"hex\", \"value\"=>\"#4B0082\"}],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) {\n    metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n      metaobject {\n        handle\n        hex: field(key: \"hex\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"handle\": {\n        \"type\": \"color\",\n        \"handle\": \"indigo-swatch\"\n      },\n      \"metaobject\": {\n        \"fields\": [\n          {\n            \"key\": \"hex\",\n            \"value\": \"#4B0082\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation UpsertMetaobject($handle: MetaobjectHandleInput!, $metaobject: MetaobjectUpsertInput!) {\n  metaobjectUpsert(handle: $handle, metaobject: $metaobject) {\n    metaobject {\n      handle\n      hex: field(key: \"hex\") {\n        value\n      }\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "handle": {
      "type": "color",
      "handle": "indigo-swatch"
    },
    "metaobject": {
      "fields": [
        {
          "key": "hex",
          "value": "#4B0082"
        }
      ]
    }
  }

  response: {
    "data": {
      "metaobjectUpsert": {
        "metaobject": {
          "handle": "indigo-swatch",
          "hex": {
            "value": "#4B0082"
          }
        },
        "userErrors": []
      }
    }
  }