customerMerge - admin-graphql - MUTATION

Version: 2024-10

Description:

Merges two customers.

Access Scopes

`write_customer_merge` access scope.

Arguments

• customerOneId: ID! - The ID of the first customer that will be merged.
• customerTwoId: ID! - The ID of the second customer that will be merged.
• overrideFields: CustomerMergeOverrideFields - The fields to override the default customer merge rules.

Returns

• job: Job The asynchronous job for merging the customers.
• resultingCustomerId: ID The ID of the customer resulting from the merge.
• userErrors: CustomerMergeUserError! The list of errors that occurred from executing the mutation.

Examples

• Merge customers with override fields

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CustomerMerge { customerMerge(customerOneId: \\\"gid://shopify/Customer/544365967\\\", customerTwoId: \\\"gid://shopify/Customer/624407574\\\", overrideFields: {customerIdOfFirstNameToKeep: \\\"gid://shopify/Customer/544365967\\\", customerIdOfLastNameToKeep: \\\"gid://shopify/Customer/624407574\\\"}) { resultingCustomerId job { id done } userErrors { code field message } } }\",\n \"variables\": {\n    \"customerOneId\": \"gid://shopify/Customer/544365967\",\n    \"customerTwoId\": \"gid://shopify/Customer/624407574\",\n    \"overrideFields\": {\n      \"customerIdOfFirstNameToKeep\": \"gid://shopify/Customer/544365967\",\n      \"customerIdOfLastNameToKeep\": \"gid://shopify/Customer/544365967\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CustomerMerge {\n      customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\", overrideFields: {customerIdOfFirstNameToKeep: \"gid://shopify/Customer/544365967\", customerIdOfLastNameToKeep: \"gid://shopify/Customer/624407574\"}) {\n        resultingCustomerId\n        job {\n          id\n          done\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerOneId\": \"gid://shopify/Customer/544365967\",\n      \"customerTwoId\": \"gid://shopify/Customer/624407574\",\n      \"overrideFields\": {\n        \"customerIdOfFirstNameToKeep\": \"gid://shopify/Customer/544365967\",\n        \"customerIdOfLastNameToKeep\": \"gid://shopify/Customer/544365967\"\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 CustomerMerge {\n    customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\", overrideFields: {customerIdOfFirstNameToKeep: \"gid://shopify/Customer/544365967\", customerIdOfLastNameToKeep: \"gid://shopify/Customer/624407574\"}) {\n      resultingCustomerId\n      job {\n        id\n        done\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"customerOneId\": \"gid://shopify/Customer/544365967\",\n  \"customerTwoId\": \"gid://shopify/Customer/624407574\",\n  \"overrideFields\": {\n    \"customerIdOfFirstNameToKeep\": \"gid://shopify/Customer/544365967\",\n    \"customerIdOfLastNameToKeep\": \"gid://shopify/Customer/544365967\"\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 = << \"gid://shopify/Customer/544365967\",\n  \"customerTwoId\" => \"gid://shopify/Customer/624407574\",\n  \"overrideFields\" => [\n    \"customerIdOfFirstNameToKeep\" => \"gid://shopify/Customer/544365967\",\n    \"customerIdOfLastNameToKeep\" => \"gid://shopify/Customer/544365967\",\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 CustomerMerge {\n    customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\", overrideFields: {customerIdOfFirstNameToKeep: \"gid://shopify/Customer/544365967\", customerIdOfLastNameToKeep: \"gid://shopify/Customer/624407574\"}) {\n      resultingCustomerId\n      job {\n        id\n        done\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"customerOneId\": \"gid://shopify/Customer/544365967\",\n      \"customerTwoId\": \"gid://shopify/Customer/624407574\",\n      \"overrideFields\": {\n        \"customerIdOfFirstNameToKeep\": \"gid://shopify/Customer/544365967\",\n        \"customerIdOfLastNameToKeep\": \"gid://shopify/Customer/544365967\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CustomerMerge {\n  customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\", overrideFields: {customerIdOfFirstNameToKeep: \"gid://shopify/Customer/544365967\", customerIdOfLastNameToKeep: \"gid://shopify/Customer/624407574\"}) {\n    resultingCustomerId\n    job {\n      id\n      done\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "customerOneId": "gid://shopify/Customer/544365967",
    "customerTwoId": "gid://shopify/Customer/624407574",
    "overrideFields": {
      "customerIdOfFirstNameToKeep": "gid://shopify/Customer/544365967",
      "customerIdOfLastNameToKeep": "gid://shopify/Customer/544365967"
    }
  }

  response: {
    "data": {
      "customerMerge": {
        "resultingCustomerId": "gid://shopify/Customer/624407574",
        "job": {
          "id": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",
          "done": true
        },
        "userErrors": []
      }
    }
  }

  Merge two customers

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CustomerMerge { customerMerge(customerOneId: \\\"gid://shopify/Customer/544365967\\\", customerTwoId: \\\"gid://shopify/Customer/624407574\\\") { resultingCustomerId job { id done } userErrors { code field message } } }\",\n \"variables\": {\n    \"customerOneId\": \"gid://shopify/Customer/544365967\",\n    \"customerTwoId\": \"gid://shopify/Customer/624407574\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CustomerMerge {\n      customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\") {\n        resultingCustomerId\n        job {\n          id\n          done\n        }\n        userErrors {\n          code\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerOneId\": \"gid://shopify/Customer/544365967\",\n      \"customerTwoId\": \"gid://shopify/Customer/624407574\"\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 CustomerMerge {\n    customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\") {\n      resultingCustomerId\n      job {\n        id\n        done\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"customerOneId\": \"gid://shopify/Customer/544365967\",\n  \"customerTwoId\": \"gid://shopify/Customer/624407574\"\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 = << \"gid://shopify/Customer/544365967\",\n  \"customerTwoId\" => \"gid://shopify/Customer/624407574\",\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 CustomerMerge {\n    customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\") {\n      resultingCustomerId\n      job {\n        id\n        done\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"customerOneId\": \"gid://shopify/Customer/544365967\",\n      \"customerTwoId\": \"gid://shopify/Customer/624407574\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CustomerMerge {\n  customerMerge(customerOneId: \"gid://shopify/Customer/544365967\", customerTwoId: \"gid://shopify/Customer/624407574\") {\n    resultingCustomerId\n    job {\n      id\n      done\n    }\n    userErrors {\n      code\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "customerOneId": "gid://shopify/Customer/544365967",
    "customerTwoId": "gid://shopify/Customer/624407574"
  }

  response: {
    "data": {
      "customerMerge": {
        "resultingCustomerId": "gid://shopify/Customer/624407574",
        "job": {
          "id": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",
          "done": true
        },
        "userErrors": []
      }
    }
  }