Skip to main content

ExternalAttributeMapping

A link between an EC product attribute definition and a field in an external platform's product attribute schema.

type ExternalAttributeMapping {
  createdAt: ISO8601DateTime!
  externalIdentifier: String!
  externalName: String
  id: ID!
  integrationId: ID!
  productAttributeDefinition: ProductAttributeDefinition
  productAttributeDefinitionId: ID
  sourceType: String!
  standardAttribute: String
  updatedAt: ISO8601DateTime!
}

Fields​

ExternalAttributeMapping.createdAt ● ISO8601DateTime! non-null scalar common​

When the mapping was created.

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

The integration's identifier for the mapped external field (e.g. a Shopify 'namespace.key').

ExternalAttributeMapping.externalName ● String scalar common​

The external field's display label, if known.

ExternalAttributeMapping.id ● ID! non-null scalar common​

Unique identifier for the mapping.

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

The integration (connected store) the mapping applies to.

ExternalAttributeMapping.productAttributeDefinition ● ProductAttributeDefinition object products​

The EC attribute definition this mapping is anchored to, when sourceType is 'custom'.

ExternalAttributeMapping.productAttributeDefinitionId ● ID scalar common​

ID of the EC attribute definition this mapping is anchored to, when sourceType is 'custom'.

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

'custom' (a product attribute definition) or 'standard' (a standard product field).

ExternalAttributeMapping.standardAttribute ● String scalar common​

The standard product field key (e.g. 'product.length'), when sourceType is 'standard'.

ExternalAttributeMapping.updatedAt ● ISO8601DateTime! non-null scalar common​

When the mapping was last updated.

Returned By​

externalAttributeMappings query