Anchor to section titled 'undefined'customer
customer
query
2024-10latest
Requires read access scope.
Returns the status of a customer merge request job.
Anchor to section titled 'Arguments'
Arguments
The ID of the job performing the customer merge request.
Was this section helpful?
Anchor to section titled 'CustomerMergeRequest possible returns'
CustomerMergeRequest possible returns
A merge request for merging two customers.
Was this section helpful?
Code examples for QUERY: customerMergeJobStatus
Query Reference for QUERY: customerMergeJobStatus
"{\n customerMergeJobStatus(jobId) {\n # CustomerMergeRequest fields\n }\n}"Input Reference for QUERY: customerMergeJobStatus
Schema Reference for QUERY: customerMergeJobStatus
Display Examples for QUERY: customerMergeJobStatus
[
{
"example": {
"type_name": "customermergejobstatus",
"title": "Get the merge status of a customer merge request",
"description": "Retrieve the merge status of a customer merge request.\n",
"query_string": "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}",
"query_arguments": {
"jobId": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59"
},
"response": {
"data": {
"customerMergeJobStatus": {
"jobId": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",
"status": "IN_PROGRESS",
"resultingCustomerId": "gid://shopify/Customer/544365967",
"customerMergeErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/customers/test/unit/graph_api/admin/resolvers/customer_merge_job_status_test.rb",
"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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "arguments",
"inputVariableEntries": [
{
"arg": {
"name": "jobId",
"description": "The ID of the job performing the customer merge request.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null
},
"key": "jobId",
"argValue": " \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\"",
"typeKind": "QUERY"
}
]
}
]