Skip to main content

Shopify custom field and metafield mapping — troubleshooting

How to diagnose and fix property mappings that are not pulling custom field or metafield data from Shopify orders into Mintsoft.

Written by Tom Higgs

If a Shopify property mapping is set up but data is not appearing on orders in Mintsoft, work through the checks below. Before starting, confirm the mapping exists by clicking Connect then Order Integrations, then Shopify, then Property Mappings for the affected connection.


The Name or Key value does not match the JSON

The Name field in the property mapping must exactly match the field name in the Shopify order JSON including capitalisation and spacing. To find the correct value:

  1. Click Orders then Overview.

  2. Find an affected Shopify order, click Actions then Details.

  3. Click the History tab, then the Connect sub-tab.

  4. Copy the JSON string and paste it into a JSON validator such as jsonlint.com.

  5. Search for the field you want to map. Note the exact value of the name key (non-GraphQL) or the key field (GraphQL) this is what must be entered in the Name field of the property mapping.


GraphQL vs non-GraphQL mismatch

Shopify connections upgraded to the GraphQL API use a different JSON structure. Using the wrong field reference will cause the mapping to silently fail.

Connection type

JSON section

Field to use as Name

GraphQL

customAttributes

key

Non-GraphQL

note_attributes

name

To check which version your connection uses, inspect the order JSON. If you see a customAttributes section, you are on GraphQL.


Wrong level selected

The Level field on the mapping determines where Mintsoft looks for the data in the JSON.

  • Select Order for data in the note_attributes or customAttributes section at the top of the order JSON for example, gift messages, delivery dates, and account codes.

  • Select OrderItem for data in the line_items section of the order JSON for example, personalisation options applied to a specific product.

If the level is set incorrectly, the mapping will not find the field even if the Name value is correct.


Metafields not appearing in the JSON

Shopify metafields are not included in the standard order JSON by default. They require either:

  • The Shopify connection to be on GraphQL, which supports metafield retrieval via the API, or

  • A custom Shopify app or flow that writes metafield values into note_attributes at checkout, making them visible in the standard JSON.

If the metafield value is not visible in the order JSON after following the steps above, it cannot be mapped via property mappings. Contact support to discuss options.


Mapping exists but data still not showing

If the mapping is configured correctly but the field is still not appearing on orders:

  • Property mappings only apply to orders imported after the mapping was created. Existing orders in Mintsoft will not be updated retroactively.

  • Place a new test order in Shopify, allow it to import, and check whether the mapped field now appears in the order details.

  • Confirm the Shopify order being tested actually contains the field in its JSON not all orders include all custom attributes.

Did this answer your question?