Gedetailleerde gegevens in je Shopify-beheercentrum openen met JSON

JSON, een afkorting van JavaScript Object Notation, is een indeling voor het opslaan en overdragen van gegevens die vaak wordt gebruikt wanneer gegevens van servers naar webpagina's worden verzonden. Op de meeste resourcepagina's in het Shopify-beheercentrum, zoals de pagina's Bestellingen, Producten of Klanten, kun je met JSON toegang krijgen tot meer gedetailleerde gegevens.

Hoewel je geen geavanceerde ontwikkeltaken met JSON hoeft uit te voeren, kan het openen van het JSON-bestand voor een bepaalde resource in je Shopify-beheercentrum je helpen om meer gedetailleerde informatie te verzamelen of om zelf problemen op te lossen of te onderzoeken. Je kunt bijvoorbeeld het JSON-bestand voor een product bekijken om de variant-ID ervan te vinden, die nodig kan zijn voor bepaalde datamigratietaken of aanpassingen aan themacode. Een ander voorbeeld: je kunt het JSON-bestand van een bestelling raadplegen om de datavariabele te bevestigen die je wilt gebruiken bij het bouwen van een geautomatiseerde workflow in Shopify Flow.

JSON wordt meestal door ontwikkelaars gebruikt, maar zelfs gebruikers met beperkte kennis van programmeren kunnen er baat bij hebben om te leren hoe ze bepaalde veelvoorkomende JSON-informatie in hun Shopify-beheercentrum kunnen vinden en interpreteren.

Op deze pagina

Een JSON-bestand opnieuw opmaken

Onbewerkte JSON-gegevens bestaan uit een lange reeks geneste variabelen en haakjes, waardoor ze moeilijk leesbaar zijn.

Overweeg een van de volgende opties om de JSON-opmaak leesbaarder te maken:

Installeer een JSON viewer-extensie in je browser.
Gebruik de 'pretty-print'-functie die in de meeste moderne webbrowsers standaard beschikbaar is:

Screenshot van een JSON-productbestand met voorbeelden van productinformatie. Het selectievakje 'pretty-print' is aangevinkt en linksboven op de pagina gemarkeerd.

JSON-bestanden openen in je Shopify-beheercentrum

Het Shopify-beheercentrum is de centrale plek voor het beheer van alle aspecten van je bedrijf. Het is zo ontworpen dat standaard alleen de meest nuttige en relevante informatie wordt weergegeven. De extra informatie die wordt verzameld wanneer er acties worden uitgevoerd in je beheercentrum, wordt opgeslagen in de .json-bestanden van verschillende resourcepagina's. Deze extra gegevens worden niet standaard weergegeven, omdat die hoeveelheid informatie overweldigend en onpraktisch zou zijn en je beheercentrum daardoor moeilijk te gebruiken zou worden.

Voor de meeste bedrijfstaken kun je de bestaande tools van Shopify gebruiken om de informatie van je winkel te openen en te interpreteren. Het kan echter af en toe handig zijn om de specifieke informatie over bepaalde resources, zoals producten of bestellingen, te bekijken bij het oplossen van problemen om te achterhalen waarom of wanneer iets is gebeurd.

Voorbeeld: het JSON-bestand van een bestelling openen

In dit voorbeeld open je het JSON-bestand van een bestelling in je Shopify-beheercentrum.

Stappen:

Ga in het Shopify-beheercentrum naar Bestellingen.
Klik op een bestelling in de lijst Bestellingen.
Voeg in de adresbalk van de browser .json toe aan het einde van de URL. De URL is dan vergelijkbaar met dit voorbeeld:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json

Druk op Enter om de pagina opnieuw te laden in JSON-opmaak.
Optioneel: Als je geen JSON viewer-extensie in je browser hebt geïnstalleerd, activeer dan de instelling Pretty-print in je browser om het JSON-bestand gebruiksvriendelijker te maken. Meer informatie over het opnieuw opmaken van een JSON-bestand.

Je zult zien dat er veel verwachte informatie over de bestelling wordt weergegeven, zoals de "currency" en de "line_items" die aan de bestelling zijn gekoppeld. Er staat echter ook veel andere gedetailleerde informatie in, zoals de "client_details" van de browsersessie van de klant op het moment dat deze de bestelling plaatste. Dit soort informatie is handig voor algemene sessietracking en analytics van marketingplatforms, maar is niet nodig om de bestelling te verwerken en af te handelen.

Specifieke velden in een JSON-bestand weergeven

