Skip to main content

ExternalAttributeField

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

type ExternalAttributeField {
  identifier: String!
  key: String
  name: String
  namespace: String
  type: String
}

Fields​

ExternalAttributeField.identifier ● String! non-null scalar common​

The integration's canonical identifier for the field — the value to map against (e.g. a Shopify metafield 'namespace.key'). Universal across integrations.

ExternalAttributeField.key ● String scalar common​

Integration-specific key within the namespace, when applicable.

ExternalAttributeField.name ● String scalar common​

The field's human-readable label on the external platform.

ExternalAttributeField.namespace ● String scalar common​

Integration-specific grouping, when applicable (e.g. a Shopify metafield namespace).

ExternalAttributeField.type ● String scalar common​

The external platform's value type for the field (e.g. single_line_text_field), when applicable.

Returned By​

externalAttributeCatalog query