For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Custom Field Mappings

Send product metadata beyond SKU and price to Shopify or WooCommerce without custom development. Learn to set up field mappings, formulas and validation.

Ecommerce Custom Fields Mappings let you pass additional product data, beyond the standard SKU and price, to your connected sales channel when a product or variant is created or added to cart. Push configuration-specific metadata directly into Shopify products, Shopify variants or WooCommerce product custom fields without any custom development.

When a customer configures and adds a product to cart, Mimeeq normally sends the SKU code and price to your ecommerce platform. With Custom Field Mappings, you can also send:

#
Platform
Field type
What it targets

1

Shopify

Product Property

Standard Shopify product fields (vendor, barcode, tax code, etc.)

2

Shopify

Product Metafield

Custom metadata stored on the Shopify product object

3

Shopify

Variant Metafield

Custom metadata stored on a specific Shopify variant

4

WordPress/WooCommerce

Product Metafield

Additional metadata attached to a WooCommerce product

These mappings are evaluated at the time of product/variant creation, and the values are written directly to the ecommerce platform record.


Where to find field mapping settings

  1. Open any product in the Product Admin.

  2. Go to the Pricing/Codes tab.

  3. Scroll down to the Add to Cart Configuration section.

  4. Open the Ecommerce Custom Fields Mappings collapsible panel.

Ecommerce Custom Fields Mappings panel in the Add to Cart Configuration section of the Pricing/Codes tab

Set up mappings

1

Select your method

At the top of Add to Cart Configuration, choose a Method. The method controls how configured products are sent to your sales channel, and it directly determines how field mappings are structured.

#
Method
How it works

1

Single Product

The configured product is added to cart as a single item, with all components combined into one product. This is the simplest approach.

2

Custom Defined Logic

Gives you three independent options that can be used separately or together: creating single variants, custom products or bundles. This method supports more complex product structures.

For a full explanation of each method, see Shopify Add to Cart Methods.

2

Select your integration type

Once you've selected a method, set the Integration type:

Integration type
Connects to

Shopify

Mimeeq Shopify App

WordPress

Mimeeq WordPress Plugin

The available mapping types update automatically based on your selection.

3

Configure your field mappings

How you configure field mappings depends on the method you selected in the first step. See the options for each method below.

Field mappings by method

A single flat mappings table is available. Click Add row to add individual field mappings directly.

Each row has four fields:

Column
Description

Type

The type of field on the ecommerce platform (see the platform-specific options below)

Field / Key

The field name or identifier; the format depends on the Type selected

Value

The value to write to that field; can be a static value or a formula

Skip on failure

Controls what happens if this mapping fails. If unchecked (default), a failed mapping blocks the add-to-cart action. If checked, the field is skipped and the product is still added to cart

All mappings defined here are automatically applied to every product created via this configurator.

Single Product mappings table with Type, Field / Key, Value and Skip on failure columns

Create one or more mapping groups, each containing its own set of field mappings. Groups can then be assigned to specific custom products and admin bundles.

Click Add mapping group to create a group. Each group:

  • Has an optional Mapping Group Name for internal reference (not shown to customers)

  • Contains one or more individual field mapping rows

  • Can be added or removed as needed

Each row within a group has the same four fields as above: Type, Field / Key, Value and Skip on failure.

Custom Defined Logic mapping groups, each with its own field mapping rows

Platform-specific field types

Shopify: Product Property

Maps to standard built-in Shopify product fields. Select from the predefined list:

Field key
What it sets in Shopify

vendor

Product vendor / manufacturer

productType

Shopify product type

barcode

Product or variant barcode (EAN, UPC, ISBN)

taxable

Whether the product is taxable (true / false)

taxCode

Tax code for the product

tracked

Whether inventory is tracked (true / false)

requiresShipping

Whether shipping is required (true / false)

countryCodeOfOrigin

ISO 3166-1 alpha-2 country code (e.g. GB, DE, US)

harmonizedSystemCode

HS tariff code for international customs

themeTemplate

Default theme product page template assigned to newly created products. Overrides the Product Template set in the Configurator Settings

Shopify: Product Metafield and Variant Metafield

Maps to custom metadata stored on the Shopify product or variant object.

Key format: namespace.key

Validation rules:

  • Must contain exactly one dot (.) separator

  • Namespace: 3–255 characters

  • Key: 2–64 characters

Find your metafield key in Shopify

If you're not sure which key to use, look it up in your Shopify admin:

  1. Navigate to Settings → Custom data in your Shopify admin.

  2. Select Products (or Variants, depending on your metafield type) under the Metafields section.

  3. Locate the metafield definition you want to use.

  4. Copy the key shown in the definition. It is already in namespace.key format (e.g. custom.lead_time).

  5. Paste that key into the Field / Key column in the Ecommerce Custom Fields Mappings panel.

Metafield definition in Shopify Settings → Custom data showing the namespace.key format

WordPress (WooCommerce): Product Metafield

Maps to WooCommerce product _meta fields.

Key format: snake_case

Validation rules:

  • 1–255 characters

  • Lowercase alphanumeric with underscores only

  • Must match the pattern lowercase_with_underscores

The Value field

Static values

Plain text or numbers, written exactly as entered:

Dynamic formulas

Start the value with = to reference configuration data. Formulas can pull from:

  • Option selections made by the customer during configuration

  • Item Master data fields

  • Mathematical calculations

Examples:

The value written to Shopify or WooCommerce can reflect exactly what the customer configured. For example, you can write the selected material code as a searchable product metafield.


Practical examples

Write a material code to a Shopify variant metafield

Store the selected fabric code in a Shopify variant metafield for use in order workflows.

Type
Field / Key
Value
Skip on failure

Variant Metafield

custom.fabric_code

={fabric#code}

✅

Result: when a customer selects fabric LINEN_NATURAL and adds to cart, the Shopify variant record includes custom.fabric_code = LINEN_NATURAL.

Set customs data for export products

Apply the HS code, country of origin and tax code to every product created via this configurator.

Type
Field / Key
Value
Skip on failure

Product Property

harmonizedSystemCode

9401.61

✅

Product Property

countryCodeOfOrigin

GB

❌

Product Property

taxCode

STANDARD

✅

Pass lead time to WooCommerce

Write the lead time for the selected material to a WooCommerce custom field.

Type
Field / Key
Value
Skip on failure

Product Custom Field

lead_time_days

={material#lead_time_days}

✅

Each material option carries its own lead time value (e.g. 14 for standard, 28 for bespoke), which is passed through dynamically.

Tag bespoke variants with a custom metafield

Flag made-to-measure products using a combination of a static taxable value and a dynamic bespoke identifier.

Type
Field / Key
Value
Skip on failure

Product Property

taxable

true

✅

Variant Metafield

custom.is_bespoke

={product_type#code}

✅


Validation and error prevention

Rule
Detail

Duplicate keys

Duplicate keys within the same mapping group are not allowed. An (already used) indicator appears and saving is blocked.

Invalid Shopify metafield format

Keys must follow the namespace.key format. An error message appears if the format is incorrect.

Invalid WordPress key format

Keys must be snake_case. An error appears for any invalid characters.

Shopify validation errors

If Shopify rejects a value (e.g. incorrect type or format), the product will not be created. If Skip on failure is enabled for that row, the field is skipped rather than blocking the cart. These errors come from Shopify directly and must be corrected by the user.

Failed mapping with Skip on failure unchecked

If a mapping fails and Skip on failure is disabled, the add-to-cart action is blocked. Check the field value or formula, or enable Skip on failure if the field is non-critical.


Last updated

Was this helpful?