Ir para o conteúdo

Atividade de Consulta do ShipStation

Introdução

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

Limites de taxa

Limites de taxa diferentes são aplicados dependendo da versão da API do ShipStation utilizada:

Para mais informações sobre os limites de taxa, consulte a documentação da API do ShipStation V1 ou da API do ShipStation V2.

Criar uma atividade de Consulta do ShipStation

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

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

Configurar uma atividade de Consulta do ShipStation

Siga estas etapas para configurar uma atividade Query do ShipStation:

Etapa 1: Insira um nome e selecione um objeto

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

Configuração da atividade Query do ShipStation

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

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

    • Objeto ShipStation 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 ShipStation. Isso pode ser útil se objetos foram adicionados ao ShipStation. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibidos 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 ShipStation:

      • Nome: O nome do objeto do ShipStation.

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

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão do ShipStation 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: 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 ShipStation, etapa 2

  • 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 do ShipStation utiliza a API do ShipStation V1 ou a API do ShipStation V2 dependendo da versão selecionada ao configurar uma conexão do ShipStation. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint do ShipStation. 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.

  • 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 solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Consulta do ShipStation, 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, consulte o menu de ações da atividade em Conceitos básicos do conector.

As atividades Consulta do ShipStation 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.