Atividade de Consulta do Shopify¶

Introdução¶

Uma atividade Query do Shopify, usando sua conexão do Shopify, consulta dados de objetos especificados da Shopify e deve ser usado como fonte para fornecer dados em uma operação.

Nota

A atividade Query retornará dados do objeto especificados em seu esquema de solicitação. Para recuperar todos os dados do objeto selecionado, use a atividade de leitura.

Limites de Taxa¶

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

Crie uma Atividade de Consulta no Shopify¶

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

Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criar uma instância de atividade em Reutilização de componentes.

Uma atividade existente do Shopify Query* pode ser editada nestes locais:

A quadro de design (consulte Menu Ações do componente em Quadro de Design).
A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia Componentes do painel do projeto).

Configurar uma Atividade de Consulta do Shopify¶

Siga estas etapas para configurar uma atividade Query da Shopify:

Etapa 1: Insira um nome e selecione um objeto
Forneça um nome para a atividade e selecione o objeto que contém os dados a serem consultados.
Etapa 2: Selecione um subobjeto
Selecione um subobjeto.
Etapa 3: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

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.

Etapa 1 da configuração da atividade de consulta do Shopify

Nome: Insira um nome para identificar a atividade. O nome precisa ser exclusivo para cada atividade Query da Shopify e não deve conter barras / ou dois pontos :.
Selecione um objeto: Esta seção exibe os objetos disponíveis no endpoint do Shopify.
- Objeto Selecionado: Depois que um objeto é selecionado, ele é listado aqui.
- Pesquisar: Insira qualquer parte do nome do objeto na caixa de pesquisa para filtrar a lista de objetos. A busca não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
- Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar objetos do endpoint do Shopify. Isso pode ser útil se objetos tiverem sido adicionados ao Shopify. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibidos na configuração.
- Selecionando um objeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas no endpoint do Shopify:
  - Nome: O nome do objeto 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 sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.
Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.
Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecione um Subobjeto¶

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

Etapa 2 da configuração da atividade de consulta do Shopify

Selecione um objeto: Esta seção exibe subobjetos disponíveis no endpoint do Shopify.
- Objeto Selecionado: O objeto selecionado na etapa anterior está listado aqui.
- Subobjeto selecionado: Depois que um subobjeto é selecionado, ele é listado aqui.
- Pesquisar: Insira qualquer parte do nome do subobjeto na caixa de pesquisa para filtrar a lista de subobjetos. A busca não diferencia maiúsculas de minúsculas. Se os subobjetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar subobjetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
- Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar subobjetos do endpoint do Shopify. Isso pode ser útil se subobjetos tiverem sido adicionados ao Shopify. Esta ação atualiza todos os metadados utilizados para construir a tabela de subobjetos exibidos na configuração.
- Selecionando um subobjeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um subobjeto. Somente um subobjeto pode ser selecionado. As informações disponíveis para cada subobjeto são obtidas no endpoint do Shopify:
  - Nome: O nome do subobjeto do Shopify.
  - Descrição: A descrição do subobjeto Shopify.
Dica

Se a tabela não for preenchida com subobjetos disponíveis, a Conexão Shopify pode não ter sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revise os Esquemas de Dados¶

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

Etapa 3 da configuração da atividade de consulta do Shopify

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

Nota

Para obter informações sobre o esquema de solicitação page_info campo, consulte documentação de paginação do Shopify.

O conector do Shopify usa a API REST Admin do Shopify versão 2022-04, 2023-01, 2023-04, 2023-07, 2023-10 ou 2024-01 dependendo da seleção em uma conexão Shopify. Dependendo dos endpoints de API suportados pela Shopify na versão da API usada, os objetos e subobjetos 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 redireciona automaticamente as chamadas de versões de API não suportadas para a próxima versão suportada mais antiga. Observe que o Shopify descontinuou determinados endpoints da API Fulfillment com a versão 2022-07, conforme descrito em Suspensão de uso da API Fulfillment da Shopify.
Atualizar: Clique no ícone de atualização ou a palavra Atualizar para regenerar esquemas do endpoint do Shopify. Esta 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.
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.
Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos¶

Depois de configurar uma atividade Query do Shopify, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu Ações da atividade em Noções básicas do conector.

As atividades Query do Shopify podem ser usadas como fonte com estes padrões de operação:

Padrão de transformação
Padrão de arquivo de dois alvos (apenas como a primeira fonte)
Padrão de arquivo HTTP de dois destinos (apenas como a primeira fonte)
Padrão de duas transformações (como a primeira ou segunda fonte)

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

Quando estiver pronto, implantar e execute a operação e validar o comportamento verificando os logs de operação.