Ir para o conteúdo

Atividade de Consulta do Shopify

Introdução

Uma atividade de Consulta do Shopify, utilizando sua conexão do Shopify, consulta dados de objetos especificados do Shopify e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Nota

A atividade de Consulta retornará dados de objetos que estão especificados dentro de seu esquema de solicitação. Para recuperar todos os dados do objeto selecionado, use a atividade de Leitura.

Limites de taxa

A API Admin REST do Shopify impõe um limite de taxa de 40 solicitações por aplicativo por loja por minuto. Essa cota se repõe a uma taxa de 2 solicitações por segundo. O limite de taxa é aumentado para lojas Shopify Plus. Para mais informações sobre o limite de taxa, consulte limites de taxa da API Admin REST do Shopify.

Criar uma atividade de Consulta do Shopify

Uma instância de uma atividade de Consulta do Shopify é criada a partir de uma conexão do Shopify usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de Componentes.

Uma atividade de Consulta do Shopify existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta do Shopify

Siga estas etapas para configurar uma atividade Query do Shopify:

Etapa 1: Insira um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione o objeto que contém os dados a serem consultados. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade Query do Shopify

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade Query do Shopify e não deve conter barras / ou dois pontos :.

  • Selecionar um objeto: Esta seção exibe os objetos disponíveis no endpoint do Shopify.

    • Objeto selecionado: Após um objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar objetos do endpoint do Shopify. Isso pode ser útil se objetos foram adicionados ao Shopify. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Selecionando um objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Shopify:

      • Nome: O nome do objeto do Shopify.

      • Descrição: A descrição do objeto Shopify.

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão Shopify pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecionar um sub-objeto

Nesta etapa, selecione um sub-objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de consulta Shopify etapa 2

  • Selecionar um objeto: Esta seção exibe sub-objetos disponíveis no endpoint Shopify.

    • Objeto selecionado: O objeto selecionado na etapa anterior é listado aqui.

    • Sub-objeto selecionado: Após um sub-objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de sub-objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os sub-objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar sub-objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar sub-objetos do endpoint Shopify. Isso pode ser útil se sub-objetos foram adicionados ao Shopify. Esta ação atualiza todos os metadados usados para construir a tabela de sub-objetos exibida na configuração.

    • Selecionando um sub-objeto: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar um sub-objeto. Apenas um sub-objeto pode ser selecionado. As informações disponíveis para cada sub-objeto são obtidas do endpoint Shopify:

      • Nome: O nome do sub-objeto do Shopify.

      • Descrição: A descrição do sub-objeto do Shopify.

    Dica

    Se a tabela não for preenchida com os sub-objetos disponíveis, a conexão do Shopify pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de consulta do Shopify - etapa 3

  • Esquemas de dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformações.

    Paginação

    A atividade Consulta do Shopify lida automaticamente com certos casos de paginação com base no campo limit no esquema de solicitação.

    • Se limit estiver definido (com um máximo de 250), a atividade retornará uma página de resultados que correspondem à consulta como sua resposta.
      • O número de resultados retornados para a página corresponde ao limit.
      • Se o número total de resultados exceder o limit, você pode navegar e processar manualmente páginas adjacentes usando os valores de resposta Token_next_page ou Token_previous_page no campo page_info de solicitações subsequentes.
    • Se limit não estiver definido, a atividade irá automaticamente anexar todas as páginas de resultados que correspondem à consulta e retorná-las como sua resposta.

    Para mais informações sobre os campos limit e page_info do esquema de solicitação, consulte a documentação de paginação do Shopify.

    O conector Shopify utiliza a API REST Admin do Shopify nas versões 2022-04, 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04 ou 2025-07, dependendo da seleção em uma conexão Shopify. Dependendo dos endpoints da API suportados pelo Shopify na versão da API em uso, os objetos e sub-objetos disponíveis para seleção podem variar. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

    Importante

    O Shopify lança uma nova versão da API a cada três meses e mantém cada versão lançada por um mínimo de doze meses. Uma vez que uma versão da API é descontinuada, o Shopify não manterá mais essa versão, e quaisquer chamadas de API solicitando essa versão serão automaticamente redirecionadas para a versão estável mais antiga atualmente suportada.

    O Shopify pode descontinuar certos endpoints com a introdução de uma nova versão da API. Como resultado, pode ser necessário alterar suas configurações de aplicativos e atividades devido a recursos alterados ou aposentados.

    As versões e endpoints da API descontinuados são anunciados no registro de alterações do Shopify, onde estão disponíveis mais detalhes e informações relevantes sobre migração.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas a partir do endpoint do Shopify. Essa ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Editar: Clique no ícone de edição acima do esquema de dados de resposta para entrar no editor. O editor permite adicionar, excluir e reorganizar nós e campos e alterar seus tipos de dados. Todos os nós e campos recém-adicionados são definidos como [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas somente após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas redefinirá os esquemas para suas estruturas padrão.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Query do Shopify, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos do conector.

Atividades Query do Shopify podem ser usadas como uma fonte com o padrão de duas transformações (como a segunda fonte apenas).

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.