Skip to main content

externalAttributeCatalog

The external platform's product attribute schema for an integration — the fields EC attribute definitions can be mapped to (e.g. Shopify product metafield definitions), fetched live from the external platform.

Business Rules​

  • The integration must support product listings.

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:external_attribute_catalog permission.
externalAttributeCatalog(
  integrationId: ID!
): [ExternalAttributeField!]!

Arguments​

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

The integration (connected store) to read the schema from.

Type​

ExternalAttributeField object listings​

A field in an external platform's product attribute schema (for example, a Shopify product metafield definition).