Accès aux données détaillées dans votre interface administrateur Shopify à l’aide de JSON

JSON, abréviation de JavaScript Object Notation, est un format de stockage et de transport de données, souvent utilisé lorsque des données sont envoyées de serveurs à des pages web. Dans la plupart des pages de ressources de l’interface administrateur Shopify, telles que les pages Commandes, Produits ou Clients, vous pouvez accéder à des données plus détaillées à l’aide de JSON.

Bien que vous n’ayez pas besoin d’effectuer de tâches de développement avancées à l’aide de JSON, le fait de pouvoir accéder au fichier JSON d’une ressource particulière dans votre interface administrateur Shopify peut vous aider à recueillir des informations plus détaillées, ou à résoudre ou examiner vous-même des problèmes. Par exemple, vous pouvez examiner le fichier JSON d’un produit pour trouver son ID de variante, ce qui peut être nécessaire pour certaines tâches de migration de données ou de personnalisation du code du thème. Autre exemple : vous pouvez vous reporter au fichier JSON d’une commande pour confirmer la variable de données que vous souhaitez utiliser lors de la création d’un flux de travail automatisé dans Shopify Flow.

Le format JSON est le plus souvent utilisé par les développeurs, mais même les utilisateurs ayant des connaissances limitées en codage peuvent avoir avantage à apprendre à trouver et à interpréter certaines informations JSON courantes dans leur interface administrateur Shopify.

Sur cette page

Reformatage d’un fichier JSON

Les données JSON brutes s’affichent sous la forme d’une longue séquence de variables et de crochets imbriqués, ce qui est difficile à lire pour un utilisateur humain.

Pour rendre le formatage JSON plus lisible, envisagez l’une des options suivantes :

Installez une extension de visionneuse JSON dans votre navigateur.
Utilisez la capacité « pretty-print » que la plupart des navigateurs web modernes proposent par défaut :

Capture d’écran d’un fichier JSON de produit avec un exemple d’informations sur le produit affichées. Le paramètre de la case à cocher « pretty-print » est actif et surligné en haut à gauche de la page.

Accès aux fichiers JSON dans votre interface administrateur Shopify

L’interface administrateur Shopify est la plateforme centrale pour gérer tous les aspects de votre entreprise et elle est conçue pour afficher par défaut uniquement les informations les plus utiles et les plus pertinentes. Les informations supplémentaires qui sont recueillies chaque fois que des actions sont effectuées dans votre interface administrateur sont stockées dans les fichiers .json des différentes pages de ressources. Ces détails supplémentaires ne vous sont pas affichés par défaut, car cette quantité d’informations serait trop importante et peu utile, et rendrait votre interface administrateur difficile à utiliser.

Pour la plupart des tâches commerciales, vous pouvez utiliser les outils existants de Shopify pour accéder aux informations de votre boutique et les interpréter. Toutefois, il peut parfois être utile d’examiner les informations spécifiques concernant des ressources particulières, telles que des produits ou des commandes, lorsque vous cherchez à savoir pourquoi ou quand un événement s’est produit.

Exemple : accéder au fichier JSON d’une commande

Dans cet exemple, vous allez accéder au fichier JSON d’une commande dans votre interface administrateur Shopify.

Étapes :

Depuis votre interface administrateur Shopify, allez à Commandes.
Cliquez sur n’importe quelle commande de la liste Commandes.
Dans la barre d’adresse du navigateur, ajoutez .json à la fin de l’adresse URL. Elle sera similaire à cet exemple :

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

Appuyez sur Entrée pour recharger la page au format JSON.
Facultatif : si vous n’avez pas d’extension de visionneuse JSON installée dans votre navigateur, activez le paramètre Pretty-print dans votre navigateur pour rendre le fichier JSON plus convivial. En savoir plus sur le reformatage d’un fichier JSON.

Vous remarquerez que de nombreuses informations attendues sur la commande s’affichent, telles que la "currency" et les "line_items" qui lui sont associés, mais que de nombreuses autres informations détaillées sont également incluses, telles que les "client_details" de la visite du client sur le navigateur lorsqu’il a passé la commande. Ce type d’informations est utile pour le suivi global des visites et l’analyse des plateformes marketing, mais n’est pas nécessaire pour que vous puissiez traiter la commande.

