Skip to main content

ExternalAttributeMappingInput

No description

input ExternalAttributeMappingInput {
  externalIdentifier: String!
  externalName: String
  productAttributeDefinitionId: ID
  sourceType: String
  standardAttribute: String
}

Fields​

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

The integration's identifier for the external field (e.g. a Shopify metafield 'namespace.key'). Opaque to the platform; each integration interprets it.

ExternalAttributeMappingInput.externalName ● String scalar common​

Optional display label for the external field.

ExternalAttributeMappingInput.productAttributeDefinitionId ● ID scalar common​

The EC attribute definition to map. Required when sourceType is 'custom'.

ExternalAttributeMappingInput.sourceType ● String scalar common​

Which kind of EC source this maps: 'custom' (a product attribute definition) or 'standard' (a standard product field from standardAttributeCatalog). Defaults to 'custom'.

ExternalAttributeMappingInput.standardAttribute ● String scalar common​

A standardAttributeCatalog key (e.g. 'product.length'). Required when sourceType is 'standard'.

Member Of​

SetExternalAttributeMappingsInput input