HubSpot CRM V2 (Editor Independente) (versão prévia)
Com o CRM hubSpot fácil de usar, você nunca precisará atualizar manualmente os relatórios ou se perguntar como sua equipe está acompanhando as cotas. Obtenha uma exibição em tempo real de todo o pipeline de vendas em um painel visual. O HubSpot CRM organizará, enriquecerá e acompanhará automaticamente cada contato em uma linha do tempo organizada.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.hubspot.com/products/crm |
| Política de privacidade | hhttps://legal.hubspot.com/privacy-policy |
| Categorias | Vendas e CRM |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Acesso (no formato 'Portador ${YOUR_TOKEN}') | secureString | O Token de Acesso (no formato 'Portador ${YOUR_TOKEN}') para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar e ou remover registros de uma lista |
Adicione e remova registros que já foram criados no sistema de e para ou de uma lista. Esse ponto de extremidade só funciona para listas que têm um |
| Adicionar registros a uma lista |
Adicione os registros fornecidos à lista. Os registros que não existem ou que já são membros da lista são ignorados. Esse ponto de extremidade só funciona para listas que têm um |
| Adicionar todos os registros de uma lista de origem a uma lista de destino |
Adicione todos os registros de uma lista de origem |
| Arquivar um contato por ID |
Mova um objeto identificado por contactId para a lixeira. |
| Arquivar um desconto |
Mova um objeto identificado por discountId para a lixeira. |
| Arquivar um destino de meta |
Mova um objeto identificado por goalTargetId para a lixeira. |
| Arquivar um envio de comentários |
Mova um objeto identificado por feedbackSubmissionId para a lixeira. |
| Arquivar um imposto |
Mova um objeto identificado por taxId para a lixeira. |
| Arquivar um item de linha |
Mova um objeto identificado por lineItemId para a lixeira. |
| Arquivar um lote de aspas por ID |
Arquive um lote de aspas por identificador. |
| Arquivar um lote de contatos por ID |
Arquive um lote de contatos por identificador. |
| Arquivar um lote de descontos por ID |
Arquive um lote de descontos por identificador. |
| Arquivar um lote de destinos de meta por ID |
Arquive um lote de destinos de meta por identificador. |
| Arquivar um lote de empresas por ID |
Arquive um lote de empresas por identificador. |
| Arquivar um lote de envios de comentários por ID |
Arquive um lote de envios de comentários por identificador. |
| Arquivar um lote de impostos por ID |
Arquive um lote de impostos por identificador. |
| Arquivar um lote de itens de linha por ID |
Arquive um lote de itens de linha por identificador. |
| Arquivar um lote de objetos por ID |
Arquive um lote de objetos por identificador. |
| Arquivar um lote de ofertas por ID |
Arquive um lote de ofertas por identificador. |
| Arquivar um lote de produtos por ID |
Arquive um lote de produtos por identificador. |
| Arquivar um lote de taxas por ID |
Arquive um lote de taxas por identificador. |
| Arquivar um lote de tíquetes por ID |
Arquive um lote de tíquetes por identificador. |
| Arquivar um objeto |
Mova um objeto identificado por objectId para a lixeira. |
| Arquivar um produto |
Mova um objeto identificado por productId para a lixeira. |
| Arquivar um tíquete |
Mova um objeto identificado por ticketId para a lixeira. |
| Arquivar uma aspa por ID |
Mova um objeto identificado por quoteId para a lixeira. |
| Arquivar uma empresa por ID |
Mova um objeto identificado pela companyId para a lixeira. |
| Arquivar uma oferta por ID |
Mova um objeto identificado por dealId para a lixeira. |
| Arquivar uma taxa por ID |
Mova um objeto identificado por feeId para a lixeira. |
| Aspas de pesquisa |
Recupere uma lista de aspas. |
| Atualizar um cartão |
Atualize uma definição de cartão com novos detalhes. |
| Atualizar um contato por ID |
Execute uma atualização parcial de um objeto identificado pelo contactidentifier. contactId refere-se ao identificador de objeto interno. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um desconto |
Execute uma atualização parcial de um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um destino de meta |
Execute uma atualização parcial de um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um envio de comentários |
Execute uma atualização parcial de um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um imposto |
Execute uma atualização parcial de um objeto identificado pelo taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um item de linha |
Execute uma atualização parcial de um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um lote de contatos |
Atualize um lote de contatos. |
| Atualizar um lote de cotações |
Atualize um lote de aspas. |
| Atualizar um lote de descontos |
Atualize um lote de descontos. |
| Atualizar um lote de destinos de meta |
Atualize um lote de destinos de meta. |
| Atualizar um lote de empresas |
Atualize um lote de empresas. |
| Atualizar um lote de envios de comentários |
Atualize um lote de envios de comentários. |
| Atualizar um lote de impostos |
Atualize um lote de impostos. |
| Atualizar um lote de itens de linha |
Atualize um lote de itens de linha. |
| Atualizar um lote de objetos |
Atualize um lote de objetos. |
| Atualizar um lote de ofertas |
Atualize um lote de ofertas. |
| Atualizar um lote de produtos |
Atualize um lote de produtos. |
| Atualizar um lote de taxas |
Atualize um lote de taxas. |
| Atualizar um lote de tíquetes |
Atualize um lote de tíquetes. |
| Atualizar um objeto |
Execute uma atualização parcial de um objeto identificado pelo objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um produto |
Execute uma atualização parcial de um objeto identificado pelo productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar um tíquete |
Execute uma atualização parcial de um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar uma cotação |
Execute uma atualização parcial de um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar uma empresa por ID |
Execute uma atualização parcial de um objeto identificado pelo companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar uma oferta |
Execute uma atualização parcial de um objeto identificado pelo dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Atualizar uma taxa por ID |
Execute uma atualização parcial de um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia. |
| Buscar associações de lista |
Busque as associações de uma lista na ordem classificada pelos |
| Cancelar uma importação ativa |
Isso permite que um desenvolvedor cancele uma importação ativa. |
| Criar aspas |
Crie uma cotação com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar associação padrão |
Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto. |
| Criar associações em lotes |
Criar associações em lote para objetos. |
| Criar associações padrão |
Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto. |
| Criar rótulos de associação |
Defina rótulos de associação entre dois registros. |
| Criar um contato |
Crie um contato com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um desconto |
Crie um desconto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um destino de meta |
Crie um destino de meta com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um envio de comentários |
Crie um envio de comentários com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um imposto |
Crie um imposto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um item de linha |
Crie um item de linha com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um lote de aspas |
Crie um lote de aspas. |
| Criar um lote de contatos |
Crie um lote de contatos. |
| Criar um lote de descontos |
Crie um lote de descontos. |
| Criar um lote de destinos de meta |
Crie um lote de destinos de meta. |
| Criar um lote de empresas |
Crie um lote de empresas. |
| Criar um lote de envios de comentários |
Crie um lote de envios de comentários. |
| Criar um lote de impostos |
Crie um lote de impostos. |
| Criar um lote de itens de linha |
Crie um lote de itens de linha. |
| Criar um lote de objetos |
Crie um lote de objetos. |
| Criar um lote de ofertas |
Crie um lote de ofertas. |
| Criar um lote de produtos |
Crie um lote de produtos. |
| Criar um lote de taxas |
Crie um lote de taxas. |
| Criar um lote de tíquetes |
Crie um lote de tíquetes. |
| Criar um novo cartão |
Define um novo cartão que ficará ativo em uma conta quando este aplicativo for instalado. |
| Criar um objeto |
Crie um objeto CRM com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um produto |
Crie um produto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar um tíquete |
Crie um tíquete com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar uma empresa |
Crie uma empresa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar uma oferta |
Crie um acordo com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Criar uma taxa |
Crie uma taxa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador. |
| Destinos de meta de pesquisa |
Recupere uma lista de destinos de meta. |
| Envios de comentários de pesquisa |
Recupere uma lista de envios de comentários. |
| Excluir associações |
Exclui todas as associações entre dois registros. |
| Excluir associações em lotes |
Associações de exclusão em lote para objetos. |
| Excluir rótulos de associação específicos |
Excluir rótulos de associação específicos para objetos em lote. Excluir uma associação sem rótulo também excluirá todas as associações rotuladas entre esses dois objetos. |
| Excluir todos os registros de uma lista |
Remova todos os registros de uma lista. Observação: a lista não é excluída. Esse ponto de extremidade só funciona para listas que têm um |
| Excluir um acordo para seguir o RGPD |
Exclua permanentemente um acordo e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um cartão |
Exclui permanentemente uma definição de cartão com o identificador especificado. Após a exclusão, as solicitações de busca de dados para esse cartão não serão mais enviadas ao seu serviço. Isso não pode ser desfeito. |
| Excluir um contato para seguir o RGPD |
Exclua permanentemente um contato e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um desconto para seguir o RGPD |
Exclua permanentemente um desconto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um envio de comentários para seguir o RGPD |
Exclua permanentemente um envio de comentários e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um imposto para seguir o RGPD |
Exclua permanentemente um imposto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um item de linha para seguir o RGPD |
Exclua permanentemente um item de linha e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um produto para seguir o RGPD |
Exclua permanentemente um produto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um tipo de objeto para seguir o RGPD |
Exclua permanentemente um tipo de objeto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir um tíquete para seguir o RGPD |
Exclua permanentemente um tíquete e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma cotação para seguir o RGPD |
Exclua permanentemente uma cotação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma empresa para seguir o RGPD |
Exclua permanentemente uma empresa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma meta de destino para seguir o RGPD |
Exclua permanentemente um destino de meta e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Excluir uma taxa para seguir o RGPD |
Exclua permanentemente uma taxa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro. |
| Iniciar uma exportação |
Começa a exportar dados crm para o portal, conforme especificado no corpo da solicitação. |
| Iniciar uma nova importação |
Começa a importar dados dos recursos de arquivo especificados. Isso carrega o arquivo correspondente e usa o objeto de solicitação de importação para converter linhas nos arquivos em objetos. |
| Itens de linha de pesquisa |
Recupere uma lista de itens de linha. |
| Ler associações em lotes |
Associações de leitura em lote para objetos a um tipo de objeto específico. O campo 'after' em um objeto de paginação retornado pode ser adicionado junto com a 'id' para recuperar a próxima página de associações desse objectidentifier. O campo 'link' foi preterido e deve ser ignorado. |
| Listar aspas |
Recuperar uma página de aspas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Listar associações para um objeto |
Lista todas as associações de um objeto por tipo de objeto. Limite de 500 por chamada. |
| Listar descontos |
Recupere uma página de descontos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Listar envios de comentários |
Recupere uma página de envios de comentários. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Listar tipos de associação |
Liste todos os tipos de associação válidos disponíveis entre dois tipos de objeto. |
| Listas de pesquisa |
Pesquise listas por nome de lista ou página em todas as listas fornecendo um valor vazio |
| Mesclar dois contatos |
Mesclar dois contatos com o mesmo tipo. |
| Mesclar dois descontos |
Mesclar dois descontos com o mesmo tipo. |
| Mesclar dois destinos de meta |
Mesclar dois destinos de meta com o mesmo tipo. |
| Mesclar dois envios de comentários |
Mesclar dois envios de comentários com o mesmo tipo. |
| Mesclar dois impostos |
Mesclar dois impostos com o mesmo tipo. |
| Mesclar dois itens de linha |
Mesclar dois itens de linha com o mesmo tipo. |
| Mesclar dois objetos |
Mesclar dois objetos com o mesmo tipo. |
| Mesclar dois produtos |
Mesclar dois produtos com o mesmo tipo. |
| Mesclar dois tíquetes |
Mesclar dois tíquetes com o mesmo tipo. |
| Mesclar duas aspas |
Mesclar duas aspas com o mesmo tipo. |
| Mesclar duas empresas |
Mesclar duas empresas com o mesmo tipo. |
| Mesclar duas ofertas |
Mesclar dois negócios com o mesmo tipo. |
| Mesclar duas taxas |
Mesclar duas taxas com o mesmo tipo. |
| Obter as informações sobre qualquer importação |
Um resumo completo de um registro de importação, incluindo todas as atualizações. |
| Obter contatos |
Recupere uma página de contatos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter destinos de meta |
Recuperar uma página de destinos de meta. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter empresas |
Recuperar uma página de empresas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter empresas por ID |
Recupere um lote de empresas por identificador interno ou valores de propriedade exclusivos. |
| Obter erros de importação |
Recupere uma lista de erros para uma importação. |
| Obter importações ativas |
Retorna uma lista paginada de importações ativas para essa conta. |
| Obter impostos |
Recuperar uma página de impostos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter item de linha |
Recupere um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter itens de linha |
Recuperar uma página de itens de linha. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter o status da ID da tarefa |
Recupere o status de um identificador de tarefa. |
| Obter objetos |
Recuperar uma página de objetos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter ofertas |
Recuperar uma página de ofertas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter produtos |
Recuperar uma página de produtos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter proprietários |
Recupere uma lista de proprietários. |
| Obter resposta de detalhes do cartão de exemplo |
Retorna uma resposta de detalhes de cartão de exemplo. Esse é o conteúdo com detalhes exibidos para um cartão que será mostrado a um usuário. Um aplicativo deve enviar isso em resposta à solicitação de busca de dados. |
| Obter taxas |
Recupere uma página de taxas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter todos os cartões |
Retorna uma lista de cartões para um determinado aplicativo. |
| Obter tíquetes |
Recupere uma página de tíquetes. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um acordo |
Recupere um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um cartão |
Retorna a definição de um cartão com o identificador especificado. |
| Obter um contato por ID |
Recupere um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um desconto |
Recupere um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um destino de meta por ID |
Recupere um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um envio de comentários |
Recupere um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um imposto por ID |
Recupere um objeto identificado pelo taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um lote de contatos por ID |
Recupere um lote de contatos por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de cotações por ID |
Recupere um lote de aspas por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de descontos por ID |
Recupere um lote de descontos por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de destinos de meta por ID |
Recupere um lote de destinos de meta por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de envios de comentários por ID |
Recupere um lote de envios de comentários por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de impostos por ID |
Recupere um lote de impostos por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de itens de linha por ID |
Recupere um lote de itens de linha por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de objetos por ID |
Recupere um lote de objetos por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de ofertas por ID |
Recupere um lote de ofertas por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de produtos por ID |
Recupere um lote de produtos por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de taxas por ID |
Recupere um lote de taxas por identificador interno ou valores de propriedade exclusivos. |
| Obter um lote de tíquetes por ID |
Recupere um lote de tíquetes por identificador interno ou valores de propriedade exclusivos. |
| Obter um objeto por ID |
Recupere um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um produto |
Recupere um objeto identificado pelo productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter um proprietário por ID |
Recupere um proprietário por determinado identificador ou useridentifier. |
| Obter um tíquete |
Recupere um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter uma cotação por ID |
Recupere um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter uma empresa por ID |
Recupere um objeto identificado por companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Obter uma taxa por ID |
Recupere um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades. |
| Pesquisar contatos |
Recupere uma lista de contatos. |
| Pesquisar descontos |
Recupere uma lista de descontos. |
| Pesquisar empresas |
Recuperar uma lista de empresas. |
| Pesquisar impostos |
Recupere uma lista de impostos. |
| Pesquisar ofertas |
Recupere uma lista de ofertas. |
| Pesquisar por tipo de objeto |
Recupere uma lista de objetos por tipo de objeto. |
| Pesquisar produtos |
Recupere uma lista de produtos. |
| Pesquisar taxas |
Recupere uma lista de taxas. |
| Pesquisar tíquetes |
Recupere uma lista de tíquetes. |
| Remover registros de uma lista |
Remova os registros fornecidos da lista. Os registros que não existem ou que não são membros da lista são ignorados. Esse ponto de extremidade só funciona para listas que têm um |
Adicionar e ou remover registros de uma lista
Adicione e remova registros que já foram criados no sistema de e para ou de uma lista. Esse ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
|
IDs de registro a serem adicionadas
|
recordIdsToAdd | array of string |
Os identificadores de registro a serem adicionados. |
|
|
IDs de registro a serem removidas
|
recordIdsToRemove | array of string |
Os identificadores de registro a serem removidos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
IDs de registro ausentes
|
recordIdsMissing | array of string |
Os identificadores de registro ausentes. |
|
IDs de registro removidas
|
recordIdsRemoved | array of string |
Os identificadores de registro removidos. |
|
IDs de registro adicionadas
|
recordsIdsAdded | array of string |
Os identificadores de registro adicionados. |
Adicionar registros a uma lista
Adicione os registros fornecidos à lista. Os registros que não existem ou que já são membros da lista são ignorados. Esse ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
|
body
|
body | True | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
IDs de registro ausentes
|
recordIdsMissing | array of string |
Os identificadores de registro ausentes. |
|
IDs de registro removidas
|
recordIdsRemoved | array of string |
Os identificadores de registro removidos. |
|
IDs de registro adicionadas
|
recordsIdsAdded | array of string |
Os identificadores de registro adicionados. |
Adicionar todos os registros de uma lista de origem a uma lista de destino
Adicione todos os registros de uma lista de origem sourceListId(especificada pelo ) a uma lista de destino (especificada pelo listId). Os registros que já são membros da lista de destino serão ignorados. As IDs de lista de destino e de origem devem ser diferentes. As listas de destino e de origem devem conter registros do mesmo tipo (por exemplo, contatos, empresas etc.). Esse ponto de extremidade funciona apenas para listas de destino que têm um processingType ou MANUALSNAPSHOT. A lista de origem pode ter qualquer processingType.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
|
ID da Lista de Origem
|
sourceListId | True | string |
O identificador da lista de origem. |
Retornos
- response
- string
Arquivar um contato por ID
Mova um objeto identificado por contactId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
O identificador de contato. |
Retornos
- response
- string
Arquivar um desconto
Mova um objeto identificado por discountId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Desconto
|
discountId | True | string |
O identificador do desconto. |
Retornos
- response
- string
Arquivar um destino de meta
Mova um objeto identificado por goalTargetId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de destino de meta
|
goalTargetId | True | string |
O identificador de destino de meta. |
Retornos
- response
- string
Arquivar um envio de comentários
Mova um objeto identificado por feedbackSubmissionId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de envio de comentários
|
feedbackSubmissionId | True | string |
O identificador de envio de comentários. |
Retornos
- response
- string
Arquivar um imposto
Mova um objeto identificado por taxId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
NIF
|
taxId | True | string |
O identificador de imposto. |
Retornos
- response
- string
Arquivar um item de linha
Mova um objeto identificado por lineItemId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do item de linha
|
lineItemId | True | string |
O identificador do item de linha. |
Retornos
- response
- string
Arquivar um lote de aspas por ID
Arquive um lote de aspas por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de contatos por ID
Arquive um lote de contatos por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de descontos por ID
Arquive um lote de descontos por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de destinos de meta por ID
Arquive um lote de destinos de meta por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de empresas por ID
Arquive um lote de empresas por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de envios de comentários por ID
Arquive um lote de envios de comentários por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de impostos por ID
Arquive um lote de impostos por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de itens de linha por ID
Arquive um lote de itens de linha por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de objetos por ID
Arquive um lote de objetos por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de ofertas por ID
Arquive um lote de ofertas por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de produtos por ID
Arquive um lote de produtos por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de taxas por ID
Arquive um lote de taxas por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um lote de tíquetes por ID
Arquive um lote de tíquetes por identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Arquivar um objeto
Mova um objeto identificado por objectId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
Retornos
- response
- string
Arquivar um produto
Mova um objeto identificado por productId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
O identificador do produto. |
Retornos
- response
- string
Arquivar um tíquete
Mova um objeto identificado por ticketId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tíquete
|
ticketId | True | string |
O identificador do tíquete. |
Retornos
- response
- string
Arquivar uma aspa por ID
Mova um objeto identificado por quoteId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da cotação
|
quoteId | True | string |
O identificador de aspas. |
Retornos
- response
- string
Arquivar uma empresa por ID
Mova um objeto identificado pela companyId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Empresa
|
companyId | True | string |
O identificador da empresa. |
Retornos
- response
- string
Arquivar uma oferta por ID
Mova um objeto identificado por dealId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da oferta
|
dealId | True | string |
O identificador do negócio. |
Retornos
- response
- string
Arquivar uma taxa por ID
Mova um objeto identificado por feeId para a lixeira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da taxa
|
feeId | True | string |
O identificador de taxa. |
Retornos
- response
- string
Aspas de pesquisa
Recupere uma lista de aspas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Atualizar um cartão
Atualize uma definição de cartão com novos detalhes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Aplicativo
|
appId | True | string |
O identificador do aplicativo. |
|
ID do Cartão
|
cardId | True | string |
O identificador do cartão. |
|
Title
|
title | string |
O título. |
|
|
Nome
|
name | string |
O nome. |
|
|
Propriedades a serem enviadas
|
propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
|
Tipo de cartão
|
cardType | string |
O tipo de cartão. |
|
|
URL de Destino
|
targetUrl | string |
O endereço de URL de destino. |
|
|
Função sem servidor
|
serverlessFunction | string |
A função sem servidor. |
|
|
Tipo de Dados
|
dataType | string |
O tipo de dados. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Base URLs
|
baseUrls | array of string |
Os endereços de URL base. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
Os endereços de URL base. |
|
Histórico de auditoria
|
auditHistory | array of object | |
|
Tipo de ação
|
auditHistory.actionType | string |
O tipo de ação. |
|
ID do aplicativo
|
auditHistory.applicationId | string |
O identificador do aplicativo. |
|
Fonte de autorização
|
auditHistory.authSource | string |
A fonte de autorização. |
|
Alterado em
|
auditHistory.changedAt | string |
Quando alterado em. |
|
Iniciando a ID do Usuário
|
auditHistory.initiatingUserId | string |
O identificador de usuário iniciador. |
|
ID do tipo de objeto
|
auditHistory.objectTypeId | string |
O identificador de tipo de objeto. |
|
Propriedades
|
display.properties | array of object | |
|
Tipo de Dados
|
display.properties.dataType | string |
O tipo de dados. |
|
Etiqueta
|
display.properties.label | string |
O rótulo. |
|
Nome
|
display.properties.name | string |
O nome. |
|
Opções
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
O rótulo. |
|
Nome
|
display.properties.options.name | string |
O nome. |
|
Tipo
|
display.properties.options.type | string |
O tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nome
|
fetch.objectTypes.name | string |
O nome. |
|
Propriedades a serem enviadas
|
fetch.objectTypes.propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
URL de Destino
|
fetch.targetUrl | string |
O endereço de URL de destino. |
|
ID
|
id | string |
O identificador. |
|
Title
|
title | string |
O título. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
Atualizar um contato por ID
Execute uma atualização parcial de um objeto identificado pelo contactidentifier. contactId refere-se ao identificador de objeto interno. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
O identificador de contato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um desconto
Execute uma atualização parcial de um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Desconto
|
discountId | True | string |
O identificador do desconto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um destino de meta
Execute uma atualização parcial de um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de destino de meta
|
goalTargetId | True | string |
O identificador de destino de meta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um envio de comentários
Execute uma atualização parcial de um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de envio de comentários
|
feedbackSubmissionId | True | string |
O identificador de envio de comentários. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um imposto
Execute uma atualização parcial de um objeto identificado pelo taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
NIF
|
taxId | True | string |
O identificador de imposto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um item de linha
Execute uma atualização parcial de um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do item de linha
|
lineItemId | True | string |
O identificador do item de linha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um lote de contatos
Atualize um lote de contatos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de cotações
Atualize um lote de aspas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de descontos
Atualize um lote de descontos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de destinos de meta
Atualize um lote de destinos de meta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de empresas
Atualize um lote de empresas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de envios de comentários
Atualize um lote de envios de comentários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de impostos
Atualize um lote de impostos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de itens de linha
Atualize um lote de itens de linha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de objetos
Atualize um lote de objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de ofertas
Atualize um lote de ofertas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de produtos
Atualize um lote de produtos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de taxas
Atualize um lote de taxas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um lote de tíquetes
Atualize um lote de tíquetes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Atualizar um objeto
Execute uma atualização parcial de um objeto identificado pelo objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um produto
Execute uma atualização parcial de um objeto identificado pelo productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Produto
|
productId | True | string |
O identificador do produto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar um tíquete
Execute uma atualização parcial de um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do tíquete
|
ticketId | True | string |
O identificador do tíquete. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar uma cotação
Execute uma atualização parcial de um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da cotação
|
quoteId | True | string |
O identificador de aspas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar uma empresa por ID
Execute uma atualização parcial de um objeto identificado pelo companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Empresa
|
companyId | True | string |
O identificador da empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar uma oferta
Execute uma atualização parcial de um objeto identificado pelo dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da oferta
|
dealId | True | string |
O identificador do negócio. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Atualizar uma taxa por ID
Execute uma atualização parcial de um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Os valores de propriedade fornecidos serão substituídos. As propriedades somente leitura e inexistentes serão ignoradas. Os valores de propriedades podem ser limpos passando uma cadeia de caracteres vazia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da taxa
|
feeId | True | string |
O identificador de taxa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Buscar associações de lista
Busque as associações de uma lista na ordem classificada pelos recordId registros na lista. Os recordIds são classificados em ordem crescente se um after deslocamento ou nenhum deslocamento for fornecido. Se apenas um before deslocamento for fornecido, os registros serão classificados em ordem decrescente. O after parâmetro de deslocamento terá precedência sobre o before deslocamento em um caso em que ambos são fornecidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Antes
|
before | string |
O anterior. |
|
|
Limit
|
limit | string |
O limite. |
|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of string |
Os resultados. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
|
Antes
|
paging.prev.before | string |
O anterior. |
|
Link
|
paging.prev.link | string |
O link. |
Cancelar uma importação ativa
Isso permite que um desenvolvedor cancele uma importação ativa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de importação
|
importId | True | string |
O identificador de importação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar aspas
Crie uma cotação com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
|
|
elit_26
|
elit_26 | string |
elit_26. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar associação padrão
Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Da ID do objeto
|
fromObjectId | True | string |
O identificador de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID do objeto para
|
toObjectId | True | string |
O identificador de objeto To. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Categoria de Associação
|
results.associationSpec.associationCategory | string |
A categoria de associação. |
|
ID do tipo de associação
|
results.associationSpec.associationTypeId | string |
O identificador de tipo de associação. |
|
ID
|
results.from.id | string |
O identificador. |
|
ID
|
results.to.id | string |
O identificador. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Errors
|
numErrors | string |
O número de erros. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
|
Errors
|
errors | array of object | |
|
Categoria
|
errors.category | string |
A categoria. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
A mensagem. |
|
Subcategoria
|
errors.errors.subCategory | string |
A subcategoria. |
|
Code
|
errors.errors.code | string |
O código. |
|
In
|
errors.errors.in | string |
A entrada. |
|
Message
|
errors.message | string |
A mensagem. |
|
Situação
|
errors.status | string |
O status. |
|
ID
|
errors.id | string |
O identificador. |
Criar associações em lotes
Criar associações em lote para objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID
|
id | string |
O identificador. |
|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Da ID do objeto
|
results.fromObjectId | string |
O identfiier do objeto From. |
|
Da ID do tipo de objeto
|
results.fromObjectTypeId | string |
O identificador de tipo de objeto From. |
|
Rótulos
|
results.labels | array of string |
Os rótulos. |
|
ID do objeto para
|
results.toObjectId | string |
O identificador de objeto To. |
|
ID do tipo to object
|
results.toObjectTypeId | string |
O identificador de tipo de objeto To. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar associações padrão
Crie o tipo de associação padrão (mais genérico) entre dois tipos de objeto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID
|
id | string |
O identificador. |
|
|
ID
|
id | string |
O identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Categoria de Associação
|
results.associationSpec.associationCategory | string |
A categoria de associação. |
|
ID do tipo de associação
|
results.associationSpec.associationTypeId | string |
O identificador de tipo de associação. |
|
ID
|
results.from.id | string |
O identificador. |
|
ID
|
results.to.id | string |
O identificador. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Errors
|
numErrors | string |
O número de erros. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
|
Errors
|
errors | array of object | |
|
Categoria
|
errors.category | string |
A categoria. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
A mensagem. |
|
Subcategoria
|
errors.errors.subCategory | string |
A subcategoria. |
|
Code
|
errors.errors.code | string |
O código. |
|
In
|
errors.errors.in | string |
A entrada. |
|
Message
|
errors.message | string |
A mensagem. |
|
Situação
|
errors.status | string |
O status. |
|
ID
|
errors.id | string |
O identificador. |
Criar rótulos de associação
Defina rótulos de associação entre dois registros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID do objeto para
|
toObjectId | True | string |
O identificador de objeto To. |
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Da ID do objeto
|
fromObjectId | string |
O identificador de objeto From. |
|
Da ID do tipo de objeto
|
fromObjectTypeId | string |
O identificador de tipo de objeto From. |
|
Rótulos
|
labels | array of string |
Os rótulos. |
|
ID do objeto para
|
toObjectId | string |
O identificador de objeto To. |
|
ID do tipo to object
|
toObjectTypeId | string |
O identificador de tipo de objeto To. |
Criar um contato
Crie um contato com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um desconto
Crie um desconto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
|
|
nostrudcf
|
nostrudcf | string |
nostrudcf. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um destino de meta
Crie um destino de meta com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um envio de comentários
Crie um envio de comentários com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um imposto
Crie um imposto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um item de linha
Crie um item de linha com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um lote de aspas
Crie um lote de aspas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de contatos
Crie um lote de contatos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de descontos
Crie um lote de descontos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de destinos de meta
Crie um lote de destinos de meta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de empresas
Crie um lote de empresas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de envios de comentários
Crie um lote de envios de comentários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de impostos
Crie um lote de impostos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de itens de linha
Crie um lote de itens de linha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de objetos
Crie um lote de objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de ofertas
Crie um lote de ofertas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de produtos
Crie um lote de produtos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de taxas
Crie um lote de taxas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um lote de tíquetes
Crie um lote de tíquetes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Criar um novo cartão
Define um novo cartão que ficará ativo em uma conta quando este aplicativo for instalado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Aplicativo
|
appId | True | string |
O identificador do aplicativo. |
|
Base URLs
|
baseUrls | array of string |
Os endereços de URL base. |
|
|
Tipo de Dados
|
dataType | string |
O tipo de dados. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Propriedades a serem enviadas
|
propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
|
URL de Destino
|
targetUrl | string |
O endereço de URL de destino. |
|
|
Tipo de cartão
|
cardType | string |
O tipo de cartão. |
|
|
Função sem servidor
|
serverlessFunction | string |
A função sem servidor. |
|
|
Title
|
title | string |
O título. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
Os endereços de URL base. |
|
Histórico de auditoria
|
auditHistory | array of object | |
|
Tipo de ação
|
auditHistory.actionType | string |
O tipo de ação. |
|
ID do aplicativo
|
auditHistory.applicationId | string |
O identificador do aplicativo. |
|
Fonte de autorização
|
auditHistory.authSource | string |
A fonte de autorização. |
|
Alterado em
|
auditHistory.changedAt | string |
Quando alterado em. |
|
Iniciando a ID do Usuário
|
auditHistory.initiatingUserId | string |
O identificador de usuário iniciador. |
|
ID do tipo de objeto
|
auditHistory.objectTypeId | string |
O identificador de tipo de objeto. |
|
Propriedades
|
display.properties | array of object | |
|
Tipo de Dados
|
display.properties.dataType | string |
O tipo de dados. |
|
Etiqueta
|
display.properties.label | string |
O rótulo. |
|
Nome
|
display.properties.name | string |
O nome. |
|
Opções
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
O rótulo. |
|
Nome
|
display.properties.options.name | string |
O nome. |
|
Tipo
|
display.properties.options.type | string |
O tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nome
|
fetch.objectTypes.name | string |
O nome. |
|
Propriedades a serem enviadas
|
fetch.objectTypes.propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
URL de Destino
|
fetch.targetUrl | string |
O endereço de URL de destino. |
|
ID
|
id | string |
O identificador. |
|
Title
|
title | string |
O título. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
Criar um objeto
Crie um objeto CRM com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um produto
Crie um produto com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar um tíquete
Crie um tíquete com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar uma empresa
Crie uma empresa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar uma oferta
Crie um acordo com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Criar uma taxa
Crie uma taxa com as propriedades fornecidas e retorne uma cópia do objeto, incluindo o identificador.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Destinos de meta de pesquisa
Recupere uma lista de destinos de meta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Envios de comentários de pesquisa
Recupere uma lista de envios de comentários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Excluir associações
Exclui todas as associações entre dois registros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID do objeto para
|
toObjectId | True | string |
O identificador de objeto To. |
Retornos
- response
- string
Excluir associações em lotes
Associações de exclusão em lote para objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID
|
id | string |
O identificador. |
|
|
ID
|
id | string |
O identificador. |
Retornos
- response
- string
Excluir rótulos de associação específicos
Excluir rótulos de associação específicos para objetos em lote. Excluir uma associação sem rótulo também excluirá todas as associações rotuladas entre esses dois objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID
|
id | string |
O identificador. |
|
|
ID
|
id | string |
O identificador. |
|
|
Categoria de Associação
|
associationCategory | string |
A categoria de associação. |
|
|
ID do tipo de associação
|
associationTypeId | string |
O identificador de tipo de associação. |
Retornos
- response
- string
Excluir todos os registros de uma lista
Remova todos os registros de uma lista. Observação: a lista não é excluída. Esse ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
Retornos
- response
- string
Excluir um acordo para seguir o RGPD
Exclua permanentemente um acordo e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um cartão
Exclui permanentemente uma definição de cartão com o identificador especificado. Após a exclusão, as solicitações de busca de dados para esse cartão não serão mais enviadas ao seu serviço. Isso não pode ser desfeito.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Aplicativo
|
appId | True | string |
O identificador do aplicativo. |
|
ID do Cartão
|
cardId | True | string |
O identificador do cartão. |
Retornos
- response
- string
Excluir um contato para seguir o RGPD
Exclua permanentemente um contato e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um desconto para seguir o RGPD
Exclua permanentemente um desconto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um envio de comentários para seguir o RGPD
Exclua permanentemente um envio de comentários e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um imposto para seguir o RGPD
Exclua permanentemente um imposto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um item de linha para seguir o RGPD
Exclua permanentemente um item de linha e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um produto para seguir o RGPD
Exclua permanentemente um produto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um tipo de objeto para seguir o RGPD
Exclua permanentemente um tipo de objeto e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir um tíquete para seguir o RGPD
Exclua permanentemente um tíquete e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma cotação para seguir o RGPD
Exclua permanentemente uma cotação e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma empresa para seguir o RGPD
Exclua permanentemente uma empresa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma meta de destino para seguir o RGPD
Exclua permanentemente um destino de meta e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Excluir uma taxa para seguir o RGPD
Exclua permanentemente uma taxa e todo o conteúdo associado para seguir o RGPD. Use a propriedade opcional 'ID Property' definida como 'email' para identificar o contato por endereço de email. Se o endereço de email não for encontrado, o endereço de email será adicionado a uma lista de bloqueios e impedirá que ele seja usado no futuro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do objeto
|
objectId | string |
O identificador do objeto. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
- response
- string
Iniciar uma exportação
Começa a exportar dados crm para o portal, conforme especificado no corpo da solicitação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Exportação
|
exportName | string |
O nome da exportação. |
|
|
Tipo de Exportação
|
exportType | string |
O tipo de exportação. |
|
|
Formato
|
format | string |
O formato. |
|
|
Linguagem
|
language | string |
O idioma. |
|
|
Propriedades do objeto
|
objectProperties | array of string |
As propriedades do objeto. |
|
|
Tipo de objeto
|
objectType | string |
O objeto tyep. |
|
|
Tipo de objeto associado
|
associatedObjectType | string |
O tipo de objeto associado. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Query
|
query | string |
A consulta. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Iniciar uma nova importação
Começa a importar dados dos recursos de arquivo especificados. Isso carrega o arquivo correspondente e usa o objeto de solicitação de importação para converter linhas nos arquivos em objetos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
IDs de arquivo
|
metadata.fileIds | array of string |
Os identificadores de arquivo. |
|
Listas de objetos
|
metadata.objectLists | array of object | |
|
ID da lista
|
metadata.objectLists.listId | string |
O identificador de lista. |
|
Tipo de objeto
|
metadata.objectLists.objectType | string |
O tipo de objeto. |
|
Importação de Opt-Out
|
optOutImport | string |
A importação de recusa. |
|
Estado
|
state | string |
O estado. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
ID do Modelo
|
importTemplate.templateId | string |
O identificador de modelo. |
|
Tipo de modelo
|
importTemplate.templateType | string |
O tipo de modelo. |
|
Importar origem
|
importSource | string |
A fonte de importação. |
|
Nome de importação
|
importName | string |
O nome da importação. |
Itens de linha de pesquisa
Recupere uma lista de itens de linha.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Ler associações em lotes
Associações de leitura em lote para objetos a um tipo de objeto específico. O campo 'after' em um objeto de paginação retornado pode ser adicionado junto com a 'id' para recuperar a próxima página de associações desse objectidentifier. O campo 'link' foi preterido e deve ser ignorado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
|
ID
|
id | string |
O identificador. |
|
|
Após
|
after | string |
O link após. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
ID
|
results.from.id | string |
O identificador. |
|
Para
|
results.to | array of object | |
|
Tipos de associação
|
results.to.associationTypes | array of object | |
|
Categoria
|
results.to.associationTypes.category | string |
A categoria. |
|
ID do tipo
|
results.to.associationTypes.typeId | string |
O identificador de tipo. |
|
Etiqueta
|
results.to.associationTypes.label | string |
O rótulo. |
|
ID do objeto para
|
results.to.toObjectId | string |
O identificador de objeto To. |
|
Após
|
results.paging.next.after | string |
O link após. |
|
Link
|
results.paging.next.link | string |
O link. |
|
Antes
|
results.paging.prev.before | string |
O link anterior. |
|
Link
|
results.paging.prev.link | string |
O link. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Listar aspas
Recuperar uma página de aspas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Listar associações para um objeto
Lista todas as associações de um objeto por tipo de objeto. Limite de 500 por chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Tipos de associação
|
results.associationTypes | array of object | |
|
Categoria
|
results.associationTypes.category | string |
A categoria. |
|
ID do tipo
|
results.associationTypes.typeId | string |
O identificador de tipo. |
|
Etiqueta
|
results.associationTypes.label | string |
O rótulo. |
|
ID do objeto para
|
results.toObjectId | string |
O identificador de objeto To. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Listar descontos
Recupere uma página de descontos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Listar envios de comentários
Recupere uma página de envios de comentários. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Listar tipos de associação
Liste todos os tipos de associação válidos disponíveis entre dois tipos de objeto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Do tipo de objeto
|
fromObjectType | True | string |
O tipo de objeto From. |
|
Para tipo de objeto
|
toObjectType | True | string |
O tipo de objeto To. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
Nome
|
results.name | string |
O nome. |
Listas de pesquisa
Pesquise listas por nome de lista ou página em todas as listas fornecendo um valor vazio query .
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades adicionais
|
additionalProperties | array of string |
As propriedades adicionais. |
|
|
Offset
|
offset | string |
O deslocamento. |
|
|
Query
|
query | string |
A consulta. |
|
|
Contagem
|
count | string |
A contagem. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tem mais
|
hasMore | boolean |
Se tem mais. |
|
Lists
|
lists | array of object | |
|
ID da lista
|
lists.listId | string |
O identificador de lista. |
|
Versão da lista
|
lists.listVersion | string |
A versão da lista. |
|
Nome
|
lists.name | string |
O nome. |
|
ID do tipo de objeto
|
lists.objectTypeId | string |
O identificador de tipo de objeto. |
|
Status de processamento
|
lists.processingStatus | string |
O status de processamento. |
|
Tipo de processamento
|
lists.processingType | string |
O tipo de processamento. |
|
Atualizado por ID
|
lists.updatedById | string |
O identificador atualizado. |
|
Filtros atualizados em
|
lists.filtersUpdatedAt | string |
Quando os filtros foram atualizados. |
|
Criado em
|
lists.createdAt | string |
Quando criado em. |
|
Excluído em
|
lists.deletedAt | string |
Quando excluído em. |
|
Criado por ID
|
lists.createdById | string |
O criado pelo identificador. |
|
Atualizado em
|
lists.updatedAt | string |
Quando atualizado em. |
|
Offset
|
offset | string |
O deslocamento. |
|
Total
|
total | string |
O total. |
Mesclar dois contatos
Mesclar dois contatos com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois descontos
Mesclar dois descontos com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois destinos de meta
Mesclar dois destinos de meta com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois envios de comentários
Mesclar dois envios de comentários com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois impostos
Mesclar dois impostos com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois itens de linha
Mesclar dois itens de linha com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois objetos
Mesclar dois objetos com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois produtos
Mesclar dois produtos com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar dois tíquetes
Mesclar dois tíquetes com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas aspas
Mesclar duas aspas com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas empresas
Mesclar duas empresas com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas ofertas
Mesclar dois negócios com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Mesclar duas taxas
Mesclar duas taxas com o mesmo tipo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para mesclar
|
objectIdToMerge | string |
O identificador de objeto a ser mesclado. |
|
|
ID do objeto primário
|
primaryObjectId | string |
O identificador de objeto primário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter as informações sobre qualquer importação
Um resumo completo de um registro de importação, incluindo todas as atualizações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de importação
|
importId | True | string |
O identificador de importação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
IDs de arquivo
|
metadata.fileIds | array of string |
Os identificadores de arquivo. |
|
Listas de objetos
|
metadata.objectLists | array of object | |
|
ID da lista
|
metadata.objectLists.listId | string |
O identificador de lista. |
|
Tipo de objeto
|
metadata.objectLists.objectType | string |
O tipo de objeto. |
|
Importação de Opt-Out
|
optOutImport | string |
A importação de recusa. |
|
Estado
|
state | string |
O estado. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
ID do Modelo
|
importTemplate.templateId | string |
O identificador de modelo. |
|
Tipo de modelo
|
importTemplate.templateType | string |
O tipo de modelo. |
|
Importar origem
|
importSource | string |
A fonte de importação. |
|
Nome de importação
|
importName | string |
O nome da importação. |
Obter contatos
Recupere uma página de contatos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter destinos de meta
Recuperar uma página de destinos de meta. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter empresas
Recuperar uma página de empresas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter empresas por ID
Recupere um lote de empresas por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter erros de importação
Recupere uma lista de erros para uma importação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Limit
|
limit | string |
O limite. |
|
|
ID de importação
|
importId | True | string |
O identificador de importação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
Tipo de erro
|
results.errorType | string |
O tipo de erro. |
|
ID
|
results.id | string |
O identificador. |
|
ID de Arquivo
|
results.sourceData.fileId | string |
O identificador de arquivo. |
|
Número de Linha
|
results.sourceData.lineNumber | string |
O número da linha. |
|
Dados de linha
|
results.sourceData.rowData | array of string |
Os dados da linha. |
|
Nome da Página
|
results.sourceData.pageName | string |
O nome da página. |
|
Tipo de objeto
|
results.objectType | string |
O tipo de objeto. |
|
Valor inválido
|
results.invalidValue | string |
O valor inválido. |
|
Contexto Extra
|
results.extraContext | string |
O contexto extra. |
|
ID do tipo de objeto
|
results.objectTypeId | string |
O identificador de tipo de objeto. |
|
Número de coluna conhecido
|
results.knownColumnNumber | string |
O número de coluna conhecido. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
Obter importações ativas
Retorna uma lista paginada de importações ativas para essa conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
O depois. |
|
|
Antes
|
before | string |
O anterior. |
|
|
Limit
|
limit | string |
O limite. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
IDs de arquivo
|
results.metadata.fileIds | array of string |
Os identificadores de arquivo. |
|
Listas de objetos
|
results.metadata.objectLists | array of object | |
|
ID da lista
|
results.metadata.objectLists.listId | string |
O identificador de lista. |
|
Tipo de objeto
|
results.metadata.objectLists.objectType | string |
O tipo de objeto. |
|
Importação de Opt-Out
|
results.optOutImport | string |
A importação de recusa. |
|
Estado
|
results.state | string |
O estado. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
ID do Modelo
|
results.importTemplate.templateId | string |
O identificador de modelo. |
|
Tipo de modelo
|
results.importTemplate.templateType | string |
O tipo de modelo. |
|
Importar origem
|
results.importSource | string |
A fonte de importação. |
|
Nome de importação
|
results.importName | string |
O nome da importação. |
|
Após
|
paging.next.after | string |
O depois. |
|
Link
|
paging.next.link | string |
O link. |
|
Antes
|
paging.prev.before | string |
O anterior. |
|
Link
|
paging.prev.link | string |
O link. |
Obter impostos
Recuperar uma página de impostos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter item de linha
Recupere um objeto identificado por lineItemidentifier. lineItemId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do item de linha
|
lineItemId | True | string |
O identificador do item de linha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter itens de linha
Recuperar uma página de itens de linha. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter o status da ID da tarefa
Recupere o status de um identificador de tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Tarefa
|
taskId | True | string |
O identificador de tarefa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Resultado
|
result | string |
O resultado. |
|
Errors
|
numErrors | string |
O número de erros. |
|
Errors
|
errors | array of object | |
|
Categoria
|
errors.category | string |
A categoria. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
A mensagem. |
|
In
|
errors.errors.in | string |
A entrada. |
|
Code
|
errors.errors.code | string |
O código. |
|
Subcategoria
|
errors.errors.subCategory | string |
A subcategoria. |
|
Message
|
errors.message | string |
A mensagem. |
|
Situação
|
errors.status | string |
O status. |
|
ID
|
errors.id | string |
O identificador. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter objetos
Recuperar uma página de objetos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter ofertas
Recuperar uma página de ofertas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter produtos
Recuperar uma página de produtos. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter proprietários
Recupere uma lista de proprietários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
True | string |
O endereço de email. |
|
|
Após
|
after | string |
A página após. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Email
|
results.email | string |
O endereço de email. |
|
Primeiro Nome
|
results.firstName | string |
O nome. |
|
Apelido
|
results.lastName | string |
O sobrenome. |
|
ID do Usuário
|
results.userId | string |
O identificador do usuário. |
|
Equipes
|
results.teams | array of object | |
|
ID
|
results.teams.id | string |
O identificador. |
|
Nome
|
results.teams.name | string |
O nome. |
|
Primária
|
results.teams.primary | string |
O primário. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter resposta de detalhes do cartão de exemplo
Retorna uma resposta de detalhes de cartão de exemplo. Esse é o conteúdo com detalhes exibidos para um cartão que será mostrado a um usuário. Um aplicativo deve enviar isso em resposta à solicitação de busca de dados.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem total
|
totalCount | string |
A contagem total. |
|
URL de Link de Todos os Itens
|
allItemsLinkUrl | string |
O endereço de URL do link de todos os itens. |
|
Rótulo de Cartão
|
cardLabel | string |
O rótulo do cartão. |
|
Secundário
|
topLevelActions.secondary | array of object | |
|
Método HTTP
|
topLevelActions.secondary.httpMethod | string |
O método HTTP. |
|
Nomes de propriedade incluídos
|
topLevelActions.secondary.propertyNamesIncluded | array of string |
Os nomes de propriedade incluídos. |
|
Tipo
|
topLevelActions.secondary.type | string |
O tipo. |
|
URL
|
topLevelActions.secondary.url | string |
O endereço da URL. |
|
Cancelar Rótulo do Botão
|
topLevelActions.secondary.confirmation.cancelButtonLabel | string |
O rótulo do botão Cancelar. |
|
Confirmar rótulo de botão
|
topLevelActions.secondary.confirmation.confirmButtonLabel | string |
O rótulo do botão confirmar. |
|
Rápido
|
topLevelActions.secondary.confirmation.prompt | string |
O prompt. |
|
Etiqueta
|
topLevelActions.secondary.label | string |
O rótulo. |
|
Altura
|
topLevelActions.settings.height | string |
A altura. |
|
Nomes de propriedade incluídos
|
topLevelActions.settings.propertyNamesIncluded | array of string |
Os nomes de propriedade incluídos. |
|
Tipo
|
topLevelActions.settings.type | string |
O tipo. |
|
URL
|
topLevelActions.settings.url | string |
O endereço da URL. |
|
Largura
|
topLevelActions.settings.width | string |
A largura. |
|
Etiqueta
|
topLevelActions.settings.label | string |
O rótulo. |
|
Método HTTP
|
topLevelActions.primary.httpMethod | string |
O método HTTP. |
|
Nomes de propriedade incluídos
|
topLevelActions.primary.propertyNamesIncluded | array of string |
Os nomes de propriedade incluídos. |
|
Tipo
|
topLevelActions.primary.type | string |
O tipo. |
|
URL
|
topLevelActions.primary.url | string |
O endereço da URL. |
|
Cancelar Rótulo do Botão
|
topLevelActions.primary.confirmation.cancelButtonLabel | string |
O rótulo do botão Cancelar. |
|
Confirmar rótulo de botão
|
topLevelActions.primary.confirmation.confirmButtonLabel | string |
O rótulo do botão confirmar. |
|
Rápido
|
topLevelActions.primary.confirmation.prompt | string |
O prompt. |
|
Etiqueta
|
topLevelActions.primary.label | string |
O rótulo. |
|
Seções
|
sections | array of object | |
|
Ações
|
sections.actions | array of object | |
|
Método HTTP
|
sections.actions.httpMethod | string |
O método HTTP. |
|
Nomes de propriedade incluídos
|
sections.actions.propertyNamesIncluded | array of string |
Os nomes de propriedade incluídos. |
|
Tipo
|
sections.actions.type | string |
O tipo. |
|
URL
|
sections.actions.url | string |
O endereço da URL. |
|
Cancelar Rótulo do Botão
|
sections.actions.confirmation.cancelButtonLabel | string |
O rótulo do botão Cancelar. |
|
Confirmar rótulo de botão
|
sections.actions.confirmation.confirmButtonLabel | string |
O rótulo do botão confirmar. |
|
Rápido
|
sections.actions.confirmation.prompt | string |
O prompt. |
|
Etiqueta
|
sections.actions.label | string |
O rótulo. |
|
ID
|
sections.id | string |
O identificador. |
|
Title
|
sections.title | string |
O título. |
|
Tokens
|
sections.tokens | array of object | |
|
Value
|
sections.tokens.value | string |
O valor. |
|
Nome
|
sections.tokens.name | string |
O nome. |
|
Etiqueta
|
sections.tokens.label | string |
O rótulo. |
|
Tipo de Dados
|
sections.tokens.dataType | string |
O tipo de dados. |
|
Link URL
|
sections.linkUrl | string |
O endereço da URL do link. |
|
Versão de resposta
|
responseVersion | string |
A versão de resposta. |
Obter taxas
Recupere uma página de taxas. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
A página após. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter todos os cartões
Retorna uma lista de cartões para um determinado aplicativo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Aplicativo
|
appId | True | string |
O identificador do aplicativo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Base URLs
|
results.actions.baseUrls | array of string |
Os endereços de URL base. |
|
Histórico de auditoria
|
results.auditHistory | array of object | |
|
Tipo de ação
|
results.auditHistory.actionType | string |
O tipo de ação. |
|
ID do aplicativo
|
results.auditHistory.applicationId | string |
O identificador do aplicativo. |
|
Fonte de autenticação
|
results.auditHistory.authSource | string |
A fonte de autorização. |
|
Alterado em
|
results.auditHistory.changedAt | string |
Quando alterado em. |
|
Iniciando a ID do Usuário
|
results.auditHistory.initiatingUserId | string |
O identificador de usuário iniciador. |
|
ID do tipo de objeto
|
results.auditHistory.objectTypeId | string |
O identificador de tipo de objeto. |
|
Propriedades
|
results.display.properties | array of object | |
|
Tipo de Dados
|
results.display.properties.dataType | string |
O tipo de dados. |
|
Etiqueta
|
results.display.properties.label | string |
O rótulo. |
|
Nome
|
results.display.properties.name | string |
O nome. |
|
Opções
|
results.display.properties.options | array of object | |
|
Etiqueta
|
results.display.properties.options.label | string |
O rótulo. |
|
Nome
|
results.display.properties.options.name | string |
O nome. |
|
Tipo
|
results.display.properties.options.type | string |
O tipo. |
|
Tipos de objeto
|
results.fetch.objectTypes | array of object | |
|
Nome
|
results.fetch.objectTypes.name | string |
O nome. |
|
Propriedades a serem enviadas
|
results.fetch.objectTypes.propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
URL de Destino
|
results.fetch.targetUrl | string |
O endereço de URL de destino. |
|
ID
|
results.id | string |
O identificador. |
|
Title
|
results.title | string |
O título. |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
Obter tíquetes
Recupere uma página de tíquetes. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
O limite. |
|
|
Após
|
after | string |
O depois. |
|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Obter um acordo
Recupere um objeto identificado por dealidentifier. dealId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da oferta
|
dealId | True | string |
O identificador do negócio. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um cartão
Retorna a definição de um cartão com o identificador especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Aplicativo
|
appId | True | string |
O identificador do aplicativo. |
|
ID do Cartão
|
cardId | True | string |
O identificador do cartão. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Base URLs
|
actions.baseUrls | array of string |
Os endereços de URL base. |
|
Histórico de auditoria
|
auditHistory | array of object | |
|
Tipo de ação
|
auditHistory.actionType | string |
O tipo de ação. |
|
ID do aplicativo
|
auditHistory.applicationId | string |
O identificador do aplicativo. |
|
Fonte de autorização
|
auditHistory.authSource | string |
A fonte de autorização. |
|
Alterado em
|
auditHistory.changedAt | string |
Quando alterado em. |
|
Iniciando a ID do Usuário
|
auditHistory.initiatingUserId | string |
O identificador de usuário iniciador. |
|
ID do tipo de objeto
|
auditHistory.objectTypeId | string |
O identificador de tipo de objeto. |
|
Propriedades
|
display.properties | array of object | |
|
Tipo de Dados
|
display.properties.dataType | string |
O tipo de dados. |
|
Etiqueta
|
display.properties.label | string |
O rótulo. |
|
Nome
|
display.properties.name | string |
O nome. |
|
Opções
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
O rótulo. |
|
Nome
|
display.properties.options.name | string |
O nome. |
|
Tipo
|
display.properties.options.type | string |
O tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nome
|
fetch.objectTypes.name | string |
O nome. |
|
Propriedades a serem enviadas
|
fetch.objectTypes.propertiesToSend | array of string |
As propriedades a serem enviadas. |
|
URL de Destino
|
fetch.targetUrl | string |
O endereço de URL de destino. |
|
ID
|
id | string |
O identificador. |
|
Title
|
title | string |
O título. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
Obter um contato por ID
Recupere um objeto identificado por contactidentifier. contactId refere-se ao identificador de objeto interno. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID de contato
|
contactId | True | string |
O identificador de contato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
|
Results
|
associations.etc.results | array of object | |
|
ID
|
associations.etc.results.id | string |
O identificador. |
|
Tipo
|
associations.etc.results.type | string |
O tipo. |
|
Após
|
associations.etc.paging.next.after | string |
A página após. |
|
Link
|
associations.etc.paging.next.link | string |
A página de link. |
|
Antes
|
associations.etc.paging.prev.before | string |
A página anterior. |
|
Link
|
associations.etc.paging.prev.link | string |
A página de link. |
Obter um desconto
Recupere um objeto identificado por discountidentifier. discountId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Desconto
|
discountId | True | string |
O identificador do desconto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um destino de meta por ID
Recupere um objeto identificado por goalTargetidentifier. goalTargetId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de destino de meta
|
goalTargetId | True | string |
O identificador de destino de meta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um envio de comentários
Recupere um objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID de envio de comentários
|
feedbackSubmissionId | True | string |
O identificador de envio de comentários. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um imposto por ID
Recupere um objeto identificado pelo taxidentifier. taxId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
NIF
|
taxId | True | string |
O identificador de imposto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um lote de contatos por ID
Recupere um lote de contatos por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de cotações por ID
Recupere um lote de aspas por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de descontos por ID
Recupere um lote de descontos por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de destinos de meta por ID
Recupere um lote de destinos de meta por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de envios de comentários por ID
Recupere um lote de envios de comentários por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de impostos por ID
Recupere um lote de impostos por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de itens de linha por ID
Recupere um lote de itens de linha por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de objetos por ID
Recupere um lote de objetos por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de ofertas por ID
Recupere um lote de ofertas por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de produtos por ID
Recupere um lote de produtos por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de taxas por ID
Recupere um lote de taxas por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um lote de tíquetes por ID
Recupere um lote de tíquetes por identificador interno ou valores de propriedade exclusivos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID
|
id | string |
O identificador. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Propriedades com histórico
|
propertiesWithHistory | array of string |
As propriedades com objeto de histórico. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Concluído em
|
completedAt | string |
Quando concluído em. |
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Iniciado em
|
startedAt | string |
Quando começou. |
|
Situação
|
status | string |
O status. |
|
Solicitado em
|
requestedAt | string |
Quando solicitado em. |
Obter um objeto por ID
Recupere um objeto identificado por objectidentifier. objectId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
ID do objeto
|
objectId | True | string |
O identificador do objeto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um produto
Recupere um objeto identificado pelo productidentifier. productId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do Produto
|
productId | True | string |
O identificador do produto. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter um proprietário por ID
Recupere um proprietário por determinado identificador ou useridentifier.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
ID do Proprietário
|
ownerId | True | string |
O identificador do proprietário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Email
|
string |
O endereço de email. |
|
|
Primeiro Nome
|
firstName | string |
O nome. |
|
Apelido
|
lastName | string |
O sobrenome. |
|
ID do Usuário
|
userId | string |
O identificador do usuário. |
|
Equipes
|
teams | array of object | |
|
ID
|
teams.id | string |
O identificador. |
|
Nome
|
teams.name | string |
O nome. |
|
Primária
|
teams.primary | string |
O primário. |
Obter um tíquete
Recupere um objeto identificado por ticketidentifier. ticketId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID do tíquete
|
ticketId | True | string |
O identificador do tíquete. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter uma cotação por ID
Recupere um objeto identificado por quoteidentifier. quoteId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da cotação
|
quoteId | True | string |
O identificador de aspas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter uma empresa por ID
Recupere um objeto identificado por companyidentifier. companyId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da Empresa
|
companyId | True | string |
O identificador da empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Obter uma taxa por ID
Recupere um objeto identificado por feeidentifier. feeId refere-se ao identificador de objeto interno por padrão ou, opcionalmente, a qualquer valor de propriedade exclusivo, conforme especificado pelo parâmetro de consulta idProperty. Controlar o que é retornado por meio do parâmetro de consulta de propriedades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Propriedades
|
properties | string |
As propriedades. |
|
|
Propriedades com Histórico
|
propertiesWithHistory | string |
As propriedades com histórico. |
|
|
Associations
|
associations | string |
As associações. |
|
|
Arquivados
|
archived | boolean |
Se deve retornar apenas os resultados que foram arquivados. |
|
|
Propriedade ID
|
idProperty | string |
A propriedade do identificador. |
|
|
ID da taxa
|
feeId | True | string |
O identificador de taxa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
id | string |
O identificador. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
archived | boolean |
Se arquivado. |
|
Arquivado em
|
archivedAt | string |
Quando arquivado em. |
Pesquisar contatos
Recupere uma lista de contatos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar descontos
Recupere uma lista de descontos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar empresas
Recuperar uma lista de empresas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar impostos
Recupere uma lista de impostos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar ofertas
Recupere uma lista de ofertas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar por tipo de objeto
Recupere uma lista de objetos por tipo de objeto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
O tipo de objeto. |
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar produtos
Recupere uma lista de produtos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar taxas
Recupere uma lista de taxas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Pesquisar tíquetes
Recupere uma lista de tíquetes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Após
|
after | string |
A página após. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Nome da propriedade
|
propertyName | string |
O nome da propriedade. |
|
|
Value
|
value | string |
O valor. |
|
|
Valor alto
|
highValue | string |
O valor alto. |
|
|
Valores
|
values | array of string |
Os valores. |
|
|
Limit
|
limit | string |
O limite. |
|
|
Propriedades
|
properties | array of string |
O objeto properties. |
|
|
Tipo
|
sorts | array of string |
A classificação. |
|
|
Query
|
query | string |
A consulta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Criado em
|
results.createdAt | string |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Atualizado em
|
results.updatedAt | string |
Quando atualizado em. |
|
Arquivados
|
results.archived | boolean |
Se arquivado. |
|
Arquivado em
|
results.archivedAt | string |
Quando arquivado em. |
|
Total
|
total | string |
O total. |
|
Após
|
paging.next.after | string |
A página após. |
|
Link
|
paging.next.link | string |
O link. |
Remover registros de uma lista
Remova os registros fornecidos da lista. Os registros que não existem ou que não são membros da lista são ignorados. Esse ponto de extremidade só funciona para listas que têm um processingType de MANUAL ou SNAPSHOT.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
listId | True | string |
O identificador de lista. |
|
body
|
body | True | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
IDs de registro ausentes
|
recordIdsMissing | array of string |
Os identificadores de registro ausentes. |
|
IDs de registro removidas
|
recordIdsRemoved | array of string |
Os identificadores de registro removidos. |
|
IDs de registro adicionadas
|
recordsIdsAdded | array of string |
Os identificadores de registro adicionados. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.