customerMergePreview - admin-graphql - QUERY

Version: 2025-01

Description:

Returns a preview of a customer merge request.

Access Scopes

`read_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

  • alternateFields: CustomerMergePreviewAlternateFields The fields that can be used to override the default fields.
  • blockingFields: CustomerMergePreviewBlockingFields The fields that will block the merge if the two customers are merged.
  • customerMergeErrors: CustomerMergeError The errors blocking the customer merge.
  • defaultFields: CustomerMergePreviewDefaultFields The fields that will be kept if the two customers are merged.
  • resultingCustomerId: ID The resulting customer ID if the two customers are merged.

Examples