Skip to main content

suggestExternalAttributeMappings

Proposed pairings of the company's unmapped attribute definitions with the integration's external schema fields, matched by name similarity. Nothing is persisted; save chosen pairs with setExternalAttributeMappings.

Business Rules​

  • The integration must support product listings.
  • Only definitions not already mapped for the integration are suggested.

Error Scenarios​

  • **LISTINGS_ENGINE_DISABLED**: the listings engine is not enabled for the company.
  • **VALIDATION**: the integration does not support product listings.

Permissions Required​

  • products:suggest_external_attribute_mappings permission.
suggestExternalAttributeMappings(
  integrationId: ID!
): [SuggestedExternalAttributeMapping!]!

Arguments​

suggestExternalAttributeMappings.integrationId ● ID! non-null scalar common​

The integration (connected store) to suggest mappings for.

Type​

SuggestedExternalAttributeMapping object listings​

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.