Skip to main content

SuggestedExternalAttributeMapping

A proposed pairing of an EC attribute definition with an external schema field, based on name similarity. Suggestions are not persisted until the user saves them.

type SuggestedExternalAttributeMapping {
  externalIdentifier: String!
  externalName: String
  productAttributeDefinitionId: ID
  sourceType: String!
  standardAttribute: String
}

Fields​

SuggestedExternalAttributeMapping.externalIdentifier ● String! non-null scalar common​

The external schema field's canonical identifier — the value to map against.

SuggestedExternalAttributeMapping.externalName ● String scalar common​

The external schema field's human-readable label, if known.

SuggestedExternalAttributeMapping.productAttributeDefinitionId ● ID scalar common​

ID of the EC attribute definition that would be mapped.

SuggestedExternalAttributeMapping.sourceType ● String! non-null scalar common​

Always 'custom' — suggestions pair an EC attribute definition with an external field.

SuggestedExternalAttributeMapping.standardAttribute ● String scalar common​

Always null for suggestions, which are anchored to a product attribute definition.

Returned By​

suggestExternalAttributeMappings query