Shopify metafields: definities, types en zo beheer je ze

Metafields zijn key-value-paren die eigen data toevoegen aan een Shopify-object. Producten zijn de meest gebruikte eigenaar, maar ook varianten, collecties, klanten, bestellingen en de winkel zelf kunnen metafields hebben. Elk metafield bestaat uit de vier delen in de tabel hieronder. Namespace en key vormen samen de identifier, dus custom.material op een product is een ander veld dan specs.material.

Webshops werken meestal in de namespace custom, die Shopify voorstelt als je in de admin een veld aanmaakt. Apps gebruiken hun eigen namespaces, en Shopify reserveert een eigen app-namespace ($app in de API) voor data die bij één app hoort. In het metafields-overzicht op shopify.dev staat het volledige model.

Een metafield-definitie is het schema: naam, namespace en key, type, een optionele beschrijving en validatieregels. De waarde is de data die op één product staat. Shopify adviseert zelf om eerst de definitie te maken, want de definitie maakt van een metafield een veld op de productpagina in de admin, dwingt validatie af en laat je het veld gebruiken in slimme collecties, adminfilters en, als je thema dynamische bronnen ondersteunt, de thema-editor.

Een waarde kan ook zonder definitie bestaan. De Admin API accepteert hem zolang je het type meestuurt, wat verplicht is als er geen definitie is voor die namespace, key en dat type eigenaar. Die waarden worden opgeslagen, maar niemand ziet er een getypt invoerveld voor in de admin. Voeg je later een definitie toe met dezelfde namespace, key en type, dan kun je de bestaande waarden daarnaar migreren, en waarden die niet aan de nieuwe validatie voldoen kun je daarna corrigeren.

Het type bepaalt wat een waarde mag bevatten en hoe thema's en apps hem lezen. Shopify deelt de types grofweg in zoals in de tabel. De meeste basistypes en alle referentietypes bestaan ook als lijst, zoals list.single_line_text_field, behalve boolean, id, json, language, money, multi_line_text_field en rich_text_field. De volledige, actuele lijst staat op de pagina met metafield-datatypes.

De standaard producttaxonomie van Shopify geeft elk product één categorie, los van het vrije producttype. Die categorie bepaalt de categorie-metafields: attributen die bij de categorie horen, zoals maat, halslijn en kleur voor shirts. De waarden zijn metaobject-items met standaardwaarden die verwijzen naar de gestandaardiseerde waarden van Shopify. Je kunt een item hernoemen (bijvoorbeeld zwart naar grafiet) of een veld koppelen aan een variantoptie, zodat één wijziging overal doorwerkt.

Je stelt de categorie in op de productpagina, waarna het blok Category metafields de velden voor die categorie toont, of in bulk via de bulkeditor of een CSV met het categorie-ID of de breadcrumb. Wissel je van categorie, dan gaan metafields met een waarde of variantkoppeling mee en lege niet. Shopify beschrijft dit op de pagina over productcategorieën.

Voor één product tegelijk volstaat de productpagina in de admin. Voor een hele catalogus heb je een van de bulkroutes hieronder nodig. Elke route heeft eigen regels, dus controleer die voordat je honderden producten aanpast. Meer over die routes lees je in Shopify producten bulk bewerken.

Limieten merk je zelden op dag één, maar ze bepalen wel hoe je velden ontwerpt voor een groeiende catalogus. Elke app en elk team dat eigen definities toevoegt, put uit dezelfde ruimte per objecttype. De cijfers hieronder komen uit de metafield-limieten en de MetafieldsSetInput-referentie van Shopify; controleer ze opnieuw voor een grote bouw, want Shopify past ze aan.

Staat je productdata in een PIM, dan bewerk je specificaties in de PIM en schrijft de Shopify-koppeling ze naar metafields. Zo heb je één bron voor de waarden die je webshop, feeds en marktplaatsen delen. Het belangrijkste is de taakverdeling: de PIM schrijft waarden, en de definities die die waarden zichtbaar maken in Shopify stel je in Shopify in.

De Shopify PIM-koppeling van WISEPIM schrijft metafield-waarden met metafieldsSet. Standaard schrijft hij wisepim.ean, wisepim.mpn en wisepim.country_of_origin, wisepim.cost als number_decimal en wisepim.short_description als multi_line_text_field. Het merk gaat naar het eigen vendor-veld van Shopify, niet naar een metafield. Product-FAQ's gaan, als je ze gebruikt, als json naar wisepim.faqs en wisepim.faq_schema.

Elk attribuut dat je in attribuutbeheer voor Shopify aanzet, wordt ook geschreven: onder de namespace wisepim met een key op basis van de attribuutcode, of terug naar de oorspronkelijke namespace, key en type als het attribuut uit een geïmporteerde Shopify metafield-definitie komt. Met veldmappings per koppeling zet je een veld uit of vul je het vanuit een ander attribuut, een vaste waarde of een sjabloon, en een waarde die niet bij het type past wordt overgeslagen in plaats van verstuurd.