Je kunt forceren dat JSON-bestanden alleen specifieke velden weergeven. Dit maakt de informatie makkelijker te interpreteren als je weet welke specifieke eigenschappen je wilt opnemen. Voeg aan het einde van de URL van een JSON-bestand in de adresbalk van de browser ?fields= toe, gevolgd door de namen van de eigenschappen die je wilt weergeven, in willekeurige volgorde en gescheiden door een komma.

Als je bijvoorbeeld de ID van een bestelling, klantinformatie, de totaalprijs en tags wilt weergeven, voeg je ?fields=id,customer,total_price,tags toe aan het einde van de URL van het JSON-bestand, zoals in het volgende voorbeeld:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json?fields=id,customer,total_price,tags

Andere JSON-resources gebruiken

Je kunt de volgende JSON-resources gebruiken om specifieke informatie weer te geven in je Shopify-beheercentrum:

Productaantal: Voeg /count.json toe aan het einde van de URL van de productenlijst om het totale aantal producten weer te geven. De volledige URL moet zijn:

https://admin.shopify.com/store/{example-shop-name}/products/count.json

Transacties: Voeg /transactions.json toe aan het einde van de URL van een bestelpagina om alleen de transactiegegevens van de bestelling weer te geven. Meer informatie over de Transactions-resource.
Fulfilments: Voeg /fulfillments.json toe aan het einde van de URL van een bestelpagina om alleen de fulfilmentgegevens van de bestelling weer te geven. Meer informatie over de Fulfillment-resource.
Afgebroken checkouts: Voeg .json toe aan het einde van de URL van een afgebroken checkout om gedetailleerde informatie over de afgebroken checkout weer te geven. Meer informatie over de resource Afgebroken checkout.

Veelvoorkomende JSON-eigenschappen voor probleemoplossing

De volgende tabel bevat JSON-eigenschappen die je kunt raadplegen voor hulp bij het oplossen van problemen met verschillende resourcetypen. Als je bijvoorbeeld wilt bevestigen wanneer een bepaald product is gepubliceerd, kun je de eigenschap published_at in het JSON-bestand van het product bekijken. Hierin worden de datum en tijd in ISO 8601-notatie weergegeven.

Deze tabel bevat niet alle mogelijke JSON-resources of -eigenschappen die in het Shopify-beheercentrum zijn opgeslagen. Raadpleeg daarom de documentatie voor ontwikkelaars van Shopify voor definities van resources of eigenschappen die hier niet worden vermeld.

Lijst met enkele voorbeelden van resources in het beheercentrum en de bijbehorende veelvoorkomende eigenschappen, inclusief definities van het gebruik ervan bij probleemoplossing.
Resource	JSON-eigenschap	Definitie
Product	`"product": { "created_at"`	De tijd en datum waarop het product oorspronkelijk is aangemaakt.
	`"product": { "published_at"`	De tijd en datum waarop de status van het product is ingesteld op Actief.
	`"product": { "updated_at"`	De meest recente tijd en datum waarop het product is bijgewerkt. Dit kan wijzigingen in de productbeschrijving, titel of SEO-informatie omvatten, evenals automatische updates zoals wijzigingen in de voorraad wanneer een product wordt gekocht.
Variant	`"product": { "variants": [ { "created_at"`	De tijd en datum waarop de variant oorspronkelijk is aangemaakt. Dit kan afwijken van de datum en tijd waarop het product als geheel is aangemaakt.
	`"product": { "variants": [ { "updated_at"`	De meest recente tijd en datum waarop de variant is bijgewerkt. Dit kan afwijken van de datum en tijd waarop het product als geheel voor het laatst is bijgewerkt.
	`"product": { "variants": [ { "inventory_quantity"`	De huidige databasewaarde en wat voor klanten beschikbaar is voor aankoop. Dit kan een negatieve waarde zijn als de variantvoorraad niet wordt gevolgd of als deze is ingesteld op oververkopen.
	`"product": { "variants": [ { "old_inventory_quantity"`	De databasewaarde van vóór de laatste `updated_at`-datum van de variant.