Affichage de champs spécifiques dans un fichier JSON

Vous pouvez forcer les fichiers JSON à n’afficher que des champs spécifiques, ce qui peut faciliter l’interprétation des informations lorsque vous connaissez les propriétés particulières que vous souhaitez inclure. À la fin de n’importe quelle URL de fichier JSON dans la barre d’adresse du navigateur, ajoutez ?fields=, puis indiquez les noms des propriétés que vous souhaitez afficher, dans n’importe quel ordre, séparés par une virgule.

Par exemple, pour afficher l’ID d’une commande, les informations sur le client, le prix total et les balises, ajoutez ?fields=id,customer,total_price,tags à la fin de l’URL du fichier JSON, comme dans l’exemple suivant :

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

Utilisation d’autres ressources JSON

Vous pouvez utiliser les ressources JSON suivantes pour afficher des informations spécifiques dans votre interface administrateur Shopify :

Nombre de produits : ajoutez /count.json à la fin de l’URL de la liste de produits pour afficher le nombre total de produits. L’URL complète doit être :

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

Transactions : ajoutez /transactions.json à la fin de l’URL d’une page de commande pour afficher uniquement les informations sur la transaction de la commande. En savoir plus sur la ressource Transactions.
Traitements de commandes : ajoutez /fulfillments.json à la fin de l’URL d’une page de commande pour afficher uniquement les informations sur le traitement de la commande. En savoir plus sur la ressource Fulfillment.
Paiements abandonnés : ajoutez .json à la fin de l’URL d’un paiement abandonné pour afficher des informations détaillées sur le paiement abandonné. En savoir plus sur la ressource Abandoned checkout.

Propriétés JSON courantes pour la résolution de problèmes

Le tableau suivant répertorie les propriétés JSON que vous pouvez consulter pour vous aider à résoudre les problèmes liés à différents types de ressources. Par exemple, si vous souhaitez confirmer la date de publication d’un produit particulier, vous pouvez consulter le fichier JSON du produit pour la propriété published_at, qui affiche la date et l’heure au format ISO 8601.

Ce tableau n’inclut pas toutes les ressources ou propriétés JSON possibles stockées dans l’interface administrateur Shopify, référez-vous donc à la documentation pour les développeurs de Shopify pour obtenir les définitions des ressources ou propriétés qui ne sont pas incluses ici.

Répertorie quelques exemples de ressources de l’interface administrateur et les propriétés communes qui leur sont associées, y compris les définitions de leur utilisation possible pour la résolution de problèmes.
Ressource	Propriété JSON	Définition
Produit	`"product": { "created_at"`	L’heure et la date de création initiale du produit.
	`"product": { "published_at"`	L’heure et la date auxquelles le statut du produit a été défini sur Actif.
	`"product": { "updated_at"`	L’heure et la date les plus récentes de mise à jour du produit. Cela peut inclure des modifications apportées à la description du produit, au titre ou aux informations de référencement naturel (SEO), ainsi que des mises à jour automatiques telles que des modifications du stock lorsqu’un produit est acheté.
Variante	`"product": { "variants": [ { "created_at"`	L’heure et la date de création initiale de la variante. Celles-ci peuvent être différentes de la date et de l’heure de création du produit global.
	`"product": { "variants": [ { "updated_at"`	L’heure et la date les plus récentes de mise à jour de la variante. Celles-ci peuvent être différentes de la date et de l’heure de la dernière mise à jour du produit global.
	`"product": { "variants": [ { "inventory_quantity"`	La valeur actuelle dans la base de données et ce qui est accessible à l’achat pour les clients. Il peut s’agir d’une valeur négative si le stock de la variante n’est pas suivi ou si celle-ci est configurée pour la survente.
	`"product": { "variants": [ { "old_inventory_quantity"`	La valeur de la base de données avant la dernière date `updated_at` de la variante.
