customerMergeJobStatus - admin-graphql - QUERY

Version: 2024-10

Description:

Returns the status of a customer merge request job.

Access Scopes

`read_customer_merge` access scope.

Arguments

• jobId: ID! - The ID of the job performing the customer merge request.

Returns

• customerMergeErrors: CustomerMergeError! The merge errors that occurred during the customer merge request.
• jobId: ID The UUID of the merge job.
• resultingCustomerId: ID! The ID of the customer resulting from the merge.
• status: CustomerMergeRequestStatus! The status of the customer merge request.

Examples

• Get the merge status of a customer merge request

          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\": \"query { customerMergeJobStatus(jobId: \\\"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\\\") { jobId status resultingCustomerId customerMergeErrors { errorFields message } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") {\n      jobId\n      status\n      resultingCustomerId\n      customerMergeErrors {\n        errorFields\n        message\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  query {\n    customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") {\n      jobId\n      status\n      resultingCustomerId\n      customerMergeErrors {\n        errorFields\n        message\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") {\n      jobId\n      status\n      resultingCustomerId\n      customerMergeErrors {\n        errorFields\n        message\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") {\n      jobId\n      status\n      resultingCustomerId\n      customerMergeErrors {\n        errorFields\n        message\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") {\n    jobId\n    status\n    resultingCustomerId\n    customerMergeErrors {\n      errorFields\n      message\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "customerMergeJobStatus": {
        "jobId": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",
        "status": "IN_PROGRESS",
        "resultingCustomerId": "gid://shopify/Customer/544365967",
        "customerMergeErrors": []
      }
    }
  }