Skip to main content

setExternalAttributeMappings

Replace the full set of attribute mappings for an integration. Mappings present in the list are created or updated; previously saved mappings omitted from the list are archived.

Business Rules​

  • The integration must belong to the company and be active.
  • Every attribute definition must belong to the company.
  • At most 500 mappings can be set in one call.

Error Scenarios​

  • **LISTINGS_ENGINE_DISABLED**: the listings engine is not enabled for the company.
  • **VALIDATION**: the integration is unknown/inactive, a definition is foreign, or the 500-mapping limit is exceeded.

Permissions Required​

  • products:set_external_attribute_mappings permission.
setExternalAttributeMappings(
  input: SetExternalAttributeMappingsInput!
): SetExternalAttributeMappingsPayload

Arguments​

setExternalAttributeMappings.input ● SetExternalAttributeMappingsInput! non-null input common​

Parameters for SetExternalAttributeMappings

Type​

SetExternalAttributeMappingsPayload object common​

Autogenerated return type of SetExternalAttributeMappings.