Commande	`"order": { "line_items": [ { "requires_shipping"`	S’affiche sous la forme `true` ou `false`. Indique les paramètres d’expédition du produit ou de la variante au moment où la commande a été passée.
	`"order": { "line_items": [ { "taxable"`	S’affiche sous la forme `true` ou `false`. Indique la manière dont le produit ou la variante était configuré(e) pour facturer les taxes au moment où la commande a été passée.
	`"order": { "line_items": [ { "variant_inventory_management"`	S’affiche sous la forme `shopify`, `amazon_marketplace_web`, `null` ou une valeur tierce, en fonction du service de traitement des commandes configuré pour suivre le stock du produit. Une valeur `null` signifie que le produit n’était pas suivi au moment de la commande.
	`"order": { "line_items": [ { "fulfillable_quantity"`	Indique la quantité de stock qui est encore réservée par le système pour traiter la commande. Cela ne correspond pas au stock actuel de la variante.
	`"order": { "line_items": [ { "quantity"`	Le nombre de produits ou de variantes achetés.
	`"order": { "line_items": [ { "tax_lines"`	Aux États-Unis, cette valeur affiche les montants au niveau de l’État, du comté et de la municipalité. Si aucune ligne de taxe ne s’affiche, mais qu’une taxe a été facturée sur la commande, cela signifie que la taxe a été facturée sur les coûts d’expédition.
Client	`"customer": { "created_at"`	L’heure et la date de création initiale du client.
Client	`"customer": { "updated_at"`	L’heure et la date les plus récentes de mise à jour du profil du client.

Champs méta en JSON

Les champs méta sont un moyen flexible d’associer des informations personnalisées supplémentaires à une ressource Shopify, telle que des produits ou des collections. Les fiches techniques de produits, les guides des tailles, les documents téléchargeables, les dates de sortie, les images ou les numéros de pièce sont des exemples de données stockées à l’aide de champs méta. En savoir plus sur l’utilisation des champs méta.

Vous pouvez ajouter /metafields.json à la fin de l’URL d’une page de ressource prise en charge pour afficher les champs méta qui sont associés à cette ressource. Reportez-vous au tableau suivant pour obtenir des exemples de ressources et de formats d’URL à utiliser pour afficher les informations des champs méta au format JSON.

Liste de quelques exemples de ressources de l’interface administrateur avec un exemple d’URL de fichier de champs méta JSON.
Exemple de type de ressource	Exemple d’URL
Collection automatisée	`https://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json`
Client	`https://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json`
Commande	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json`
Page	`https://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json`
Produit	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json`
Variante	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json`
Image de produit	`https://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image` Remarque : les champs méta d’images de produits ne peuvent être ajoutés que par le biais de l’API. Remplacez `{id}` et les autres paramètres fictifs dans l’URL par les valeurs réelles de vos requêtes d’API.
Boutique	`https://admin.shopify.com/store/{your-store-name}/metafields.json`

Pour obtenir la liste complète des ressources qui peuvent avoir des champs méta et des types de propriétés spécifiques qui sont stockés pour chaque type de ressource, référez-vous à la ressource JSON Metafield dans la documentation pour les développeurs de Shopify.

Événements en JSON

Certaines ressources Shopify génèrent des événements lorsque certaines actions sont effectuées, comme la création d’un article de blog, le traitement d’une commande ou l’ajout d’un produit.

Vous pouvez ajouter /events.json à la fin de l’URL d’une page de ressource prise en charge pour afficher les événements associés à cette ressource. Reportez-vous au tableau suivant pour obtenir des exemples de ressources et de formats d’URL à utiliser pour afficher les informations d’événement au format JSON.

Liste de quelques exemples de ressources de l’interface administrateur avec un exemple d’URL de fichier d’événements JSON.
Exemple de type de ressource	Exemple d’URL
Commande	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json` Ce fichier répertorie l’`author` (auteur) des événements, vous informant des utilisateurs qui ont effectué certaines actions, par exemple qui ou quoi a publié un produit.
Produit	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json` Ce fichier répertorie l’`author` (auteur) des événements, vous informant des utilisateurs qui ont effectué certaines actions, par exemple qui ou quoi a marqué un paiement comme étant payé.
Boutique	`https://admin.shopify.com/store/{your-store-name}/events.json?limit=250` Ce format d’URL affiche les 250 événements les plus récents qui ont eu lieu dans votre boutique. Les événements peuvent inclure, sans s’y limiter, la création ou les mises à jour de produits, les suppressions de pages et les mises à jour de variantes.

Pour obtenir la liste complète des ressources qui peuvent créer des événements et des événements spécifiques créés pour chaque type de ressource, référez-vous à la ressource JSON Event dans la documentation pour les développeurs de Shopify.