Acessar dados detalhados no admin da Shopify usando JSON

JSON, abreviação de JavaScript Object Notation, é um formato de armazenamento e transporte de dados, usado com frequência quando os dados são enviados de servidores para páginas da web. Na maioria das páginas de recursos no admin da Shopify, como as páginas Pedidos, Produtos ou Clientes, é possível acessar dados mais detalhados em JSON.

Embora não seja necessário realizar tarefas avançadas de desenvolvimento com JSON, o acesso ao arquivo JSON de um recurso específico no admin da Shopify pode ajudar a coletar informações mais detalhadas ou a solucionar e investigar problemas por conta própria. Por exemplo, é possível analisar o arquivo JSON de um produto para encontrar o ID da variante, que pode ser necessário para determinadas tarefas de migração de dados ou personalizações de código do tema. Outro exemplo é consultar o arquivo JSON de um pedido para confirmar a variável de dados que você quer usar ao criar um fluxo de trabalho automatizado no Shopify Flow.

O JSON é mais usado por pessoas desenvolvedoras, mas mesmo quem tem pouco conhecimento de programação pode se beneficiar ao aprender a encontrar e interpretar algumas informações comuns do JSON no admin da Shopify.

Nesta página

Reformatar um arquivo JSON

Os dados brutos do JSON são exibidos como uma longa sequência de variáveis e colchetes aninhados, o que dificulta a leitura por uma pessoa.

Para facilitar a leitura da formatação JSON, considere uma das seguintes opções:

Instale uma extensão de visualizador JSON no navegador.
Use o recurso “pretty-print” que a maioria dos navegadores da web modernos têm disponível por padrão:

Captura de tela de um arquivo JSON de produto com informações de exemplo do produto exibidas. A configuração da caixa de seleção “pretty-print” está ativa e destacada no canto superior esquerdo da página.

Acessar arquivos JSON no admin da Shopify

O admin da Shopify é o hub central para gerenciar todos os aspectos da sua empresa e foi projetado para exibir por padrão apenas as informações mais úteis e relevantes. As informações extras que são coletadas sempre que ações são executadas no admin ficam armazenadas nos arquivos .json de diferentes páginas de recursos. Esses detalhes extras não são exibidos por padrão porque essa quantidade de informações seria excessiva, inútil e dificultaria o uso do admin.

Para a maioria das tarefas da empresa, é possível usar as ferramentas da Shopify para acessar e interpretar as informações da loja. No entanto, em alguns casos pode ser útil analisar as informações específicas sobre determinados recursos, como produtos ou pedidos, na hora de solucionar um problema para descobrir por que ou quando algo aconteceu.

Exemplo: acessar o arquivo JSON de um pedido

Neste exemplo, você acessará o arquivo JSON de um pedido no admin da Shopify.

Etapas:

No admin da Shopify, acesse Pedidos.
Clique em qualquer pedido na lista de Pedidos.
Na barra de endereço do navegador, adicione .json ao final do URL. Ele ficará parecido com este exemplo:

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

Pressione Enter para recarregar a página na formatação JSON.
Opcional: se você não tiver uma extensão de visualizador JSON instalada no navegador, ative a configuração Pretty-print no navegador para tornar o arquivo JSON mais fácil de usar. Saiba mais sobre como reformatar um arquivo JSON.

Note que muitas informações esperadas sobre o pedido são exibidas, como "currency" e "line_items" associadas a ele, mas muitas outras informações detalhadas também são incluídas, como os "client_details" da sessão do navegador do cliente quando o pedido foi realizado. Esse tipo de informação é útil para o rastreamento geral da sessão e para a análise da plataforma de marketing, mas não é necessário para processar o pedido.

Exibir campos específicos em um arquivo JSON

É possível forçar os arquivos JSON a exibir apenas campos específicos, o que pode facilitar a interpretação das informações quando você sabe quais propriedades quer incluir. Ao final de qualquer URL de arquivo JSON na barra de endereço do navegador, adicione ?fields= e inclua os nomes das propriedades que você quer exibir, em qualquer ordem, separados por uma vírgula.

Por exemplo, para exibir o ID, as informações do cliente, o preço total e as tags de um pedido, adicione ?fields=id,customer,total_price,tags ao final do URL do arquivo JSON, como no exemplo a seguir:

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

Usar outros recursos JSON

Use os seguintes recursos JSON para exibir informações específicas no admin da Shopify:

Contagem de produtos: adicione /count.json ao final do URL da lista de produtos para exibir o número total de produtos. O URL completo deve ser:

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

Transações: adicione /transactions.json ao final do URL da página de um pedido para exibir apenas as informações de transação do pedido. Saiba mais sobre o recurso Transações.
Processamentos de pedidos: adicione /fulfillments.json ao final do URL da página de um pedido para exibir apenas as informações de processamento de pedidos. Saiba mais sobre o recurso Fulfillment.
Checkouts abandonados: adicione .json ao final do URL de um checkout abandonado para exibir informações detalhadas sobre o checkout abandonado. Saiba mais sobre o recurso Abandoned checkout.

Propriedades JSON comuns para solução de problemas

A tabela a seguir lista as propriedades JSON que você pode consultar para obter ajuda na solução de problemas com diferentes tipos de recursos. Por exemplo, se você quiser confirmar quando um determinado produto foi publicado, poderá analisar o arquivo JSON do produto em busca da propriedade published_at, que exibe a data e a hora no formato ISO 8601.

Esta tabela não inclui todos os recursos ou propriedades JSON possíveis armazenados no admin da Shopify. Portanto, consulte a Documentação para desenvolvedores da Shopify para ver as definições de qualquer recurso ou propriedade que não esteja incluído aqui.

