BigCommerce Delete activity
Introdução
Uma atividade Delete do BigCommerce, utilizando sua conexão BigCommerce, exclui um registro de objeto do BigCommerce e é destinada a ser usada como um alvo para consumir dados em uma operação.
Criar uma atividade Delete do BigCommerce
Uma instância de uma atividade Delete do BigCommerce é criada a partir de uma conexão BigCommerce usando seu tipo de atividade Delete.
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 Delete do BigCommerce existente pode ser editada a partir destes locais:
- A tela de design (veja Menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
Configurar uma atividade Delete do BigCommerce
Siga estas etapas para configurar uma atividade Delete do BigCommerce:
-
Etapa 1: Insira um nome e selecione um objeto.
Forneça um nome para a atividade e selecione um objeto. -
Etapa 2: Selecione um sub-objeto
Selecione um sub-objeto da lista disponível no endpoint do BigCommerce. Esta lista muda dinamicamente dependendo do que foi selecionado na etapa anterior. -
Etapa 3: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.
Passo 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.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Exclusão 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 com o BigCommerce pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e retestando as credenciais.
-
-
Continue on Error: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações.
-
Save & Exit: Se ativado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.
-
Next: 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 Finished na última etapa.
-
Discard Changes: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Step 2: Select a sub-object
Nesta etapa, selecione um sub-objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Select a Sub-object: Esta seção exibe os sub-objetos disponíveis no endpoint do BigCommerce. Ao reabrir uma configuração de atividade existente, apenas o sub-objeto selecionado é exibido em vez de recarregar toda a lista de sub-objetos.
-
Selected Object: O objeto selecionado na etapa anterior é listado aqui.
-
Selected Sub-object: Após um sub-objeto ser selecionado, ele é listado aqui.
-
Search: 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.
-
Refresh: Clique no ícone de atualizar ou na palavra Refresh para recarregar sub-objetos do endpoint do BigCommerce. Isso pode ser útil se sub-objetos foram adicionados ao BigCommerce. 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 em 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 do BigCommerce:
-
Nome: O nome do sub-objeto 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 para você confirmar 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.
-
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 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 nos seguintes nós e campos:
-
Solicitação:
Campo/Nó do Esquema de Solicitação Notas deleteRequest
Nó representando a solicitação de exclusão items
Nó representando os itens a serem excluídos do carrinho. item_id
O ID do item a ser excluído. Remover o último item do carrinho excluirá o carrinho. include
Parâmetros usados durante a exclusão cartId
O ID único deste carrinho -
Resposta:
Campo/Nó do Esquema de Resposta Notas deleteResponse
Nó representando a resposta de exclusão items
Nó representando os itens que foram excluídos deleted
Retorna true
se excluído, oufalse
se não excluídodiscription
Descrição dos itens excluídos errors
Nó representando erros status
O código de status HTTP. title
O título do erro descrevendo o erro específico. errorDetails
Nó contendo quaisquer mensagens de erro items
Nó representando os itens a que a mensagem de erro se refere #text
String definida para o erro
-
-
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, além de 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 Excluir 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, consulte o menu de ações da atividade em Conceitos básicos do conector.
Atividades de Exclusão do BigCommerce podem ser usadas como um alvo com esses padrões de operação:
- Padrão de transformação
- Padrão de duas transformações (como o primeiro ou segundo alvo)
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.