customerMergeJobStatus

query

Requires read_customer_merge access scope.

Returns the status of a customer merge request job.

Arguments

Anchor to jobIdjobId • ID!required: The ID of the job performing the customer merge request.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CustomerMergeRequestCustomerMergeRequest • CustomerMergeRequest: A merge request for merging two customers.

Was this section helpful?

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    customerMergeJobStatus(jobId: "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59") {
7      jobId
8      status
9      resultingCustomerId
10      customerMergeErrors {
11        errorFields
12        message
13      }
14    }
15  }`,
16);
17
18const data = await response.json();
19

query {
  customerMergeJobStatus(jobId: "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59") {
    jobId
    status
    resultingCustomerId
    customerMergeErrors {
      errorFields
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { customerMergeJobStatus(jobId: \"gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59\") { jobId status resultingCustomerId customerMergeErrors { errorFields message } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    customerMergeJobStatus(jobId: "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59") {
      jobId
      status
      resultingCustomerId
      customerMergeErrors {
        errorFields
        message
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    customerMergeJobStatus(jobId: "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59") {
      jobId
      status
      resultingCustomerId
      customerMergeErrors {
        errorFields
        message
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    customerMergeJobStatus(jobId: "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59") {
      jobId
      status
      resultingCustomerId
      customerMergeErrors {
        errorFields
        message
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "customerMergeJobStatus": {
3    "jobId": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",
4    "status": "IN_PROGRESS",
5    "resultingCustomerId": "gid://shopify/Customer/544365967",
6    "customerMergeErrors": []
7  }
8}