Ir para o conteúdo

Atividade de Consulta do BigCommerce

Introdução

Uma atividade BigCommerce Query, usando sua conexão BigCommerce, consulta dados de um objeto no BigCommerce e destina-se a ser usado como fonte para fornecer dados em uma operação.

Crie uma Atividade de Consulta do BigCommerce

Uma instância de uma atividade BigCommerce Query é criada a partir de uma conexão do BigCommerce 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 Criando uma instância de atividade em Reutilização de componentes.

Uma atividade Query existente do BigCommerce pode ser editada nestes locais:

Configurar uma Atividade de Consulta do BigCommerce

Siga estas etapas para configurar uma atividade Query do BigCommerce:

Etapa 1: Insira um Nome e Selecione um Objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

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

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

  • Selecione um objeto: Esta seção exibe 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: 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 Ícone de atualização ou a palavra Atualizar para recarregar objetos do endpoint do BigCommerce. Isso pode ser útil se objetos tiverem sido adicionados ao BigCommerce. 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 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 BigCommerce 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 BigCommerce

  • Selecione um subobjeto: Esta seção exibe 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 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 Ícone de atualização ou a palavra Atualizar para recarregar subobjetos do endpoint do BigCommerce. Isso pode ser útil se subobjetos tiverem sido adicionados ao BigCommerce. 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 BigCommerce:

      • Nome: O nome do subobjeto do BigCommerce.

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

    Dica

    Se a tabela não for preenchida com subobjetos disponíveis, a conexão BigCommerce 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 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ção.

    Nota

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

    O conector BigCommerce usa BigCommerce REST API v3.0. 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 nestes nós e campos:

    • Solicitação:

      Campo/nó do esquema de solicitação Notas
      queryRequest Nó que representa a solicitação de consultar
      include Parâmetros usados durante a consulta
      cartId ID exclusivo deste carrinho

    • Resposta:

      Campo/nó do esquema de resposta Notas
      queryResponse Nó que representa a resposta da consultar
      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 com desconto
      cart_amount Soma dos valores dos itens de linha do carrinho menos descontos e cupons no nível do carrinho. Este montante inclui impostos (quando aplicável)
      tax_included Devoluções true se o imposto foi incluído, ou false se o imposto não estivesse incluído
      line_items Nó que representa as partidas individuais consultadas
      physical_items Nó que representa os atributos físicos dos itens consultados
      items Nó representando os itens consultados

  • Atualizar: Clique no ícone de atualização Ícone de atualização ou a palavra Atualizar para regenerar esquemas do endpoint do BigCommerce. 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 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 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 BigCommerce, 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 BigCommerce podem ser usadas como fonte com estes padrões de operação:

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.