Ir para o conteúdo

Atividade de Consulta BigCommerce

Introdução

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

Criar uma atividade de Consulta BigCommerce

Uma instância de uma atividade de Consulta do BigCommerce é criada a partir de uma conexão BigCommerce 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 mais detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

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

Configurar uma atividade de Consulta BigCommerce

Siga estas etapas para configurar uma atividade de Consulta do BigCommerce:

Etapa 1: Insira um nome e selecione um objeto

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é descrito abaixo.

Configuração da atividade de consulta BigCommerce passo 1

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do BigCommerce e não deve conter barras (/) ou dois pontos (:).

  • Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do BigCommerce. Ao reabrir uma configuração de atividade existente, apenas o objeto selecionado é exibido em vez de recarregar toda a lista de objetos.

    • 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 atualizar ou na palavra Atualizar para recarregar objetos do endpoint do BigCommerce. Isso pode ser útil se objetos foram adicionados ao BigCommerce. 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 de 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 BigCommerce:

      • Nome: O nome do objeto do BigCommerce.

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

    Dica

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

  • Salvar & Sair: Se habilitado, clique para salvar a configuração deste passo 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: Selecione um subobjeto

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

Configuração da atividade de consulta BigCommerce, etapa 2

  • Selecionar um Subobjeto: Esta seção exibe os subobjetos disponíveis no endpoint do BigCommerce. Ao reabrir uma configuração de atividade existente, apenas o subobjeto selecionado é exibido em vez de recarregar toda a lista de subobjetos.

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

    • Subobjeto Selecionado: Após um subobjeto ser selecionado, ele é listado aqui.

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

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

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

      • Nome: O nome do subobjeto do BigCommerce.

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

    Dica

    Se a tabela não for preenchida com sub-objetos disponíveis, a conexão com o BigCommerce 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 pede 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 BigCommerce

  • 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.

    Nota

    Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

    O conector do BigCommerce utiliza a API REST do BigCommerce, seja V3 (padrão) ou V2. Selecione qual versão usar na conexão. Ambas as versões da API REST do BigCommerce têm APIs obsoletas. Para mais informações e substituições sugeridas, consulte a documentação do BigCommerce. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

    Os esquemas de dados de solicitação e resposta consistem nesses nós e campos:

    • Requisição:

      Campo/Nó do Esquema de Requisição Notas
      queryRequest Nó representando a requisição de consulta
      include Parâmetros usados durante a consulta
      cartId ID único deste carrinho

    • Resposta:

      Campo/Nó do Esquema de Resposta Notas
      queryResponse Nó representando a resposta da consulta
      items Nó representando os itens que foram consultados
      created_time Hora em que o carrinho foi criado
      updated_time Hora em que o carrinho foi atualizado pela última vez
      discount_amount O valor descontado
      cart_amount Soma dos valores dos itens do carrinho menos descontos e cupons a nível de carrinho. Este valor inclui impostos (quando aplicável)
      tax_included Retorna true se o imposto foi incluído, ou false se o imposto não foi incluído
      line_items Nó representando os itens de linha consultados
      physical_items Nó representando os atributos físicos dos itens consultados
      items Nó representando os itens consultados

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

  • Editar: Clique no ícone de editar acima de cada esquema de dados 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 apenas 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 irá 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 de 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 pede que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Consulta do BigCommerce, 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 Menu de ações da atividade em Fundamentos do conector.

As atividades de Consulta do BigCommerce podem ser usadas como fonte com esses padrões de operação:

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.