Choose a version:

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?

Examples

Get the merge status of a customer merge request

Description

Retrieve the merge status of a customer merge request.

Query

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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 } } }"
}'

Remix

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();

Ruby

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)

Node.js

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
      }
    }
  }`,
});

Response

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

Get the merge status of a customer merge request

Open in GraphiQL

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();

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/unstable/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

{

"customerMergeJobStatus": {

"jobId": "gid://shopify/Job/ab22429a-ea18-4dad-ac2c-5823288b1e59",

"status": "IN_PROGRESS",

"resultingCustomerId": "gid://shopify/Customer/544365967",

"customerMergeErrors": []

}