Mercos
Integração com a API Mercos para gestão de produtos, clientes, pedidos, tabelas de preço, financeiro, CRM e recebimento de webhooks.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 158 actions:
| Action | Purpose | Parameters |
|---|---|---|
| produtos/get_v1_produtos | Retorna a lista de produtos cadastrados. Utilize o parâmetro alterado_apos para filtrar apenas os registros alterados após uma determinada data. | alterado_apos (string) |
| produtos/post_v1_produtos | Cria um novo produto. Um produto simples NÃO envia o campo produtos_grade; um produto grade v3 envia o campo produtos_grade. | data required |
| produtos/get_v1_produtos_by_id | Retorna os dados de um produto específico pelo seu identificador. | id (string) |
| produtos/put_v1_produtos_by_id | Atualiza um produto existente. Para requisições PUT, envie apenas os campos que deseja alterar. Para produto grade v3, o ID informado na URL é o do produto agregador. | id (string) data required |
| produtos/get_v1_variacoes | Retorna a lista de todas as variações cadastradas, com seus itens de variação associados. Use alterado_apos para filtrar por data. | alterado_apos (string) |
| produtos/post_v1_variacoes | Cria uma nova variação, opcionalmente já com itens de variação associados. | data: { . nome (string) . ordem (integer) . itens_variacao (array) } (object) required |
| produtos/get_v1_variacoes_by_id | Retorna os dados de uma variação específica com seus itens de variação. | id (string) |
| produtos/put_v1_variacoes_by_id | Atualiza uma variação existente. Permite também inserir e/ou alterar itens de variação da mesma. Não é possível trocar o nome de um item de variação, nem excluir uma variação/item associado a algum produto. | id (string) data: { . nome (string) . ordem (integer) . excluido (boolean) . itens_variacao (array) } (object) required |
| produtos/get_v1_imagens_produto | Retorna a lista de todos os produtos que possuem imagens cadastradas, com os respectivos hashes SHA-512 de cada imagem. Apenas imagens ativas não excluídas são retornadas. Utilize este endpoint para identificar quais imagens já foram cadastradas e evitar envios duplicados. | No parameters |
| produtos/post_v1_imagens_produto | Adiciona uma imagem ao produto específico. É possível escolher entre duas formas de envio, URL da imagem ou a imagem convertida em Base64. Caso os dois parâmetros sejam informados, o sistema irá considerar apenas a URL da imagem. Formatos aceitos: .jpeg, .jpg e .png. | data: { . produto_id (integer) . ordem (integer) . imagem_url (string) . imagem_base64 (string) } (object) required |
| produtos/get_v1_imagens_produto_by_produto_id | Retorna os hashes SHA-512 das imagens cadastradas para um produto específico. Apenas imagens ativas não excluídas são retornadas. | produto_id (string) |
| produtos/put_v1_ajustar_estoque | Altera o saldo de estoque de um produto por vez. Só é possível o ajuste de estoque em produtos simples e itens de grade. Caso o método seja executado para um produto do tipo agregador, um erro será retornado. | data: { . produto_id (integer) . novo_saldo (number) } (object) required |
| produtos/post_v1_ajustar_estoque_em_lote | Altera o saldo de estoque de múltiplos produtos em uma única requisição. Limite de 300 ajustes por requisição. Só é possível o ajuste de estoque em produtos simples e produtos grade; para produto agregador, um erro será retornado. Caso aconteça algum erro, todos os envios serão cancelados e nenhum produto terá o estoque ajustado. | data (array) required |
| produtos/get_v1_categorias | Retorna a lista de categorias cadastradas. Utilize alterado_apos para filtrar por data. | alterado_apos (string) |
| produtos/post_v1_categorias | Cria uma nova categoria. As categorias podem formar hierarquia de até 3 níveis; uma categoria não pode ter o mesmo nome de uma categoria irmã. | data: { . nome (string) . categoria_pai_id (integer) . excluido (boolean) } (object) required |
| produtos/get_v1_categorias_by_id | Retorna os dados de uma categoria específica pelo seu identificador. | id (string) |
| produtos/put_v1_categorias_by_id | Atualiza uma categoria existente. Só é permitido alterar o seu nome ou excluí-la. | id (string) data: { . nome (string) . categoria_pai_id (integer) . excluido (boolean) } (object) required |
| produtos/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| clientes/post_v1_clientes_categorias | Define uma ou mais categorias que serão exibidas para um determinado cliente. Ao definir categorias para um cliente em específico, as demais categorias não estarão disponíveis para clientes que tiverem registros desta configuração. | data: { . cliente_id (integer) . categorias_liberadas (array) } (object) required |
| clientes/post_v1_clientes_categorias_liberar_todas | Libera todas as categorias para o cliente informado. | data: { . cliente_id (integer) } (object) required |
| clientes/get_v1_clientes | Retorna todos os clientes cadastrados. Aceita filtros por alterado_apos e excluido. | alterado_apos (string) excluido (string) |
| clientes/post_v1_clientes | Cria um novo cliente. Os campos obrigatórios por padrão são: razao_social e tipo. | data: { . razao_social (string) . nome_fantasia (string) . tipo (string) . cnpj (string) . inscricao_estadual (string) . suframa (string) . rua (string) . numero (string) . complemento (string) . cep (string) . bairro (string) . cidade (string) . estado (string) . observacao (string) . emails (array) . telefones (array) . contatos (array) . nome_excecao_fiscal (string) . segmento_id (integer) . rede_id (integer) . bloqueado_b2b (boolean) . bloqueado (boolean) . motivo_bloqueio_id (integer) . enderecos_adicionais (array) . limite_credito_disponivel (number) . limite_credito_total (number) . excluido (boolean) . extras (array) } (object) required |
| clientes/get_v1_clientes_by_id | Retorna os dados de um cliente específico pelo seu ID. | id (integer) |
| clientes/put_v1_clientes_by_id | Altera os dados de um cliente existente. Para telefone, email e enderecos_adicionais, caso não sejam referenciados os ids, o sistema Mercos respeitará sempre as informações dos registros mencionados no JSON. Para contatos, a exclusão é feita através do campo excluido. | id (integer) data: { . razao_social (string) . nome_fantasia (string) . tipo (string) . cnpj (string) . inscricao_estadual (string) . suframa (string) . rua (string) . numero (string) . complemento (string) . cep (string) . bairro (string) . cidade (string) . estado (string) . observacao (string) . emails (array) . telefones (array) . contatos (array) . nome_excecao_fiscal (string) . segmento_id (integer) . rede_id (integer) . bloqueado_b2b (boolean) . bloqueado (boolean) . motivo_bloqueio_id (integer) . enderecos_adicionais (array) . limite_credito_disponivel (number) . limite_credito_total (number) . excluido (boolean) . extras (array) } (object) required |
| clientes/get_v1_motivo_de_bloqueio_de_cliente | Retorna todos os motivos de bloqueio cadastrados. O limite máximo é 200. | alterado_apos (string) |
| clientes/post_v1_motivo_de_bloqueio_de_cliente | Cria um novo motivo de bloqueio. | data: { . motivo (string) . excluido (boolean) } (object) required |
| clientes/get_v1_motivo_de_bloqueio_de_cliente_by_motivo_id | Retorna um motivo de bloqueio específico pelo seu ID. | motivo_id (integer) |
| clientes/put_v1_motivo_de_bloqueio_de_cliente_by_motivo_id | Altera um motivo de bloqueio existente. | motivo_id (integer) data: { . motivo (string) . excluido (boolean) } (object) required |
| clientes/get_v1_redes | Retorna todas as redes cadastradas. | alterado_apos (string) |
| clientes/post_v1_redes | Cria uma nova rede. | data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/get_v1_redes_by_id | Retorna uma rede específica pelo seu ID. | id (integer) |
| clientes/put_v1_redes_by_id | Altera uma rede existente. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/get_v1_segmentos | Retorna todos os segmentos de clientes cadastrados. | alterado_apos (string) |
| clientes/post_v1_segmentos | Cria um novo segmento. | data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/get_v1_segmentos_by_id | Retorna um segmento específico pelo seu ID. | id (integer) |
| clientes/put_v1_segmentos_by_id | Altera um segmento existente. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/get_v1_tags_de_clientes | Retorna todas as tags de clientes cadastradas. O limite máximo é 200. | alterado_apos (string) |
| clientes/post_v1_tags_de_clientes | Cria uma nova tag de cliente. | data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/get_v1_tags_de_clientes_by_tag_id | Retorna uma tag específica pelo seu ID. | tag_id (integer) |
| clientes/put_v1_tags_de_clientes_by_tag_id | Altera uma tag de cliente existente. | tag_id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| clientes/post_v1_vincular_tags_a_clientes | Vincula tags à clientes. As tags enviadas substituirão as tags existentes nos clientes informados. Se desejar remover todas as tags de um ou vários clientes, basta enviar a lista de tags ids vazia. | data: { . clientes_ids (array) . tags_ids (array) } (object) required |
| clientes/get_v1_campos_extras_cliente | Retorna todos os campos extras cadastrados para clientes. | alterado_apos (string) |
| clientes/post_v1_campos_extras_cliente | Cria um novo campo extra para clientes. | data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_no_b2b (boolean) . excluido (boolean) . lista_multipla (boolean) . informacoes_adicionais (string) . itens (array) } (object) required |
| clientes/put_v1_campos_extras_cliente_by_id | Altera um campo extra do cliente existente. | id (integer) data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_no_b2b (boolean) . excluido (boolean) . lista_multipla (boolean) . informacoes_adicionais (string) . itens (array) } (object) required |
| clientes/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| tabelas_preco/get_v1_tabelas_preco | Retorna todas as tabelas de preço cadastradas. Aceita o parâmetro opcional alterado_apos para filtrar por data de alteração. | alterado_apos (string) |
| tabelas_preco/post_v1_tabelas_preco | Cria uma nova tabela de preço. O tipo da tabela não pode ser alterado após a criação. | data: { . nome (string) . tipo (string) . acrescimo (number) . desconto (number) . excluido (boolean) } (object) required |
| tabelas_preco/get_v1_tabelas_preco_by_id | Retorna uma tabela de preço específica a partir do seu ID. | id (integer) |
| tabelas_preco/put_v1_tabelas_preco_by_id | Altera uma tabela de preço existente. O tipo da tabela não pode ser alterado. | id (integer) data: { . nome (string) . tipo (string) . acrescimo (number) . desconto (number) . excluido (boolean) } (object) required |
| tabelas_preco/get_v1_produtos_tabela_preco | Retorna todos os vínculos de produtos com tabelas de preço. Aceita o parâmetro opcional alterado_apos para filtrar por data de alteração. | alterado_apos (string) |
| tabelas_preco/post_v1_produtos_tabela_preco | Cria um novo vínculo entre um produto e uma tabela de preço. | data: { . preco (number) . tabela_id (integer) . produto_id (integer) } (object) required |
| tabelas_preco/get_v1_produtos_tabela_preco_by_id | Retorna um vínculo específico entre produto e tabela de preço a partir do seu ID. | id (integer) |
| tabelas_preco/put_v1_produtos_tabela_preco_by_id | Altera um vínculo existente entre produto e tabela de preço. Não é possível excluir um vínculo via PUT com o campo excluido = 1. Para obter o mesmo comportamento da exclusão, envie o campo preco = 0. | id (integer) data: { . preco (number) . tabela_id (integer) . produto_id (integer) } (object) required |
| tabelas_preco/post_v1_produtos_tabela_preco_em_lote | Permite associar, alterar ou excluir múltiplos vínculos entre produtos e tabelas de preço em uma única requisição. A quantidade máxima é de 300 registros por requisição. Caso ocorra algum erro, todos os envios serão cancelados. Apenas tabelas do tipo Livre podem ser vinculadas. Para alterar a tabela de preço padrão do produto, utilize o valor 0 para o campo tabela_id. | data (array) required |
| tabelas_preco/post_v1_clientes_tabela_preco | Vincula um cliente a uma ou mais tabelas de preço. As demais tabelas não estarão disponíveis para clientes que tiverem registros desta configuração. Ao liberar uma, restringe automaticamente as outras. | data: { . cliente_id (integer) . tabelas_liberadas (array) } (object) required |
| tabelas_preco/post_v1_clientes_tabela_preco_liberar_todas | Libera todas as tabelas de preço para o cliente informado, removendo restrições prévias. | data: { . cliente_id (integer) } (object) required |
| tabelas_preco/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| financeiro/get_v1_titulos | Retorna a lista de títulos cadastrados. Suporta filtro por data da última alteração. | alterado_apos (string) |
| financeiro/post_v1_titulos | Cria um novo título para um cliente. Caso sejam enviados link_pdf e arquivo_pdf, apenas link_pdf será considerado. | data: { . numero_documento (string) . valor (number) . numero_parcela (integer) . data_vencimento (string) . data_pagamento (string) . observacao (string) . cliente_id (integer) . pedido_id (integer) . link_pdf (string) . arquivo_pdf (string) . excluido (boolean) } (object) required |
| financeiro/put_v1_titulos | Atualiza um título sem informar o ID na URL, buscando-o pelos campos cliente_id e numero_documento enviados no corpo da requisição. | data: { . numero_documento (string) . valor (number) . numero_parcela (integer) . data_vencimento (string) . data_pagamento (string) . observacao (string) . cliente_id (integer) . pedido_id (integer) . link_pdf (string) . arquivo_pdf (string) . excluido (boolean) } (object) required |
| financeiro/get_v1_titulos_by_id | Retorna os detalhes de um título específico pelo seu ID. | id (string) |
| financeiro/put_v1_titulos_by_id | Atualiza os dados de um título existente pelo ID informado na URL. | id (string) data: { . numero_documento (string) . valor (number) . numero_parcela (integer) . data_vencimento (string) . data_pagamento (string) . observacao (string) . cliente_id (integer) . pedido_id (integer) . link_pdf (string) . arquivo_pdf (string) . excluido (boolean) } (object) required |
| financeiro/get_v2_nota_fiscal | Retorna a lista de notas fiscais cadastradas. Suporta filtro por data da última alteração. | alterado_apos (string) |
| financeiro/post_v2_nota_fiscal | Cria uma nova nota fiscal. Deve ser enviado como multipart/form-data. É obrigatório o envio do XML via arquivo_xml ou link_xml. Arquivos podem ter até 5MB cada. | No parameters |
| financeiro/get_v2_nota_fiscal_by_id | Retorna os detalhes de uma nota fiscal específica pelo seu ID. | id (string) |
| financeiro/put_v2_nota_fiscal_by_id | Atualiza uma nota fiscal existente. Deve ser enviado como multipart/form-data informando o ID na URL. | id (string) |
| financeiro/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| pedidos/get_v2_pedidos | Lista os pedidos e orçamentos cadastrados. Suporta filtros por status 0=Cancelado, 1=Orçamento, 2=Pedido, status_faturamento, status_custom e paginação via registros_por_pagina. | alterado_apos (string) status (string) status_faturamento (integer) status_custom (array) registros_por_pagina (integer) |
| pedidos/post_v2_pedidos | Cria um novo pedido. Os campos obrigatórios devem ser informados. Para pedidos com produtos de grade, utilize o endpoint dedicado. | data: { . cliente_id (integer) . data_emissao (string) . contato_id (integer) . transportadora_id (integer) . condicao_pagamento_id (integer) . condicao_pagamento (string) . tipo_pedido_id (integer) . forma_pagamento_id (integer) . endereco_entrega_id (integer) . observacoes (string) . extras (array) . itens (array) . data_criacao (string) . rastreamento (string) . valor_frete (number) . criador_id (integer) } (object) required |
| pedidos/post_v2_pedidos_grade | Cria um pedido com produtos do tipo grade v3. Ao enviar produtos de grade, é obrigatório informar o campo grupo_grades UUID para agrupar itens do mesmo produto. | data: { . cliente_id (integer) . data_emissao (string) . contato_id (integer) . transportadora_id (integer) . condicao_pagamento_id (integer) . condicao_pagamento (string) . tipo_pedido_id (integer) . forma_pagamento_id (integer) . endereco_entrega_id (integer) . observacoes (string) . extras (array) . itens (array) . data_criacao (string) . rastreamento (string) . valor_frete (number) . criador_id (integer) } (object) required |
| pedidos/get_v2_pedidos_by_id | Retorna os detalhes de um pedido pelo seu ID no sistema Mercos. | id (integer) |
| pedidos/put_v2_pedidos_by_id | Atualiza um pedido existente. Envie apenas os campos que deseja alterar. Para excluir itens, envie excluido: true no item correspondente. | id (integer) data: { . cliente_id (integer) . data_emissao (string) . contato_id (integer) . transportadora_id (integer) . condicao_pagamento_id (integer) . condicao_pagamento (string) . tipo_pedido_id (integer) . forma_pagamento_id (integer) . endereco_entrega_id (integer) . observacoes (string) . extras (array) . itens (array) . data_criacao (string) . rastreamento (string) . valor_frete (number) . criador_id (integer) } (object) required |
| pedidos/get_v1_pedidos_tipo | Lista os tipos de pedido cadastrados ex.: Vendas, Bonificado, Consignação. | alterado_apos (string) |
| pedidos/post_v1_pedidos_tipo | Cria um novo tipo de pedido no sistema Mercos. | data: { . nome (string) . excluido (boolean) } (object) required |
| pedidos/get_v1_pedidos_tipo_by_id | Retorna um tipo de pedido pelo seu ID. | id (integer) |
| pedidos/put_v1_pedidos_tipo_by_id | Atualiza um tipo de pedido existente. Envie apenas os campos que deseja alterar. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| pedidos/get_v1_campos_extras | Lista os campos extras cadastrados para pedidos no Mercos. | alterado_apos (string) |
| pedidos/post_v1_campos_extras | Cria um novo campo extra Texto livre, Data, Numérico, Hora ou Lista. Para campos do tipo Lista utilize o endpoint específico ou envie a chave itens. | data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_para_cliente (boolean) . excluido (boolean) . lista_multipla (boolean) . itens (array) } (object) required |
| pedidos/get_v1_campos_extras_by_id | Retorna um campo extra pelo seu ID. | id (integer) |
| pedidos/put_v1_campos_extras_by_id | Atualiza um campo extra existente. Para campos do tipo Lista utilize também a chave itens novos itens são criados quando não possuem id. | id (integer) data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_para_cliente (boolean) . excluido (boolean) . lista_multipla (boolean) . itens (array) } (object) required |
| pedidos/post_v1_campos_extras_lista | Alias documental para criação de campo extra do tipo Lista. O cadastro respeita a ordem dos itens enviados; máximo 100 itens. | data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_para_cliente (boolean) . excluido (boolean) . lista_multipla (boolean) . itens (array) } (object) required |
| pedidos/put_v1_campos_extras_lista_by_id | Alias documental para alteração de campo extra do tipo Lista. Itens sem id são criados, itens com id são atualizados; a ordem enviada é respeitada no retorno. | id (integer) data: { . tipo (string) . nome (string) . obrigatorio (boolean) . casas_decimais (integer) . formato (string) . exibir_para_cliente (boolean) . excluido (boolean) . lista_multipla (boolean) . itens (array) } (object) required |
| pedidos/get_v1_pedidos_status | Lista os status de pedido customizados cadastrados na conta. | alterado_apos (string) |
| pedidos/post_v1_pedidos_status | Cria um novo status de pedido customizado. | data: { . nome (string) . excluido (boolean) } (object) required |
| pedidos/get_v1_pedidos_status_by_id | Retorna um status de pedido customizado pelo seu ID. | id (integer) |
| pedidos/put_v1_pedidos_status_by_id | Atualiza um status de pedido customizado existente. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| pedidos/post_v1_pedidos_by_id_status | Aplica um status customizado a um pedido específico, opcionalmente com uma anotação. | id (integer) data: { . status_id (integer) . anotacao (string) } (object) required |
| pedidos/get_v1_pedidos_by_id_status | Retorna o histórico de mudanças de status customizados aplicados a um pedido. | id (integer) |
| pedidos/post_v1_pedidos_cancelar_by_id | Cancela um pedido cadastrado no Mercos, tornando-o inativo. Um pedido cancelado não pode ser reativado. | id (integer) |
| pedidos/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| pagamentos/post_v1_faturamento | Registra o faturamento de um pedido, gerando a comissão correspondente aos vendedores vinculados. | data: { . pedido_id (integer) . valor_faturado (number) . data_faturamento (string) . numero_nf (string) . informacoes_adicionais (string) . excluido (boolean) } (object) required |
| pagamentos/put_v1_faturamento_by_id | Altera um faturamento existente. Para cancelar, envie o campo excluido = true. | id (integer) data: { . pedido_id (integer) . valor_faturado (number) . data_faturamento (string) . numero_nf (string) . informacoes_adicionais (string) . excluido (boolean) } (object) required |
| pagamentos/get_v1_formas_pagamento | Retorna a lista de formas de pagamento cadastradas no Mercos. | alterado_apos (string) |
| pagamentos/post_v1_formas_pagamento | Cria uma nova forma de pagamento no Mercos. | data: { . nome (string) . excluido (boolean) } (object) required |
| pagamentos/get_v1_formas_pagamento_by_id | Retorna os dados de uma forma de pagamento específica. | id (integer) |
| pagamentos/put_v1_formas_pagamento_by_id | Atualiza uma forma de pagamento existente. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| pagamentos/get_v1_condicoes_pagamento | Retorna a lista de condições de pagamento cadastradas no Mercos. | alterado_apos (string) |
| pagamentos/post_v1_condicoes_pagamento | Cria uma nova condição de pagamento no Mercos. | data: { . nome (string) . valor_minimo (number) . disponivel_b2b (boolean) . considerar_limite_credito (boolean) . excluido (boolean) } (object) required |
| pagamentos/get_v1_condicoes_pagamento_by_id | Retorna os dados de uma condição de pagamento específica. | id (integer) |
| pagamentos/put_v1_condicoes_pagamento_by_id | Atualiza uma condição de pagamento existente. | id (integer) data: { . nome (string) . valor_minimo (number) . disponivel_b2b (boolean) . considerar_limite_credito (boolean) . excluido (boolean) } (object) required |
| pagamentos/post_v1_clientes_condicoes_pagamento | Define quais condições de pagamento estarão disponíveis para um cliente específico. Não permite alterações parciais: é necessário reenviar a lista completa de vínculos desejados. | data: { . cliente_id (integer) . condicoes_pagamento_liberadas (array) } (object) required |
| pagamentos/post_v1_clientes_condicoes_pagamento_liberar_todas | Libera todas as condições de pagamento para o cliente informado, removendo restrições. | data: { . cliente_id (integer) } (object) required |
| pagamentos/get_v1_transportadoras | Retorna a lista de transportadoras cadastradas no Mercos. | alterado_apos (string) |
| pagamentos/post_v1_transportadoras | Cria uma nova transportadora no Mercos. | data: { . nome (string) . cidade (string) . estado (string) . informacoes_adicionais (string) . telefones (array) . excluido (boolean) } (object) required |
| pagamentos/get_v1_transportadoras_by_id | Retorna os dados de uma transportadora específica. | id (integer) |
| pagamentos/put_v1_transportadoras_by_id | Atualiza os dados de uma transportadora existente. | id (integer) data: { . nome (string) . cidade (string) . estado (string) . informacoes_adicionais (string) . telefones (array) . excluido (boolean) } (object) required |
| pagamentos/get_v1_configuracoes_icms_st | Retorna a lista de configurações de ICMS-ST cadastradas no Mercos. | alterado_apos (string) |
| pagamentos/post_v1_configuracoes_icms_st | Cria uma nova configuração de ICMS-ST. Não há suporte a atualizações via PUT; para alterar, exclua e crie novamente. | data: { . codigo_ncm (string) . nome_excecao_fiscal (string) . estado_destino (string) . tipo_st (string) . valor_mva (number) . valor_pmc (number) . icms_credito (number) . icms_destino (number) . preco_considerado_no_calculo (string) . reducao_de_base (number) } (object) required |
| pagamentos/get_v1_configuracoes_icms_st_by_id | Retorna os dados de uma configuração de ICMS-ST específica. | id (integer) |
| pagamentos/delete_v1_configuracoes_icms_st_by_id | Remove a configuração de ICMS-ST informada. | id (integer) |
| pagamentos/get_v1_pagamentos | Consulta os detalhes e o status de todas as solicitações de pagamento geradas e processadas pela plataforma Mercos MercosPay. | alterado_apos (string) pedido_id (integer) forma_de_pagamento (string) |
| pagamentos/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| comercial/get_v1_promocoes | Retorna a lista de promoções cadastradas. Utilize o filtro alterado_apos para obter apenas registros alterados após determinada data. | alterado_apos (string) |
| comercial/post_v1_promocoes | Cria uma nova promoção. Ao alterar posteriormente, em algumas situações pode ser retornado um novo ID: mantenha-o atualizado no ERP. | data: { . representada_id (integer) . nome (string) . slug (string) . data_inicial (string) . data_final (string) . excluido (boolean) . regras (array) } (object) required |
| comercial/get_v1_promocoes_by_id | Retorna os dados de uma promoção específica. | id (integer) |
| comercial/put_v1_promocoes_by_id | Altera os dados de uma promoção. Em algumas situações pode ser retornado um novo ID: atualize-o no ERP. | id (integer) data: { . representada_id (integer) . nome (string) . slug (string) . data_inicial (string) . data_final (string) . excluido (boolean) . regras (array) } (object) required |
| comercial/get_v1_politicas_comerciais | Retorna a lista de políticas comerciais cadastradas. Utilize o filtro alterado_apos para restringir por data de alteração. | alterado_apos (string) |
| comercial/get_v1_politicas_comerciais_by_id | Retorna os dados de uma política comercial específica. | id (integer) |
| comercial/get_v1_saldo_flex | Retorna a lista de contas correntes do Saldo Flex, com saldo atual por colaborador. | alterado_apos (string) |
| comercial/post_v1_saldo_flex | Cria um lançamento na conta corrente do colaborador. Envie valores positivos para creditar e negativos para debitar. | data: { . colaborador_id (integer) . valor_movimentado (number) . observacao (string) } (object) required |
| comercial/get_v1_metas | Retorna as metas cadastradas. Todos os filtros são opcionais e podem ser combinados. | mes (integer) ano (integer) colaborador_id (integer) |
| comercial/post_v1_metas | Cadastra uma ou mais metas. Se já existir uma meta para a mesma combinação de representada, colaborador, mês e ano, o lote é rejeitado. | data (array) required |
| comercial/put_v1_metas | Atualiza uma ou mais metas. Se não existir uma meta para a combinação informada, ela será criada. | data (array) required |
| comercial/get_v1_comissoes | Retorna as comissões cadastradas. Todos os filtros são opcionais e podem ser combinados. Registros excluídos são omitidos. | colaborador_id (integer) pedido_id (integer) |
| comercial/post_v1_comissoes | Cadastra uma ou mais comissões. Todo o lote é rejeitado caso qualquer item falhe na validação. | data (array) required |
| comercial/get_v1_comissoes_by_id | Retorna os dados de uma comissão específica pelo seu ID no Mercos. | id (integer) |
| comercial/put_v1_comissoes_by_id | Atualiza dados de uma comissão. Aceita atualização parcial: envie apenas os campos que deseja alterar. Para excluir, envie 'excluido': true. | id (integer) data: { . codigo_comissao_integracao (string) . status (integer) . colaborador_id (integer) . pedido_id (integer) . representada_id (integer) . cliente_id (integer) . data_competencia (string) . data_pagamento (string) . valor_bruto_pedido (number) . valor_descontos (number) . valor_base (number) . percentual_comissao (number) . valor_comissao (number) . observacao (string) . excluido (boolean) } (object) required |
| comercial/get_v1_comissoes_integracao_by_codigo_comissao_integracao | Retorna os dados de uma comissão específica pelo seu codigo_comissao_integracao. | codigo_comissao_integracao (string) |
| comercial/put_v1_comissoes_integracao_by_codigo_comissao_integracao | Atualiza dados de uma comissão identificada pelo código do integrador. Aceita atualização parcial: envie apenas os campos que deseja alterar. Para excluir, envie 'excluido': true. | codigo_comissao_integracao (string) data: { . codigo_comissao_integracao (string) . status (integer) . colaborador_id (integer) . pedido_id (integer) . representada_id (integer) . cliente_id (integer) . data_competencia (string) . data_pagamento (string) . valor_bruto_pedido (number) . valor_descontos (number) . valor_base (number) . percentual_comissao (number) . valor_comissao (number) . observacao (string) . excluido (boolean) } (object) required |
| comercial/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| usuarios/get_v1_usuarios | Retorna a lista de todos os usuários vendedores/representantes cadastrados no Mercos. É possível filtrar por data da última alteração. | alterado_apos (string) |
| usuarios/get_v1_usuarios_by_id | Retorna os dados de um usuário específico do Mercos a partir do seu identificador. | id (integer) |
| usuarios/get_v1_usuarios_clientes | Retorna todas as regras que definem se cada usuário possui acesso a cada cliente. Recomenda-se comparar este retorno com as permissões definidas no ERP e enviar POSTs apenas para os casos de divergência. | alterado_apos (string) |
| usuarios/post_v1_usuarios_clientes | Cria uma nova regra de liberação de cliente para um usuário. Para remover um usuário de um cliente é necessário enviar uma requisição com o campo liberado: false. Não é possível fazer um bloqueio de cliente para um usuário administrador. | data: { . cliente_id (integer) . usuario_id (integer) . liberado (boolean) } (object) required |
| usuarios/get_v1_usuarios_clientes_cliente_by_id | Retorna todas as regras de liberação associadas a um determinado cliente. | id (integer) |
| usuarios/get_v1_usuarios_clientes_usuario_by_id | Retorna todas as regras de liberação associadas a um determinado usuário. | id (integer) |
| usuarios/get_v1_usuarios_clientes_usuario_by_usuario_id_cliente_by_cliente_id | Retorna a regra de liberação específica de um cliente para um determinado usuário. | usuario_id (integer) cliente_id (integer) |
| usuarios/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
| crm/get_v1_eventos | Lista todos os eventos da empresa. Pode ser filtrado por data de alteracao. | alterado_apos (string) |
| crm/post_v1_eventos | Endpoint unico para operacoes em lote sobre eventos. O corpo eh uma lista de objetos: sem id cria um novo evento; com id e demais campos atualiza; com id + excluido: true marca como excluido. Limite de 300 eventos por requisicao. Use operationIds criarEventosEmLote, atualizarEventosEmLote e excluirEventosEmLote conforme o payload. | data required |
| crm/put_v1_eventos | Alias para atualizacao em lote de eventos. Cada item deve conter id obrigatoriamente. | data (array) required |
| crm/delete_v1_eventos | Alias para exclusao em lote de eventos. Cada item deve conter id e excluido: true. | data (array) required |
| crm/get_v1_eventos_by_id | Retorna os dados de um evento pelo seu ID. | id (integer) |
| crm/get_v1_atendimentos | Lista todos os atendimentos da empresa. Pode ser filtrado por data de alteracao. | alterado_apos (string) |
| crm/get_v1_atendimentos_by_id | Retorna os dados de um atendimento pelo seu ID. | id (integer) |
| crm/post_v1_atendimentos | Endpoint unico para operacoes em lote sobre atendimentos. Sem id cria; com id e demais campos atualiza; com id + excluido: true marca como excluido. Limite de 300 atendimentos por requisicao. Use operationIds criarAtendimentosEmLote, atualizarAtendimentosEmLote e excluirAtendimentosEmLote conforme o payload. | data required |
| crm/put_v1_atendimentos | Alias para atualizacao em lote de atendimentos. Cada item deve conter id obrigatoriamente. | data (array) required |
| crm/delete_v1_atendimentos | Alias para exclusao em lote de atendimentos. Cada item deve conter id e excluido: true. | data (array) required |
| crm/get_v1_funil | Lista todos os funis de vendas cadastrados. | alterado_apos (string) |
| crm/post_v1_funil | Cria um novo funil de vendas. | data: { . nome (string) } (object) required |
| crm/get_v1_funil_by_id | Retorna os dados de um funil pelo seu ID. | id (integer) |
| crm/put_v1_funil_by_id | Altera o nome de um funil ou marca-o como excluido. | id (integer) data: { . nome (string) . excluido (boolean) } (object) required |
| crm/get_v1_funil_by_funil_id_etapas | Lista todas as etapas fases de um funil no Mercos. Cada etapa representa uma fase do processo de vendas onde as oportunidades podem estar posicionadas. | funil_id (integer) alterado_apos (string) |
| crm/get_v1_funil_by_funil_id_motivos_de_perda | Lista todos os motivos de perda de oportunidades de um funil. Esses motivos sao usados quando uma oportunidade eh marcada como PERDIDA. | funil_id (integer) alterado_apos (string) |
| crm/post_v1_funil_by_funil_id_motivos_de_perda | UPSERT em lote: itens sem id sao criados; itens com id sao atualizados. Limite de 300 registros por requisicao. | funil_id (integer) data (array) required |
| crm/get_v1_funil_by_funil_id_oportunidades | Lista todas as oportunidades de vendas de um funil. Cada oportunidade representa uma possivel venda associada a um cliente e posicionada em uma etapa do funil. | funil_id (integer) alterado_apos (string) |
| crm/post_v1_funil_by_funil_id_oportunidades | UPSERT em lote: itens sem id sao criados titulo, fase_id, cliente_id e colaborador_id sao obrigatorios; itens com id sao atualizados. Regras: 1 apenas oportunidades com status 1 ABERTA podem ser movidas entre etapas; 2 apenas ABERTA pode ser marcada como 2 GANHA ou 3 PERDIDA; 3 apenas ABERTA pode ter um pedido vinculado. Limite de 300 registros por requisicao. | funil_id (integer) data (array) required |
| crm/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
Webhook Events
This connector emits 8 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.
| Event | Description |
|---|---|
| pedido-gerado | Disparado quando um novo pedido é criado sistema online, API, e-commerce B2B ou aplicativo. |
| pedido-faturado | Disparado quando um pedido é faturado sistema online ou API. |
| pedido-cancelado | Disparado quando um pedido é cancelado sistema online ou API. |
| pagamento-atualizado | Disparado quando um link de pagamento via Mercos Pay é criado, excluído, ou tem seu status atualizado. |
| cliente-cadastrado | Disparado quando um novo cliente é criado sistema online, API, e-commerce B2B ou aplicativo. |
| cliente-atualizado | Disparado quando um cliente é atualizado sistema online, API, e-commerce B2B ou aplicativo. |
| cliente-bloqueioatualizado | Disparado quando um cliente é bloqueado ou desbloqueado sistema online, API, e-commerce B2B ou aplicativo. |
| cliente-excluido | Disparado quando um cliente é excluído sistema online, API, e-commerce B2B ou aplicativo. |