Pré-visualizar dados de API usados no Shopify Flow

É comum que você queira usar dados da loja em condições e ações durante a criação de um fluxo de trabalho. Nesse caso, use o Shopify Flow, que faz uma chamada à API GraphQL Admin e permite acessar quase todos os campos na API.

Quando você cria um fluxo de trabalho, é normal encontrar nomes e descrições de campos estabelecidos pela API, mas você precisa saber quais dados são fornecidos. Por exemplo, talvez você queira saber o nome do app em um pedido criado com base em um rascunho, ou ter certeza de que o fluxo de trabalho vai mostrar os dados esperados no formato certo.

O Shopify Flow oferece várias opções para você analisar essas informações.

Localizar um campo no Shopify Admin

Na maioria dos casos, é possível consultar o admin da Shopify para encontrar dados. Por exemplo, product.title é listado na página do produto.

Usar o campo em um fluxo de trabalho ativo

Use a ação Log output ("Saída do registro") para empregar os campos de um fluxo de trabalho com segurança. Quando você executa um fluxo de trabalho, essa ação imprime a saída de variáveis e textos na página "Executar histórico". Também é possível usar ações de notificação, como Send internal email ("Enviar e-mail interno").

Etapas para usar a ação "Log output":

1. Escolha um acionador que possa ser ativado manualmente.
2. Adicione uma ação Log output"Saída de registro" ao fluxo de trabalho e conecte-a ao acionador.
3. Na configuração da ação Log output ("Saída de registro"), clique em Adicionar uma variável para incluir as variáveis que você quer inspecionar à seção Output ("Saída").
4. Quando terminar, clique em Ativar fluxo de trabalho.
5. Acione o fluxo de trabalho manualmente ou faça com que o acionador seja ativado. Por exemplo, se você usa o acionador Order created ("Pedido criado"), crie um pedido de teste.
6. Depois que o fluxo de trabalho for executado, verifique o registro de atividade das variáveis.

Consultar a página JSON do recurso

Grande parte das páginas de recursos no Shopify Admin, como Pedido, Produto ou Cliente, permitem ver os dados relacionados. Essas informações não têm exatamente o mesmo nome e formato usado no Shopify Flow, mas os valores são iguais aos da API GraphQL Admin. Para analisar os dados, adicione .json ao URL.

Por exemplo, clique em um pedido na página Pedidos do Shopify Admin. Altere as informações na barra de endereços para:

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234

Para o seguinte:

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json

Observação

O formato .json segue a API REST. Em uma API REST, os nomes das variáveis são escritos em letras minúsculas e as palavras são separadas por sublinhados; por exemplo, line_items. Já GraphQL e Shopify Flow usam camelCasing, como lineItems. Além disso, às vezes os nomes dos campos são diferentes; por exemplo, properties em vez de customAttributes. Verifique as informações encontradas por meio dessa abordagem.

Usar GraphQL ou ferramenta de API de terceiros

É possível fazer uma consulta direta à API com uma ferramenta de terceiros, como o Postman, ou o GraphQL, disponibilizado de forma gratuita pala Shopify. Essa é a opção que gera os resultados mais precisos, mas é necessário ter conhecimentos sobre a criação de consultas em GraphQL.

Para o GraphQL, a Shopify oferece um explorador da web com dados genéricos e um app. Com GraphQL, é possível criar uma consulta com os mesmos nomes de campo do Shopify Flow, e os valores também serão iguais aos da loja se você usar o app.

Com essa ferramenta, você descobre os dados exatos usados pelo Shopify Flow, com informações reais sobre a loja. Por exemplo, quando você cria esta consulta:

{
  orders(first:5, reverse:true) {
    nodes {
      createdAt
      app {
        name
      }
      channelInformation {
        app {
          title
        }
      }
    }
  }
}

Nos resultados, a variável order / app / name exibe o nome do app para o pedido. Nesse caso, o pedido foi criado no app de rascunhos, então o valor é Draft Orders. As informações do canal de venda estão disponíveis apenas no app Point of Sale.

{
  "data": {
    "orders": {
      "nodes": [
        {
          "createdAt": "2023-04-10T12:32:41Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-04-10T12:29:12Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:23:10Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:20:53Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T15:45:15Z",
          "app": {
            "name": "Point of Sale"
          },
          "channelInformation": {
            "app": {
              "title": "Point of Sale"
            }
          }
        }
      ]
    }
  }