Bestelling	`"order": { "line_items": [ { "requires_shipping"`	Wordt weergegeven als `true` of `false`. Dit geeft de verzendinstellingen van het product of de variant aan op het moment dat de bestelling werd geplaatst.
	`"order": { "line_items": [ { "taxable"`	Wordt weergegeven als `true` of `false`. Dit geeft aan hoe voor het product of de variant belasting werd berekend op het moment dat de bestelling werd geplaatst.
	`"order": { "line_items": [ { "variant_inventory_management"`	Wordt weergegeven als `shopify`, `amazon_marketplace_web`, `null` of een waarde van een externe partij, afhankelijk van welke fulfilmentservice is ingesteld om de voorraad van het product te volgen. De waarde `null` betekent dat het product niet werd gevolgd op het moment van de bestelling.
	`"order": { "line_items": [ { "fulfillable_quantity"`	Geeft aan hoeveel voorraad nog is gereserveerd door het systeem om de bestelling te voltooien. Dit is niet gelijk aan de huidige variantvoorraad.
	`"order": { "line_items": [ { "quantity"`	Het aantal gekochte producten of varianten.
	`"order": { "line_items": [ { "tax_lines"`	In de Verenigde Staten worden hier de waarden voor staat, county en gemeente weergegeven. Als er geen belastingregels worden weergegeven, maar er wel belasting in rekening is gebracht voor de bestelling, betekent dit dat de belasting is geheven over de verzendkosten.
Klant	`"customer": { "created_at"`	De tijd en datum waarop de klant oorspronkelijk is aangemaakt.
Klant	`"customer": { "updated_at"`	De meest recente tijd en datum waarop het klantprofiel is bijgewerkt.

Metavelden in JSON

Metavelden zijn een flexibele manier om extra aangepaste informatie te koppelen aan een Shopify-resource, zoals producten of collecties. Voorbeelden van gegevens die met metavelden worden opgeslagen, zijn productspecificaties, maattabellen, downloadbare documenten, releasedatums, afbeeldingen of onderdeelnummers. Meer informatie over het gebruik van metavelden.

Je kunt /metafields.json toevoegen aan het einde van de URL van een ondersteunde resourcepagina om de metavelden weer te geven die aan die resource zijn gekoppeld. Raadpleeg de volgende tabel voor enkele voorbeelden van resources en URL-indelingen die je kunt gebruiken om metaveldinformatie met JSON weer te geven.

Lijst met enkele voorbeelden van beheerresources en een voorbeeld-URL voor een JSON-metaveldenbestand.
Voorbeeldresourcetype	Voorbeeld-URL
Automatische collectie	`https://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json`
Klant	`https://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json`
Bestelling	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json`
Pagina	`https://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json`
Product	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json`
Variant	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json`
Productafbeelding	`https://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image` Let op: metavelden voor productafbeeldingen kunnen alleen via de API worden toegevoegd. Vervang de `{id}` en andere tijdelijke aanduidingen in de URL door de werkelijke waarden uit je API-query's.
Winkel	`https://admin.shopify.com/store/{your-store-name}/metafields.json`

Raadpleeg de Metafield JSON-resource in de documentatie voor ontwikkelaars van Shopify voor een volledige lijst met resources die metavelden kunnen hebben en de specifieke typen eigenschappen die voor elk resourcetype worden opgeslagen.

Gebeurtenissen in JSON

Gebeurtenissen worden door sommige Shopify-resources gegenereerd wanneer bepaalde acties zijn voltooid, zoals het aanmaken van een blogpost, de fulfilment van een bestelling of de toevoeging van een product.

Je kunt /events.json toevoegen aan het einde van de URL van een ondersteunde resourcepagina om de gebeurtenissen weer te geven die aan die resource zijn gekoppeld. Raadpleeg de volgende tabel voor enkele voorbeelden van resources en URL-indelingen die je kunt gebruiken om gebeurtenisinformatie met JSON weer te geven.

Lijst met enkele voorbeelden van beheerresources en een voorbeeld-URL voor een JSON-gebeurtenissenbestand.
Voorbeeldresourcetype	Voorbeeld-URL
Bestelling	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json` Dit bestand vermeldt de `author` van gebeurtenissen en informeert je welke gebruikers bepaalde acties hebben voltooid, zoals wie of wat een product heeft gepubliceerd.
Product	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json` Dit bestand vermeldt de `author` van gebeurtenissen en informeert je welke gebruikers bepaalde acties hebben voltooid, zoals wie of wat een betaling als betaald heeft gemarkeerd.
Winkel	`https://admin.shopify.com/store/{your-store-name}/events.json?limit=250` Deze URL-indeling geeft de 250 meest recente gebeurtenissen weer die in je winkel hebben plaatsgevonden. Gebeurtenissen omvatten, maar zijn niet beperkt tot, het aanmaken of updaten van producten, het verwijderen van pagina's en variantupdates.

Raadpleeg de Event JSON-resource in de documentatie voor ontwikkelaars van Shopify voor een volledige lijst met resources die events kunnen aanmaken en de specifieke events die voor elk resourcetype worden aangemaakt.