Lista alguns exemplos de recursos do admin e propriedades comuns associadas a eles, incluindo definições sobre como podem ser usados na solução de problemas.
Recurso	Propriedade JSON	Definição
Produto	`"product": { "created_at"`	A data e a hora em que o produto foi criado.
	`"product": { "published_at"`	A data e a hora em que o status do produto foi definido como Ativo.
	`"product": { "updated_at"`	A data e a hora da atualização mais recente do produto. Isso pode incluir alterações na descrição do produto, no título ou nas informações de SEO, bem como atualizações automáticas, como alterações no estoque quando um produto é comprado.
Variante	`"product": { "variants": [ { "created_at"`	A data e a hora em que a variante foi criada. Pode ser diferente da data e da hora em que o produto geral foi criado.
	`"product": { "variants": [ { "updated_at"`	A data e a hora da atualização mais recente da variante. Pode ser diferente da data e da hora da última atualização do produto geral.
	`"product": { "variants": [ { "inventory_quantity"`	O valor atual do banco de dados e o que está acessível para compra pelos clientes. Pode ser um valor negativo se o estoque da variante não for rastreado ou se estiver configurado para sobrevenda.
	`"product": { "variants": [ { "old_inventory_quantity"`	O valor do banco de dados antes da última data de `updated_at` da variante.
Pedido	`"order": { "line_items": [ { "requires_shipping"`	Exibido como `true` ou `false`. Isso indica as configurações de frete do produto ou da variante no momento em que o pedido foi feito.
	`"order": { "line_items": [ { "taxable"`	Exibido como `true` ou `false`. Isso indica como o produto ou a variante estava configurado para cobrar tributos no momento em que o pedido foi feito.
	`"order": { "line_items": [ { "variant_inventory_management"`	Exibido como `shopify`, `amazon_marketplace_web`, `null` ou um valor de terceiros, dependendo de qual serviço de processamento de pedidos está configurado para rastrear o estoque do produto. Um valor `null` significa que o produto não estava sendo rastreado no momento do pedido.
	`"order": { "line_items": [ { "fulfillable_quantity"`	Exibe quanto do estoque ainda está reservado pelo sistema para concluir o pedido. Isso não corresponde ao estoque atual da variante.
	`"order": { "line_items": [ { "quantity"`	O número de produtos ou variantes comprados.
	`"order": { "line_items": [ { "tax_lines"`	Nos Estados Unidos, exibe valores estaduais, de condado e municipais. Se nenhuma linha de tributo for exibida, mas um tributo tiver sido cobrado no pedido, isso significa que o tributo foi cobrado sobre o custo de frete.
Cliente	`"customer": { "created_at"`	A data e a hora em que o cliente foi criado.
Cliente	`"customer": { "updated_at"`	A data e a hora da atualização mais recente do perfil do cliente.

Metacampos em JSON

Os metacampos são uma forma flexível de anexar outras informações personalizadas a um recurso da Shopify, como produtos ou coleções. Alguns exemplos de dados armazenados com metacampos incluem especificações de produtos, tabelas de tamanhos, documentos para download, datas de lançamento, imagens ou números de peça. Saiba mais sobre o uso de metacampos.

É possível adicionar /metafields.json ao final de um URL de página de recurso compatível para exibir os metacampos associados a esse recurso. Consulte a tabela a seguir para ver alguns exemplos de recursos e formatos de URL para exibir informações de metacampos em JSON.

Lista alguns exemplos de recursos do admin com um URL de exemplo para o arquivo JSON de metacampos.
Tipo de recurso de exemplo	URL de exemplo
Coleção inteligente	`https://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json`
Cliente	`https://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json`
Pedido	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json`
Página	`https://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json`
Produto	`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`
Imagem do produto	`https://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image` Observação: os metacampos de imagem de produto só podem ser adicionados pela API. Substitua o `{id}` e outros marcadores de posição no URL pelos valores reais das consultas de API.
Loja	`https://admin.shopify.com/store/{your-store-name}/metafields.json`

Para ver uma lista completa de recursos que podem ter metacampos e os tipos específicos de propriedades armazenados para cada tipo de recurso, consulte o recurso JSON Metafield na Documentação para desenvolvedores da Shopify.

Eventos em JSON

Eventos são gerados por alguns recursos da Shopify quando determinadas ações são concluídas, como a criação de um post do blog, o processamento de um pedido ou a adição de um produto.

É possível adicionar /events.json ao final do URL de uma página de recurso compatível para exibir os eventos associados a esse recurso. Consulte a tabela a seguir para ver alguns exemplos de recursos e formatos de URL para exibir informações de eventos em JSON.

Lista alguns exemplos de recursos do admin com um URL de exemplo para o arquivo JSON de eventos.
Tipo de recurso de exemplo	URL de exemplo
Pedido	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json` Este arquivo lista o `author` dos eventos, informando quais usuários concluíram determinadas ações, como quem ou o que publicou um produto.
Produto	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json` Este arquivo lista o `author` dos eventos, informando quais usuários concluíram determinadas ações, como quem ou o que marcou um pagamento como pago.
Loja	`https://admin.shopify.com/store/{your-store-name}/events.json?limit=250` Este formato de URL exibe os 250 eventos mais recentes que ocorreram na sua loja. Os eventos podem incluir, entre outros, criação ou atualizações de produtos, exclusões de páginas e atualizações de variantes.

Para ver uma lista completa de recursos que podem criar eventos e os eventos específicos criados para cada tipo de recurso, consulte o recurso JSON Event na Documentação para desenvolvedores da Shopify.